Skip to content

Commit 4b024bd

Browse files
authored
normalise options style (#7663)
`:` also works, but `=` is more common
1 parent c4e8de0 commit 4b024bd

File tree

7 files changed

+18
-17
lines changed

7 files changed

+18
-17
lines changed

docs/the_nimbus_book/src/developers.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,5 +247,6 @@ build/block_sim --slots=384 --validators=20000 --attesterRatio=0.66
247247
## Sync from a specific peer
248248

249249
```sh
250-
build/nimbus_beacon_node --no-el --discv5:off --tcp-port=9876 --direct-peer="/ip4/127.0.0.1/tcp/9000/p2p/$(curl -s -X 'GET' 'http://localhost:5052/eth/v1/node/identity' -H 'accept: application/json' | jq -r .data.peer_id)"
250+
build/nimbus_beacon_node --no-el --discv5=off --tcp-port=9876 \
251+
--direct-peer="/ip4/127.0.0.1/tcp/9000/p2p/$(curl -s -X 'GET' 'http://localhost:5052/eth/v1/node/identity' -H 'accept: application/json' | jq -r .data.peer_id)"
251252
```

docs/the_nimbus_book/src/era-store.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ mkdir -p era
5656
cd era
5757

5858
# Launch the era export
59-
../../../ncli_db exportEra --db:../db
59+
../../../ncli_db exportEra --db=../db
6060
```
6161

6262
The first time the export is run, full history is exported which may take some time.
@@ -77,7 +77,7 @@ Era files can be shared directly from the `era` folder using a web server, or si
7777
You can pass a custom era store location to Nimbus using `--era-dir`:
7878

7979
```sh
80-
nimbus_beacon_node --era-dir:/path/to/era
80+
nimbus_beacon_node --era-dir=/path/to/era
8181
```
8282

8383
!!! tip

docs/the_nimbus_book/src/log-rotate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ The final step is to redirect logs to `rotatelogs` using a pipe when starting Ni
7070

7171
```bash
7272
build/nimbus_beacon_node \
73-
--network:hoodi \
73+
--network=hoodi \
7474
--web3-url="$WEB3URL" \
75-
--data-dir:$DATADIR 2>&1 | rotatelogs -L "$DATADIR/nbc_bn.log" -p "/path/to/rotatelogs-compress.sh" -D -f -c "$DATADIR/log/nbc_bn_%Y%m%d%H%M%S.log" 3600
75+
--data-dir=$DATADIR 2>&1 | rotatelogs -L "$DATADIR/nbc_bn.log" -p "/path/to/rotatelogs-compress.sh" -D -f -c "$DATADIR/log/nbc_bn_%Y%m%d%H%M%S.log" 3600
7676
```
7777

7878
The options used in this example do the following:

docs/the_nimbus_book/src/networking.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ If there are no `dir=in` ChronosStreams, incoming connections are not working.
6060

6161
## Set an explicit external IP
6262

63-
If you have a static public IP address, use the `--nat:extip:$EXT_IP_ADDRESS` option to pass it to the client, where `$EXT_IP_ADDRESS` is your public IP.
63+
If you have a static public IP address, use the `--nat=extip:$EXT_IP_ADDRESS` option to pass it to the client, where `$EXT_IP_ADDRESS` is your public IP.
6464
See [here](./networking.md#determine-your-public-ip-address) for how to determine your public IP address.
6565

6666
!!! note
@@ -71,7 +71,7 @@ See [here](./networking.md#determine-your-public-ip-address) for how to determin
7171
The `--enr-auto-update` feature keeps your external IP address up to date based on information received from other peers on the network.
7272
This option is useful with ISPs that assign IP addresses dynamically.
7373

74-
In practice this means relaunching the beacon node with `--enr-auto-update:true` (pass it as an option in the command line).
74+
In practice this means relaunching the beacon node with `--enr-auto-update` (pass it as an option in the command line).
7575

7676
## Set up port forwarding
7777

@@ -147,7 +147,7 @@ Use the [open ports tool](https://www.yougetsignal.com/tools/open-ports/) to che
147147
- `Discovered new external address but ENR auto update is off...`
148148

149149
It's possible that your ISP has changed your IP address without you knowing.
150-
The first thing to do it to try relaunching the beacon node with with `--enr-auto-update:true` (pass it as an option in the command line).
150+
The first thing to do it to try relaunching the beacon node with with `--enr-auto-update` (pass it as an option in the command line).
151151

152152
If this doesn't fix the problem, the next thing to do is to check your external (public) IP address and detect open ports on your connection - you can use [this site](https://www.yougetsignal.com/tools/open-ports/ ).
153153
Note that Nimbus `TCP` and `UDP` ports are both set to `9000` by default.

docs/the_nimbus_book/src/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ Peer count low, no new peers discovered...
3030

3131
Your node is finding it hard to find peers.
3232
It's possible that you may be behind a firewall.
33-
Try restarting your client and passing `--nat:extip:$EXT_IP_ADDRESS` as an option to `./run-mainnet-beacon-node.sh`, where `$EXT_IP_ADDRESS` is your real IP. For example, if your real IP address is `1.2.3.4`, you'd run:
33+
Try restarting your client and passing `--nat=extip:$EXT_IP_ADDRESS` as an option to `./run-mainnet-beacon-node.sh`, where `$EXT_IP_ADDRESS` is your real IP. For example, if your real IP address is `1.2.3.4`, you'd run:
3434

3535
```
36-
./run-mainnet-beacon-node.sh --nat:extip:1.2.3.4
36+
./run-mainnet-beacon-node.sh --nat=extip:1.2.3.4
3737
```
3838

3939
If this doesn't improve things, you may need to [set enr-auto-update](./networking.md#set-enr-auto-update) and/or [set up port forwarding](./networking.md#set-up-port-forwarding).

docs/the_nimbus_book/src/trusted-node-sync.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ To start trusted node sync, run:
3030
=== "Mainnet"
3131
```sh
3232
build/nimbus_beacon_node trustedNodeSync \
33-
--network:mainnet \
33+
--network=mainnet \
3434
--data-dir=build/data/shared_mainnet_0 \
3535
--trusted-node-url=http://localhost:5052
3636
```
3737

3838
=== "Hoodi"
3939
```sh
4040
build/nimbus_beacon_node trustedNodeSync \
41-
--network:hoodi \
41+
--network=hoodi \
4242
--data-dir=build/data/shared_hoodi_0 \
4343
--trusted-node-url=http://localhost:5052
4444
```
@@ -122,9 +122,9 @@ While you can choose a different sync point using a state hash or a slot number,
122122

123123
```sh
124124
build/nimbus_beacon_node trustedNodeSync \
125-
--network:mainnet \
125+
--network=mainnet \
126126
--data-dir=build/data/shared_mainnet_0 \
127-
--state-id:1024
127+
--state-id=1024
128128
```
129129

130130
### Sync from checkpoint files
@@ -151,7 +151,7 @@ To recreate a historical index from before the checkpoint, it is necessary to fi
151151

152152
```sh
153153
build/nimbus_beacon_node trustedNodeSync \
154-
--network:mainnet \
154+
--network=mainnet \
155155
--data-dir=build/data/shared_mainnet_0 \
156156
--reindex=true
157157
```

docs/the_nimbus_book/src/validator-client.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Next, choose a data directory for the validator client and import the keys there
2121

2222
```sh
2323
build/nimbus_beacon_node deposits import \
24-
--data-dir:build/data/vc_shared_hoodi_0 "<YOUR VALIDATOR KEYS DIRECTORY>"
24+
--data-dir=build/data/vc_shared_hoodi_0 "<YOUR VALIDATOR KEYS DIRECTORY>"
2525
```
2626

2727
!!! warning
@@ -35,7 +35,7 @@ With the keys imported, you are ready to start validator client:
3535

3636
```sh
3737
build/nimbus_validator_client \
38-
--data-dir:build/data/vc_shared_hoodi_0
38+
--data-dir=build/data/vc_shared_hoodi_0
3939
```
4040

4141
# Options

0 commit comments

Comments
 (0)