All of lore.kernel.org
 help / color / mirror / Atom feed
From: james_p_freyensee@linux.intel.com (J Freyensee)
Subject: [PATCH 3/3] nvmetcli: remove README file
Date: Mon, 28 Nov 2016 07:55:52 -0800	[thread overview]
Message-ID: <1480348552.2827.12.camel@linux.intel.com> (raw)
In-Reply-To: <20161125074604.GB753@lst.de>

On Fri, 2016-11-25@08:46 +0100, Christoph Hellwig wrote:
> On Wed, Nov 23, 2016@10:01:13AM -0800, Jay Freyensee wrote:
> > 
> > Contents of README have been moved and updated into the
> > manpage/html solution.
> 
> 
> I still think that a basic README is useful, including pointing
> people
> to the manpage, and for build instruction in case we add any.

OK, I can re-send the patch series and not touch the README.

> 
> 
> > 
> > --- a/README
> > +++ /dev/null
> > @@ -1,173 +0,0 @@
> > -nvmetcli
> > -========
> > -This contains the NVMe target admin tool "nvmetcli".??It can
> > either be
> > -used interactively by invoking it without arguments, or it can be
> > used
> > -to save, restore or clear the current NVMe target configuration.
> > -
> > -Installation
> > -------------
> > -Please install the configshell-fb package from
> > -https://github.com/agrover/configshell-fb first.
> > -
> > -nvmetcli can be run directly from the source directory or
> > installed
> > -using setup.py.
> > -
> > -Common Package Dependencies and Problems
> > ------------------------------------------
> > -nvmetcli uses the 'python-six' and 'pyparsing' packages
> > -(running nvmetcli without these packages may produce
> > -hard-to-decipher errors).
> 
> 
> E.g. keep everything up to here, then add a reference to
> nvmetcli.txt after that.
> 
> And keep the rest quotes below this text as well,
> 
> > 
> > -Example NVMe Target .json files
> > ---------------------------------------
> > -To load the loop + explicit host version above do the following:
> > -
> > -??./nvmetcli restore loop.json
> > -
> > -Or to load the rdma + no host authentication version do the
> > following
> > -after you've ensured that the IP address in rdma.json fits your
> > setup:
> > -
> > -??./nvmetcli restore rdma.json
> > -
> > -These files can also be edited directly using your favorite
> > editor.
> > -
> > -Testing
> > --------
> > -nvmetcli comes with a testsuite that tests itself and the kernel
> > configfs
> > -interface for the NVMe target.??To run it make sure you have nose2
> > and
> > -the coverage plugin for it installed and simple run 'make test'.
> > -
> > -Development
> > ------------------
> > -Please send to linux-nvme at lists.infradead.org for review and
> > acceptance.
> > --?
> > 2.7.4
> ---end quoted text---
> 
> _______________________________________________
> Linux-nvme mailing list
> Linux-nvme at lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-nvme

      reply	other threads:[~2016-11-28 15:55 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-11-23 18:01 [PATCH 0/3] nvmetcli manpage and misc tweaks Jay Freyensee
2016-11-23 18:01 ` [PATCH 1/3] nvmetcli: Adding manpage/html generation Jay Freyensee
2016-11-25  7:43   ` Christoph Hellwig
2016-11-28 15:54     ` J Freyensee
2017-01-05 21:43     ` Andy Grover
2017-01-05 23:28       ` J Freyensee
2017-01-06  7:42       ` Christoph Hellwig
2016-11-23 18:01 ` [PATCH 2/3] nvmetcli: add python-six to rpm package building Jay Freyensee
2016-11-23 18:01 ` [PATCH 3/3] nvmetcli: remove README file Jay Freyensee
2016-11-25  7:46   ` Christoph Hellwig
2016-11-28 15:55     ` J Freyensee [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1480348552.2827.12.camel@linux.intel.com \
    --to=james_p_freyensee@linux.intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.