From 2667a3b91ce9a42bcde3d9f57b1d3c940f3e336d Mon Sep 17 00:00:00 2001 From: Hannes Reinecke Date: Mon, 15 Nov 2021 12:29:23 +0100 Subject: [PATCH] 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 --- Documentation/nvme-connect-all.txt | 9 +++++++++ Documentation/nvme-connect.txt | 9 +++++++++ Documentation/nvme-discover.txt | 9 +++++++++ nvme.spec.in | 1 + 4 files changed, 28 insertions(+) diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt index 1fff8301..e673ede5 100644 --- a/Documentation/nvme-connect-all.txt +++ b/Documentation/nvme-connect-all.txt @@ -17,6 +17,7 @@ SYNOPSIS [--hostnqn= | -q ] [--hostid= | -I ] [--raw= | -r ] + [--cfg-file= | -C ] [--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 :: +--config-file=:: + 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 ae666021..3f97f4b1 100644 --- a/Documentation/nvme-connect.txt +++ b/Documentation/nvme-connect.txt @@ -17,6 +17,7 @@ SYNOPSIS [--host-iface= | -f ] [--hostnqn= | -q ] [--hostid= | -I ] + [--config-file= | -C ] [--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 :: +--config-file=:: + 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 dfb34fa4..cb81a674 100644 --- a/Documentation/nvme-discover.txt +++ b/Documentation/nvme-discover.txt @@ -18,6 +18,7 @@ SYNOPSIS [--hostid= | -I ] [--raw= | -r ] [--device= | -d ] + [--cfg-file= | -C ] [--keep-alive-tmo= | -k ] [--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 :: +--config-file=:: + 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 7154a870..a8c44865 100644 --- 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 -- 2.50.1