Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1570939

Re: [PATCH 1/1] MicroSemi Switchtec management interface driver

From Jonathan Corbet <corbet@lwn.net>
Newsgroups linux.kernel
Subject Re: [PATCH 1/1] MicroSemi Switchtec management interface driver
Date 2017-01-31 18:50 +0100
Message-ID <t5KJ4-3yR-31@gated-at.bofh.it> (permalink)
References <t5K6m-3lE-13@gated-at.bofh.it> <t5K6m-3lE-11@gated-at.bofh.it> <t5KpI-3sq-9@gated-at.bofh.it> <t5Kzn-3vy-5@gated-at.bofh.it>
Organization LWN.net

Show all headers | View raw

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

Back to linux.kernel | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

Re: [PATCH 1/1] MicroSemi Switchtec management interface driver Greg Kroah-Hartman <gregkh@linuxfoundation.org> - 2017-01-31 18:30 +0100
  Re: [PATCH 1/1] MicroSemi Switchtec management interface driver Logan Gunthorpe <logang@deltatee.com> - 2017-01-31 18:40 +0100
    Re: [PATCH 1/1] MicroSemi Switchtec management interface driver Jonathan Corbet <corbet@lwn.net> - 2017-01-31 18:50 +0100
      Re: [PATCH 1/1] MicroSemi Switchtec management interface driver Logan Gunthorpe <logang@deltatee.com> - 2017-01-31 20:00 +0100
    Re: [PATCH 1/1] MicroSemi Switchtec management interface driver Greg Kroah-Hartman <gregkh@linuxfoundation.org> - 2017-01-31 20:00 +0100
      Re: [PATCH 1/1] MicroSemi Switchtec management interface driver Logan Gunthorpe <logang@deltatee.com> - 2017-01-31 20:30 +0100

csiph-web