Skip to content

Commit 426298f

Browse files
sesi200sesi200
authored
chore: improve subnet selection docs (#4124)
1 parent 0860154 commit 426298f

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

‎docs/cli-reference/dfx-canister.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ You can use the following options with the `dfx canister create` command.
287287
| `--no-wallet` | Performs the call with the user Identity as the Sender of messages. Bypasses the Wallet canister. Enabled by default. |
288288
| `--with-cycles <number-of-cycles>` | Specifies the initial cycle balance to deposit into the newly created canister. The specified amount needs to take the canister create fee into account. This amount is deducted from the wallet's cycle balance. |
289289
| `--specified-id <PRINCIPAL>` | Attempts to create the canister with this Canister ID |
290-
| `--subnet-type <subnet-type>` | Specify the subnet type to create the canister on. If no subnet type is provided, the canister will be created on a random default application subnet. |
290+
| `--subnet-type <subnet-type>` | Specify the subnet type to create the canister on. If no subnet type is provided, the canister will be created on a random default application subnet. `dfx ledger show-subnet-types` can be used to list available subnet types. |
291291
| `--subnet <subnet-principal>` | Specify the subnet to create the canister on. If no subnet is provided, the canister will be created on a random default application subnet. |
292292
| `--next-to <canister-principal>` | Create canisters on the same subnet as this canister. |
293293

‎docs/cli-reference/dfx-deploy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ You can use the following options with the `dfx deploy` command.
4141
| `--specified-id <PRINCIPAL>` | Attempts to create the canister with this Canister ID |
4242
| `--by-proposal` | Upload proposed changed assets, but do not commit them. Follow up by calling either commit_proposed_batch() or delete_batch(). |
4343
| `--compute-evidence` | Build a frontend canister, determine batch operations required to synchronize asset canister contents, and compute a hash over those operations. Displays this hash ("evidence"), which should match the evidence displayed by `dfx deploy --by-proposal`. |
44-
| `--subnet-type <subnet-type>` | Specify the subnet type to create the canister on. If no subnet type is provided, the canister will be created on a random default application subnet. |
44+
| `--subnet-type <subnet-type>` | Specify the subnet type to create the canister on. If no subnet type is provided, the canister will be created on a random default application subnet. `dfx ledger show-subnet-types` can be used to list available subnet types. |
4545
| `--subnet <subnet-principal>` | Specify the subnet to create the canister on. If no subnet is provided, the canister will be created on a random default application subnet. |
4646
| `--next-to <canister-principal>` | Create canisters on the same subnet as this canister. |
4747
| `--skip-pre-upgrade` | Skip the pre_upgrade hook on upgrade. This requires the upgrade/auto mode. |

‎docs/cli-reference/dfx-ledger.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ You can specify the following argument for the `dfx ledger create-canister` comm
131131
| `--fee <fee>` | Specify a transaction fee. The default is 10000 e8s. |
132132
| `--icp <icp>` | Specify ICP tokens as a whole number. You can use this option on its own or in conjunction with `--e8s`. |
133133
| `--max-fee <max-fee>` | Specify a maximum transaction fee. The default is 10000 e8s. |
134-
| `--subnet-type <subnet-type>` | Specify the optional subnet type to create the canister on. If no subnet type is provided, the canister will be created on a random default application subnet. |
134+
| `--subnet-type <subnet-type>` | Specify the optional subnet type to create the canister on. If no subnet type is provided, the canister will be created on a random default application subnet. `dfx ledger show-subnet-types` can be used to list available subnet types. |
135135
| `--subnet <subnet-principal>` | Specify the optional subnet to create the canister on. If no subnet is provided, the canister will be created on a random default application subnet. |
136136
| `--next-to <canister-principal>` | Create canisters on the same subnet as this canister. |
137137
| `--created-at-time <timestamp>`| Specify the timestamp-nanoseconds for the `created_at_time` field on the ledger transfer request. Useful for controlling transaction-de-duplication. https://internetcomputer.org/docs/current/developer-docs/integrations/icrc-1/#transaction-deduplication- |

‎src/dfx/src/util/clap/subnet_selection_opt.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ group(ArgGroup::new("subnet-selection").multiple(false)),
1818
pub struct SubnetSelectionOpt {
1919
/// Specify the optional subnet type to create canisters on. If no
2020
/// subnet type is provided, the canister will be created on a random
21-
/// default application subnet.
21+
/// default application subnet. `dfx ledger show-subnet-types` can be
22+
/// used to list available subnet types.
2223
#[arg(long, group = "subnet-selection")]
2324
subnet_type: Option<String>,
2425

0 commit comments

Comments
 (0)