Skip to content

Commit f8281fe

Browse files
authored
fix: Capitalization of "Wasm" (#3756)
* fix: Fix capitalization of "Wasm" This replace incorrect capitalization of "WASM" with "Wasm", which is the official abbreviation of WebAssembly. See: https://webassembly.org/ The reason why not all letters are capitalized is because "Wasm" is not an acronym, but rather an abbreviation. This change also fixes capitalization of the canister status output to be consistent wih other fields.
1 parent cb67f24 commit f8281fe

File tree

23 files changed

+79
-75
lines changed

23 files changed

+79
-75
lines changed

CHANGELOG.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88

99
### chore: Improve help text of `dfx identity new` to include which characters are valid in identity names
1010

11+
### fix: Capitalization of "Wasm" in docs and messages
12+
13+
The output of `dfx canister status` has been also changed to use consistent capitalization of words.
14+
1115
## Dependencies
1216

1317
### Updated to [agent-rs 0.35.0](https://github.com/dfinity/agent-rs/blob/main/CHANGELOG.md#0350---2024-05-10)
@@ -51,7 +55,7 @@ Stderr:
5155
5256
### fix: "Failed to decrypt PEM file" errors messages will now include the cause
5357
54-
### feat: WASM memory soft-limit
58+
### feat: Wasm memory soft-limit
5559
5660
Adds support for the `wasm_memory_limit` canister setting, which limits the canister's heap during most calls but does not affect queries. As with other canister settings, it can be set in `dfx canister create` or `dfx canister update-settings` via the `--wasm-memory-limit` flag, as well as in `dfx.json` under `canisters[].initialization_values.wasm_memory_limit`.
5761
@@ -555,7 +559,7 @@ Fix the HTTP header for deploying in remote environments
555559
556560
### feat: large canister modules now supported
557561
558-
When using `dfx deploy` or `dfx canister install`, previously WASM modules larger than 2MiB would be rejected.
562+
When using `dfx deploy` or `dfx canister install`, previously Wasm modules larger than 2MiB would be rejected.
559563
They are now automatically submitted via the chunking API if they are large enough.
560564
From a user perspective the limitation will simply have been lifted.
561565
@@ -1413,7 +1417,7 @@ The identity may be specified using the environment variable `DFX_IDENTITY`.
14131417
14141418
### feat: Add DFX_ASSETS_WASM
14151419
1416-
Added the ability to configure the WASM module used for assets canisters through the environment variable `DFX_ASSETS_WASM`.
1420+
Added the ability to configure the Wasm module used for assets canisters through the environment variable `DFX_ASSETS_WASM`.
14171421
14181422
### fix: dfx deploy and icx-asset no longer retry on permission failure
14191423
@@ -1529,7 +1533,7 @@ Added validate_grant_permission() and validate_revoke_permission() methods per S
15291533
15301534
### feat: Add dfx sns download
15311535
1532-
This allows users to download SNS canister WASMs.
1536+
This allows users to download SNS canister Wasm binaries.
15331537
15341538
### fix: fixed error text
15351539
- `dfx nns install` had the wrong instructions for setting up the local replica type
@@ -2126,7 +2130,7 @@ It is now possible to inhibit automatic wallet creation by setting the `DFX_DISA
21262130
21272131
### feat: canister installation now waits for the replica
21282132
2129-
When installing a new WASM module to a canister, DFX will now wait for the updated state (i.e. the new module hash) to be visible in the replica's certified state tree before proceeding with post-installation tasks or producing a success status.
2133+
When installing a new Wasm module to a canister, DFX will now wait for the updated state (i.e. the new module hash) to be visible in the replica's certified state tree before proceeding with post-installation tasks or producing a success status.
21302134
21312135
### feat!: remove `dfx config`
21322136
@@ -2410,7 +2414,7 @@ can instead use `dfx canister metadata`.
24102414
24112415
### refactor: optimize from ic-wasm
24122416
2413-
Optimize Rust canister WASM module via ic-wasm library instead of ic-cdk-optimizer. A separate installation of ic-cdk-optimizer is no longer needed.
2417+
Optimize Rust canister Wasm module via ic-wasm library instead of ic-cdk-optimizer. A separate installation of ic-cdk-optimizer is no longer needed.
24142418
24152419
The actual optimization was kept the same.
24162420
@@ -3707,7 +3711,7 @@ dfx deploy or dfx install will delete them.
37073711
37083712
### feat: get certified canister info from read state #1514
37093713
3710-
Added `dfx canister info` command to get certified canister information. Currently this information is limited to the controller of the canister and the SHA256 hash of its WASM module. If there is no WASM module installed, the hash will be None.
3714+
Added `dfx canister info` command to get certified canister information. Currently this information is limited to the controller of the canister and the SHA256 hash of its Wasm module. If there is no Wasm module installed, the hash will be None.
37113715
37123716
## Asset Canister
37133717
@@ -3850,18 +3854,18 @@ Please submit your Principal ("dfx identity get-principal") in the intake form t
38503854
- feat: add deploy wallet subcommand to identity (#1414)
38513855
38523856
This feature adds the deploy-wallet subcommand to the dfx identity.
3853-
The User provides the ID of the canister onto which the wallet WASM is deployed.
3857+
The User provides the ID of the canister onto which the wallet Wasm is deployed.
38543858
38553859
``` bash
38563860
dfx identity deploy-wallet --help
38573861
dfx-identity-deploy-wallet
3858-
Installs the wallet WASM to the provided canister id
3862+
Installs the wallet Wasm to the provided canister id
38593863
38603864
USAGE:
38613865
dfx identity deploy-wallet <canister-id>
38623866
38633867
ARGS:
3864-
<canister-id> The ID of the canister where the wallet WASM will be deployed
3868+
<canister-id> The ID of the canister where the wallet Wasm will be deployed
38653869
38663870
FLAGS:
38673871
-h, --help Prints help information

docs/cli-reference/dfx-canister.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ For reference information and examples that illustrate using `dfx canister` comm
3232
| [`deposit-cycles`](#dfx-canister-deposit-cycles) | Deposit cycles into the specified canister. |
3333
| `help` | Displays usage information message for a specified subcommand. |
3434
| [`id`](#dfx-canister-id) | Displays the identifier of a canister. |
35-
| [`info`](#dfx-canister-info) | Get the hash of a canister’s WASM module and its current controller. |
35+
| [`info`](#dfx-canister-info) | Get the hash of a canister’s Wasm module and its current controller. |
3636
| [`install`](#dfx-canister-install) | Installs compiled code in a canister. |
3737
| [`logs`](#dfx-canister-logs) | Returns the logs from a canister. |
3838
| [`metadata`](#dfx-canister-metadata) | Displays metadata in a canister. |
@@ -459,7 +459,7 @@ The command displays output similar to the following:
459459

460460
## dfx canister info
461461

462-
Use the `dfx canister info` command to output a canister's controller and installed WASM module hash.
462+
Use the `dfx canister info` command to output a canister's controller and installed Wasm module hash.
463463

464464
### Basic usage
465465

@@ -477,7 +477,7 @@ You can use the following argument with the `dfx canister info` command.
477477

478478
### Examples
479479

480-
You can use the `dfx canister info` command to display the canister controller and installed WASM module.
480+
You can use the `dfx canister info` command to display the canister controller and installed Wasm module.
481481

482482
To the data about the `hello_world` canister, you can run the following command:
483483

@@ -517,7 +517,7 @@ You can use the following options with the `dfx canister install` command.
517517
| `--no-wallet` | Performs the call with the user Identity as the Sender of messages. Bypasses the Wallet canister. Enabled by default. |
518518
| `--no-asset-upgrade` | Skips upgrading the asset canister, to only install the assets themselves. |
519519
| `--upgrade-unchanged` | Upgrade the canister even if the .wasm did not change. |
520-
| `--wasm <file.wasm>` | Specifies a particular WASM file to install, bypassing the dfx.json project settings. |
520+
| `--wasm <file.wasm>` | Specifies a particular Wasm file to install, bypassing the dfx.json project settings. |
521521

522522
#### Specifies the argument to pass to the init entrypoint
523523

@@ -609,7 +609,7 @@ The command displays output similar to the following:
609609

610610
## dfx canister metadata
611611

612-
Use the `dfx canister metadata` command to display metadata stored in a canister's WASM module.
612+
Use the `dfx canister metadata` command to display metadata stored in a canister's Wasm module.
613613

614614
### Basic usage
615615

docs/cli-reference/dfx-identity.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For reference information and examples that illustrate using `dfx identity` comm
2222

2323
| Command | Description |
2424
|-------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
25-
| [`deploy-wallet`](#dfx-identity-deploy-wallet) | Installs the wallet WASM to the provided canister id. |
25+
| [`deploy-wallet`](#dfx-identity-deploy-wallet) | Installs the wallet Wasm to the provided canister id. |
2626
| [`get-principal`](#dfx-identity-get-principal) | Shows the textual representation of the principal associated with the current identity. |
2727
| [`get-wallet`](#dfx-identity-get-wallet) | Shows the canister identifier for the wallet associated with your current identity principal. |
2828
| `help` | Displays this usage message or the help of the given subcommand(s). |
@@ -48,7 +48,7 @@ This command adds a private key for the `ic_admin` user identity in the `~/.conf
4848

4949
## dfx identity deploy-wallet
5050

51-
Use the `dfx identity deploy-wallet` command to turn a canister into a wallet canister by installing the wallet WASM to it.
51+
Use the `dfx identity deploy-wallet` command to turn a canister into a wallet canister by installing the wallet Wasm to it.
5252

5353
Note that you must be connected to the IC or the local canister execution environment to run this command. In addition, you must be a controller of the canister you want to deploy the wallet to.
5454

@@ -64,7 +64,7 @@ You must specify the following argument for the `dfx identity deploy-wallet` com
6464

6565
| Argument | Description |
6666
|-----------------|----------------------------------------------------------------|
67-
| `<canister id>` | The ID of the canister where the wallet WASM will be deployed. |
67+
| `<canister id>` | The ID of the canister where the wallet Wasm will be deployed. |
6868

6969
## dfx identity get-principal
7070

docs/dfx-json-schema.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@
209209
},
210210
"package": {
211211
"title": "Package Name",
212-
"description": "Name of the rust package that compiles to this canister's WASM.",
212+
"description": "Name of the rust package that compiles to this canister's Wasm binary.",
213213
"type": "string"
214214
},
215215
"type": {
@@ -273,7 +273,7 @@
273273
"properties": {
274274
"build": {
275275
"title": "Build Commands",
276-
"description": "Commands that are executed in order to produce this canister's WASM module. Expected to produce the WASM in the path specified by the 'wasm' field. No build commands are allowed if the `wasm` field is a URL.",
276+
"description": "Commands that are executed in order to produce this canister's Wasm module. Expected to produce the Wasm in the path specified by the 'wasm' field. No build commands are allowed if the `wasm` field is a URL.",
277277
"default": [],
278278
"allOf": [
279279
{
@@ -293,8 +293,8 @@
293293
]
294294
},
295295
"wasm": {
296-
"title": "WASM Path",
297-
"description": "Path to WASM to be installed. URLs to a WASM module are also acceptable. A canister that has a URL to a WASM module can not also have `build` steps.",
296+
"title": "Wasm Path",
297+
"description": "Path to Wasm to be installed. URLs to a Wasm module are also acceptable. A canister that has a URL to a Wasm module can not also have `build` steps.",
298298
"type": "string"
299299
}
300300
}
@@ -381,7 +381,7 @@
381381
}
382382
},
383383
"gzip": {
384-
"title": "Gzip Canister WASM",
384+
"title": "Gzip Canister Wasm",
385385
"description": "Disabled by default.",
386386
"type": [
387387
"boolean",
@@ -438,7 +438,7 @@
438438
}
439439
},
440440
"optimize": {
441-
"title": "Optimize Canister WASM",
441+
"title": "Optimize Canister Wasm",
442442
"description": "Invoke wasm level optimizations after building the canister. Optimization level can be set to \"cycles\" to optimize for cycle usage, \"size\" to optimize for binary size, or any of \"O4, O3, O2, O1, O0, Oz, Os\". Disabled by default. If this option is specified, the `shrink` option will be ignored.",
443443
"default": null,
444444
"anyOf": [
@@ -487,7 +487,7 @@
487487
]
488488
},
489489
"shrink": {
490-
"title": "Shrink Canister WASM",
490+
"title": "Shrink Canister Wasm",
491491
"description": "Whether run `ic-wasm shrink` after building the Canister. Enabled by default for Rust/Motoko canisters. Disabled by default for custom canisters.",
492492
"type": [
493493
"boolean",
@@ -961,8 +961,8 @@
961961
"minimum": 0.0
962962
},
963963
"wasm_memory_limit": {
964-
"title": "WASM Memory Limit",
965-
"description": "Specifies a soft limit (in bytes) on the Wasm memory usage of the canister.\n\nUpdate calls, timers, heartbeats, installs, and post-upgrades fail if the WASM memory usage exceeds this limit. The main purpose of this setting is to protect against the case when the canister reaches the hard 4GiB limit.\n\nMust be a number of bytes between 0 and 2^48 (i.e. 256 TiB), inclusive. Can be specified as an integer, or as an SI unit string (e.g. \"4KB\", \"2 MiB\")",
964+
"title": "Wasm Memory Limit",
965+
"description": "Specifies a soft limit (in bytes) on the Wasm memory usage of the canister.\n\nUpdate calls, timers, heartbeats, installs, and post-upgrades fail if the Wasm memory usage exceeds this limit. The main purpose of this setting is to protect against the case when the canister reaches the hard 4GiB limit.\n\nMust be a number of bytes between 0 and 2^48 (i.e. 256 TiB), inclusive. Can be specified as an integer, or as an SI unit string (e.g. \"4KB\", \"2 MiB\")",
966966
"default": null,
967967
"anyOf": [
968968
{
@@ -1207,4 +1207,4 @@
12071207
]
12081208
}
12091209
}
1210-
}
1210+
}
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
= How to build the main.wasm
22

3-
The code for this WASM is in `/e2e/assets/identity/identity.mo`.
3+
The code for this Wasm is in `/e2e/assets/identity/identity.mo`.
44

55
Follow the instructions there; create a new dfx project, overwrite the project's
66
main.mo with the file above, and then rebuild it.
7-
Take the resulting WASM and DID and put them here.
7+
Take the resulting Wasm and DID and put them here.
88

99
- [ ] TODO(#682)

e2e/tests-dfx/build.bash

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,11 +152,11 @@ teardown() {
152152
dfx_start
153153
dfx canister create --all
154154
assert_command dfx build custom -vvv
155-
assert_not_match "Shrinking WASM"
155+
assert_not_match "Shrinking Wasm"
156156

157157
jq '.canisters.custom.shrink=true' dfx.json | sponge dfx.json
158158
assert_command dfx build custom -vvv
159-
assert_match "Shrinking WASM"
159+
assert_match "Shrinking Wasm"
160160
}
161161

162162
@test "build custom canister default no optimize" {
@@ -170,7 +170,7 @@ teardown() {
170170

171171
jq '.canisters.custom.optimize="size"' dfx.json | sponge dfx.json
172172
assert_command dfx build custom -vvv
173-
assert_match "Optimizing WASM at level"
173+
assert_match "Optimizing Wasm at level"
174174
}
175175

176176
@test "build succeeds if enable gzip" {

e2e/tests-dfx/create.bash

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ teardown() {
2323

2424
assert_command dfx canister create e2e_project_frontend --no-wallet
2525
assert_command dfx canister status e2e_project_frontend
26-
assert_contains "Reserved Cycles Limit: 5_000_000_000_000 Cycles"
26+
assert_contains "Reserved cycles limit: 5_000_000_000_000 Cycles"
2727

2828
assert_command dfx canister create e2e_project_backend --reserved-cycles-limit 470000 --no-wallet
2929
assert_command dfx canister status e2e_project_backend
30-
assert_contains "Reserved Cycles Limit: 470_000 Cycles"
30+
assert_contains "Reserved cycles limit: 470_000 Cycles"
3131
}
3232

3333
@test "create succeeds on default project" {
@@ -329,7 +329,7 @@ teardown() {
329329
assert_command dfx canister status e2e_project_backend
330330
assert_contains 'Memory allocation: 2_147_483_648'
331331
assert_contains 'Compute allocation: 5'
332-
assert_contains 'Reserved Cycles Limit: 1_000_000_000_000'
333-
assert_contains 'WASM Memory Limit: 1_073_741_824'
332+
assert_contains 'Reserved cycles limit: 1_000_000_000_000'
333+
assert_contains 'Wasm memory limit: 1_073_741_824'
334334
assert_contains 'Freezing threshold: 604_800'
335335
}

e2e/tests-dfx/deploy.bash

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ teardown() {
2525
assert_command dfx deploy --no-wallet
2626

2727
assert_command dfx canister status hello_backend
28-
assert_contains "Reserved Cycles Limit: 860_000 Cycles"
28+
assert_contains "Reserved cycles limit: 860_000 Cycles"
2929
}
3030

3131
@test "deploy --upgrade-unchanged upgrades even if the .wasm did not change" {

e2e/tests-dfx/rust.bash

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ teardown() {
1919
dfx_start
2020
dfx canister create --all
2121
assert_command dfx build hello_backend -vvv
22-
assert_match "Shrinking WASM"
22+
assert_match "Shrinking Wasm"
2323
assert_command dfx canister install hello_backend
2424
assert_command dfx canister call hello_backend greet dfinity
2525
assert_match '("Hello, dfinity!")'

0 commit comments

Comments
 (0)