[PATCH] ndctl: add options to update firmware manpage

[PATCH] ndctl: add options to update firmware manpage

[Dave Jiang]

update firmware is missing the long/short option in the manpage. Adding
the missing sections.

Signed-off-by: Dave Jiang <dave.jiang@intel.com>
---
 Documentation/ndctl/ndctl-update-firmware.txt |   17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/Documentation/ndctl/ndctl-update-firmware.txt b/Documentation/ndctl/ndctl-update-firmware.txt
index d742302..dd90612 100644
--- a/Documentation/ndctl/ndctl-update-firmware.txt
+++ b/Documentation/ndctl/ndctl-update-firmware.txt
@@ -10,6 +10,23 @@ SYNOPSIS
 [verse]
 'ndctl update-firmware' -f <firmware_file> -d <dimm name>
 
+EXAMPLES
+--------
+
+Updating DIMM nmem0 with firmware file name firmwarefile.bin.
+[verse]
+ndctl update-firmware -f firmwarefile.bin -d nmem0
+
+OPTIONS
+-------
+-f::
+--firmware=::
+	The path and name of the firmware file to be updated.
+
+-d::
+--dimm=::
+	The DIMM name to be updated.
+
 COPYRIGHT
 ---------
 Copyright (c) 2016 - 2017, Intel Corporation. License GPLv2: GNU GPL

_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm

Re: [PATCH] ndctl: add options to update firmware manpage

[Verma, Vishal L]

On Fri, 2018-02-02 at 16:47 -0700, Dave Jiang wrote:
> update firmware is missing the long/short option in the manpage.
> Adding
> the missing sections.
> 
> Signed-off-by: Dave Jiang <dave.jiang@intel.com>
> ---
>  Documentation/ndctl/ndctl-update-firmware.txt |   17
> +++++++++++++++++
>  1 file changed, 17 insertions(+)

Looks good, I have folded it in to the original patch.

> 
> diff --git a/Documentation/ndctl/ndctl-update-firmware.txt
> b/Documentation/ndctl/ndctl-update-firmware.txt
> index d742302..dd90612 100644
> --- a/Documentation/ndctl/ndctl-update-firmware.txt
> +++ b/Documentation/ndctl/ndctl-update-firmware.txt
> @@ -10,6 +10,23 @@ SYNOPSIS
>  [verse]
>  'ndctl update-firmware' -f <firmware_file> -d <dimm name>
>  
> +EXAMPLES
> +--------
> +
> +Updating DIMM nmem0 with firmware file name firmwarefile.bin.
> +[verse]
> +ndctl update-firmware -f firmwarefile.bin -d nmem0
> +
> +OPTIONS
> +-------
> +-f::
> +--firmware=::
> +	The path and name of the firmware file to be updated.
> +
> +-d::
> +--dimm=::
> +	The DIMM name to be updated.
> +
>  COPYRIGHT
>  ---------
>  Copyright (c) 2016 - 2017, Intel Corporation. License GPLv2: GNU GPL
> 
_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm