nvme: document 'config-file' commandline option

The 'config-file' commandline option is not documented in the
man pages. And we should reference the config file as a 'ghost'
file in the rpm spec to ensure it gets removed together with the
nvme-cli package.

Signed-off-by: Hannes Reinecke <hare@suse.de>

diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt
index 1fff8301d82e440f63c9bde4edf5e21bcf9e1335..e673ede567cc5e3db7b142103cfb5230361a9f04 100644 (file)
--- a/Documentation/nvme-connect-all.txt
+++ b/Documentation/nvme-connect-all.txt
@@ -17,6 +17,7 @@ SYNOPSIS
                [--hostnqn=<hostnqn>      | -q <hostnqn>]
                [--hostid=<hostid>        | -I <hostid>]
                [--raw=<filename>         | -r <filename>]
+               [--cfg-file=<cfg>         | -C <cfg>]
                [--keep-alive-tmo=<#>     | -k <#>]
                [--reconnect-delay=<#>    | -c <#>]
                [--ctrl-loss-tmo=<#>      | -l <#>]
@@ -109,6 +110,14 @@ OPTIONS
        and dump it to a raw binary file. By default 'nvme connect-all' will
        dump the output to stdout.
 
+-C <cfg>::
+--config-file=<cfg>::
+       Use the specified JSON configuration file instead of the
+       default /etc/nvme/config.json file or 'none' to not read in
+       an existing configuration file. The JSON configuration file
+       format is documented in
+       https://github.com/linux-nvme/libnvme/doc/config-schema.json
+
 -k <#>::
 --keep-alive-tmo=<#>::
        Overrides the default keep alive timeout (in seconds). This

diff --git a/Documentation/nvme-connect.txt b/Documentation/nvme-connect.txt
index ae66602196e0d30ad5ef7e96c2da1a98ff33330a..3f97f4b1d612c81fad9fd26f1d7de3b81d374e7c 100644 (file)
--- a/Documentation/nvme-connect.txt
+++ b/Documentation/nvme-connect.txt
@@ -17,6 +17,7 @@ SYNOPSIS
                [--host-iface=<iface>     | -f <iface>]
                [--hostnqn=<hostnqn>      | -q <hostnqn>]
                [--hostid=<hostid>        | -I <hostid>]
+               [--config-file=<cfg>      | -C <cfg> ]
                [--nr-io-queues=<#>       | -i <#>]
                [--nr-write-queues=<#>    | -W <#>]
                [--nr-poll-queues=<#>     | -P <#>]
@@ -93,6 +94,14 @@ OPTIONS
        UUID(Universally Unique Identifier) to be discovered which should be
        formatted.
 
+-C <cfg>::
+--config-file=<cfg>::
+       Use the specified JSON configuration file instead of the
+       default /etc/nvme/config.json file or 'none' to not read in
+       an existing configuration file. The JSON configuration file
+       format is documented in
+       https://github.com/linux-nvme/libnvme/doc/config-schema.json
+
 -i <#>::
 --nr-io-queues=<#>::
        Overrides the default number of I/O queues create by the driver.

diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt
index dfb34fa46ab5e6f285e33fcca986c03995685ec9..cb81a67449df474f4102dcc5528665ebdcdabc09 100644 (file)
--- a/Documentation/nvme-discover.txt
+++ b/Documentation/nvme-discover.txt
@@ -18,6 +18,7 @@ SYNOPSIS
                [--hostid=<hostid>        | -I <hostid>]
                [--raw=<filename>         | -r <filename>]
                [--device=<device>        | -d <device>]
+               [--cfg-file=<cfg>         | -C <cfg> ]
                [--keep-alive-tmo=<sec>   | -k <sec>]
                [--reconnect-delay=<#>    | -c <#>]
                [--ctrl-loss-tmo=<#>      | -l <#>]
@@ -133,6 +134,14 @@ OPTIONS
        This field takes a device as input. Device is in the format of nvme*,
        eg. nvme0, nvme1
 
+-C <cfg>::
+--config-file=<cfg>::
+       Use the specified JSON configuration file instead of the
+       default /etc/nvme/config.json file or 'none' to not read in
+       an existing configuration file. The JSON configuration file
+       format is documented in
+       https://github.com/linux-nvme/libnvme/doc/config-schema.json
+
 -k <#>::
 --keep-alive-tmo=<#>::
        Overrides the default dealy (in seconds) for keep alive.

diff --git a/nvme.spec.in b/nvme.spec.in
index 7154a870ae4060204cb3e6b1eccda69c3d5121fb..a8c44865fa742383496afe7259f629f54b2e5606 100644 (file)
--- a/nvme.spec.in
+++ b/nvme.spec.in
@@ -35,6 +35,7 @@ make install-spec DESTDIR=%{buildroot} PREFIX=/usr
 %{_sysconfdir}/nvme/hostnqn
 %{_sysconfdir}/nvme/hostid
 %{_sysconfdir}/nvme/discovery.conf
+%ghost %{_sysconfdir}/nvme/config.json
 %{_sysconfdir}/udev/rules.d/70-nvmf-autoconnect.rules
 %{_sysconfdir}/udev/rules.d/71-nvmf-iopolicy-netapp.rules
 %{_libdir}/dracut/dracut.conf.d/70-nvmf-autoconnect.conf