[PATCH] nvmetcli: More refined cleanup of README

[PATCH] nvmetcli: More refined cleanup of README

[Jay Freyensee]

Adds a few more tidbits to the README file, minus
discovery/referral info (still WIP).

Signed-off-by: Jay Freyensee <james_p_freyensee at linux.intel.com>
---
 README | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README b/README
index 82d63ab..4c3daac 100644
--- a/README
+++ b/README
@@ -12,6 +12,11 @@ https://github.com/agrover/configshell-fb first.
 nvmetcli can be run directly from the source directory or installed
 using setup.py.
 
+If you choose to use the provided exe 'nvmetcli', you can move
+'nvmetcli' to /usr/sbin and the file 'nvmet.service' to
+/lib/systemd/system for global management of NVMe target setups
+for the machine.
+
 Common Package Dependencies and Problems
 -----------------------------------------
 nvmetcli uses the 'python-six' and 'pyparsing' packages
@@ -53,6 +58,13 @@ The following walks through an example using interactive mode.
 ...> create hostnqn
 
 #
+# remove access of a subsystem by deleting the Host NQN
+#
+
+...> cd /subsystems/testnqn/allowed_hosts/
+...> delete hostnqn
+
+#
 # Alternatively this allows any host to connect to the subsystsem.  Only
 # use this in tightly controller environments:
 #
@@ -65,7 +77,7 @@ The following walks through an example using interactive mode.
 # unused one will be used.
 #
 
-...> cd namespaces
+...> cd /subsystems/testnqn/namespaces
 ...> create 1
 ...> cd 1
 ...> set device path=/dev/nvme0n1
-- 
2.4.3

[PATCH] nvmetcli: More refined cleanup of README

[Sagi Grimberg]

Looks good,

Reviewed-by: Sagi Grimberg <sagi at grimberg.me>

[PATCH] nvmetcli: More refined cleanup of README

[Christoph Hellwig]

On Thu, Jul 28, 2016@10:37:06AM -0700, Jay Freyensee wrote:
> --- a/README
> +++ b/README
> @@ -12,6 +12,11 @@ https://github.com/agrover/configshell-fb first.
>  nvmetcli can be run directly from the source directory or installed
>  using setup.py.
>  
> +If you choose to use the provided exe 'nvmetcli', you can move
> +'nvmetcli' to /usr/sbin and the file 'nvmet.service' to
> +/lib/systemd/system for global management of NVMe target setups
> +for the machine.

Hmm.  Maybe we'll need to add a install rule to setup.py instead?
Either way the preferred way to install nvmetcli is to use the deb
or rpm packaging created by make deb or make rpm.  The documentation
should point to those as the first choice.

>  Common Package Dependencies and Problems
>  -----------------------------------------
>  nvmetcli uses the 'python-six' and 'pyparsing' packages
> @@ -53,6 +58,13 @@ The following walks through an example using interactive mode.
>  ...> create hostnqn
>  
>  #
> +# remove access of a subsystem by deleting the Host NQN
> +#
> +
> +...> cd /subsystems/testnqn/allowed_hosts/
> +...> delete hostnqn
> +
> +#
>  # Alternatively this allows any host to connect to the subsystsem.  Only
>  # use this in tightly controller environments:
>  #
> @@ -65,7 +77,7 @@ The following walks through an example using interactive mode.
>  # unused one will be used.
>  #
>  
> -...> cd namespaces
> +...> cd /subsystems/testnqn/namespaces
>  ...> create 1
>  ...> cd 1
>  ...> set device path=/dev/nvme0n1

But I've applied this part already and pushed it out.

[PATCH] nvmetcli: More refined cleanup of README

[J Freyensee]

On Mon, 2016-08-01@04:23 -0700, Christoph Hellwig wrote:
> On Thu, Jul 28, 2016@10:37:06AM -0700, Jay Freyensee wrote:
> > --- a/README
> > +++ b/README
> > @@ -12,6 +12,11 @@ https://github.com/agrover/configshell-fb first.
> >  nvmetcli can be run directly from the source directory or
> > installed
> >  using setup.py.
> >  
> > +If you choose to use the provided exe 'nvmetcli', you can move
> > +'nvmetcli' to /usr/sbin and the file 'nvmet.service' to
> > +/lib/systemd/system for global management of NVMe target setups
> > +for the machine.
> 
> Hmm.  Maybe we'll need to add a install rule to setup.py instead?
> Either way the preferred way to install nvmetcli is to use the deb
> or rpm packaging created by make deb or make rpm.  The documentation
> should point to those as the first choice.

That would probably work too.

I can say .deb/.rpm is preferrred, but from my previous experience,
.rpm doesn't always work, hence the background info.

> 
> >  Common Package Dependencies and Problems
> >  -----------------------------------------
> >  nvmetcli uses the 'python-six' and 'pyparsing' packages
> > @@ -53,6 +58,13 @@ The following walks through an example using
> > interactive mode.
> >  ...> create hostnqn
> >  
> >  #
> > +# remove access of a subsystem by deleting the Host NQN
> > +#
> > +
> > +...> cd /subsystems/testnqn/allowed_hosts/
> > +...> delete hostnqn
> > +
> > +#
> >  # Alternatively this allows any host to connect to the subsystsem.
> >   Only
> >  # use this in tightly controller environments:
> >  #
> > @@ -65,7 +77,7 @@ The following walks through an example using
> > interactive mode.
> >  # unused one will be used.
> >  #
> >  
> > -...> cd namespaces
> > +...> cd /subsystems/testnqn/namespaces
> >  ...> create 1
> >  ...> cd 1
> >  ...> set device path=/dev/nvme0n1
> 
> But I've applied this part already and pushed it out.

OK.  I'll add another blurb on discovery and referrals, hopefully soon.

> 
> _______________________________________________
> Linux-nvme mailing list
> Linux-nvme at lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-nvme