Skip to content

Commit

Permalink
doc: Fix short option name for cfg-file
Browse files Browse the repository at this point in the history
It was renamed to "-J" but some docs were left out.

Fixes: 0571307 ("nvme-connect: Add 'dhchap-secret' and 'dhchap-ctrl-secret' arguments")
Signed-off-by: Felix Yan <[email protected]>
[dwagner: updated some more outdated references
Signed-off-by: Daniel Wagner <[email protected]>
  • Loading branch information
felixonmars authored and igaw committed Feb 2, 2024
1 parent c2fc029 commit 89f02ee
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions Documentation/nvme-connect-all.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ SYNOPSIS
[--hostid=<hostid> | -I <hostid>]
[--raw=<filename> | -r <filename>]
[--device=<device> | -d <device>]
[--cfg-file=<cfg> | -C <cfg>]
[--config=<filename> | -J <cfg>]
[--keep-alive-tmo=<sec> | -k <sec>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
Expand Down Expand Up @@ -121,8 +121,8 @@ OPTIONS
command "connect-all" or "discover". <device> follows the format
nvme*, eg. nvme0, nvme1.

-C <cfg>::
--config-file=<cfg>::
-J <filename>::
--config=<filename>::
Use the specified JSON configuration file instead of the
default @SYSCONFDIR@/nvme/config.json file or 'none' to not read in
an existing configuration file. The JSON configuration file
Expand Down
6 changes: 3 additions & 3 deletions Documentation/nvme-connect.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ SYNOPSIS
[--host-iface=<iface> | -f <iface>]
[--hostnqn=<hostnqn> | -q <hostnqn>]
[--hostid=<hostid> | -I <hostid>]
[--config-file=<cfg> | -J <cfg>]
[--config=<filename> | -J <filename>]
[--dhchap-secret=<secret> | -S <secret>]
[--dhchap-ctrl-secret=<secret> | -C <secret>]
[--nr-io-queues=<#> | -i <#>]
Expand Down Expand Up @@ -95,8 +95,8 @@ OPTIONS
UUID(Universally Unique Identifier) to be discovered which should be
formatted.

-J <cfg>::
--config-file=<cfg>::
-J <filename>::
--config=<filename>::
Use the specified JSON configuration file instead of the
default @SYSCONFDIR@/nvme/config.json file or 'none' to not read in
an existing configuration file. The JSON configuration file
Expand Down
6 changes: 3 additions & 3 deletions Documentation/nvme-discover.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ SYNOPSIS
[--hostid=<hostid> | -I <hostid>]
[--raw=<filename> | -r <filename>]
[--device=<device> | -d <device>]
[--cfg-file=<cfg> | -C <cfg>]
[--config=<filename> | -J <filename>]
[--keep-alive-tmo=<sec> | -k <sec>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
Expand Down Expand Up @@ -140,8 +140,8 @@ OPTIONS
command "connect-all" or "discover". <device> follows the format
nvme*, eg. nvme0, nvme1.

-C <cfg>::
--config-file=<cfg>::
-J <filename>::
--config=<filename>::
Use the specified JSON configuration file instead of the
default @SYSCONFDIR@/nvme/config.json file or 'none' to not read in
an existing configuration file. The JSON configuration file
Expand Down

0 comments on commit 89f02ee

Please sign in to comment.