Skip to content

Commit

Permalink
Add details in --dev cli flag documentation (#2305)
Browse files Browse the repository at this point in the history
add details in `--dev` flag to tell that it disables local peer
discovery

### Context

When adding automated end-to-end tests, we replaced `--dev` by 

```
`--chain=dev`, `--force-authoring`, `--rpc-cors=all`, `--alice`, and `--tmp` flags
```

as stated in the command line documentation. But the tests started
failing due to the nodes connecting to each other.

### Fix

This PR includes additional command line documentation to explain more
in detail what `--dev` flag inludes.
  • Loading branch information
Hugo-Trentesaux authored Nov 14, 2023
1 parent 54ca4f1 commit a393cfc
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions substrate/client/cli/src/params/shared_params.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ pub struct SharedParams {
///
/// This flag sets `--chain=dev`, `--force-authoring`, `--rpc-cors=all`,
/// `--alice`, and `--tmp` flags, unless explicitly overridden.
/// It also disables local peer discovery (see --no-mdns and --discover-local)
#[arg(long, conflicts_with_all = &["chain"])]
pub dev: bool,

Expand Down

0 comments on commit a393cfc

Please sign in to comment.