From: Jonathan Corbet <corbet@lwn.net>
To: Logan Gunthorpe <logang@deltatee.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Keith Busch <keith.busch@intel.com>,
Myron Stowe <myron.stowe@gmail.com>,
Bjorn Helgaas <bhelgaas@google.com>,
Geert Uytterhoeven <geert+renesas@glider.be>,
"David S. Miller" <davem@davemloft.net>,
Andrew Morton <akpm@linux-foundation.org>,
Emil Velikov <emil.l.velikov@gmail.com>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
Guenter Roeck <linux@roeck-us.net>,
Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>,
Linus Walleij <linus.walleij@linaro.org>,
Ryusuke Konishi <konishi.ryusuke@lab.ntt.co.jp>,
Stefan Berger <stefanb@linux.vnet.ibm.com>,
Wei Zhang <wzhang@fb.com>,
Kurt Schwemmer <kurt.schwemmer@microsemi.com>,
Stephen Bates <stephen.bates@microsemi.com>,
linux-pci@vger.kernel.org, linux-doc@vger.kernel.org,
linux-nvme@lists.infradead.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/1] MicroSemi Switchtec management interface driver
Date: Tue, 31 Jan 2017 10:49:16 -0700 [thread overview]
Message-ID: <20170131104916.0f187309@lwn.net> (raw)
In-Reply-To: <57658098-b24a-cb25-b2e3-ccf8fcbf8fe5@deltatee.com>
On Tue, 31 Jan 2017 10:35:44 -0700
Logan Gunthorpe <logang@deltatee.com> wrote:
> > And don't dump a .txt file into Documentation/ anymore, people are
> > working to move to the newer format.
>
> Fair. I wasn't sure where a good place to put it was. Any suggestions?
We're working toward a rational document hierarchy using the sphinx system:
https://lwn.net/Articles/692704/
https://lwn.net/Articles/692704/
https://static.lwn.net/kerneldoc/doc-guide/index.html
The good news is that your switchtec.txt file is already 99% in the RST
format, so there is little or nothing to do there.
The bad news is that we don't quite have a place for it yet. This is
really user-space developer documentation, and we don't have a sub-book
for that. I expect that to change pretty soon, and I might even toss
together a bare beginning for 4.11, but that hasn't happened yet.
If you would like to learn the ropes and make one, that would be more than
great :) Alternatively, I'd suggest just leaving the document as-is, and
I'll put it toward the top of the list of things to move into place once I
get that book started.
Thanks,
jon
next prev parent reply other threads:[~2017-01-31 17:49 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-31 17:03 [PATCH 0/1] DRAFT: New Microsemi PCI Switch Management Driver Logan Gunthorpe
2017-01-31 17:03 ` [PATCH 1/1] MicroSemi Switchtec management interface driver Logan Gunthorpe
2017-01-31 17:26 ` Greg Kroah-Hartman
2017-01-31 17:35 ` Logan Gunthorpe
2017-01-31 17:49 ` Jonathan Corbet [this message]
2017-01-31 18:32 ` Logan Gunthorpe
2017-01-31 18:57 ` Greg Kroah-Hartman
2017-01-31 19:04 ` Logan Gunthorpe
2017-01-31 17:27 ` Greg Kroah-Hartman
2017-01-31 18:21 ` kbuild test robot
2017-01-31 20:48 ` Emil Velikov
2017-01-31 23:13 ` Logan Gunthorpe
2017-02-01 12:10 ` Emil Velikov
2017-02-02 16:37 ` Logan Gunthorpe
2017-02-03 13:49 ` Emil Velikov
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=20170131104916.0f187309@lwn.net \
--to=corbet@lwn.net \
--cc=akpm@linux-foundation.org \
--cc=bhelgaas@google.com \
--cc=davem@davemloft.net \
--cc=emil.l.velikov@gmail.com \
--cc=geert+renesas@glider.be \
--cc=gregkh@linuxfoundation.org \
--cc=jarkko.sakkinen@linux.intel.com \
--cc=keith.busch@intel.com \
--cc=konishi.ryusuke@lab.ntt.co.jp \
--cc=kurt.schwemmer@microsemi.com \
--cc=linus.walleij@linaro.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-nvme@lists.infradead.org \
--cc=linux-pci@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=logang@deltatee.com \
--cc=mchehab@kernel.org \
--cc=myron.stowe@gmail.com \
--cc=stefanb@linux.vnet.ibm.com \
--cc=stephen.bates@microsemi.com \
--cc=wzhang@fb.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).