[PATCH 0/1] Documentation: convert sh interfaces to RST

[PATCH 0/1] Documentation: convert sh interfaces to RST

[Steve Kowalik]

Hi,

The following patch converts the SuperH interfaces DocBook into RST,
however, I've not added it to the toctree, since I'm not 100% clear
where it best fits.

Steve Kowalik (1):
  Documentation: convert sh interfaces to RST

 Documentation/DocBook/Makefile  |   2 +-
 Documentation/DocBook/sh.tmpl   | 105 ----------------------------------------
 Documentation/sh/interfaces.rst |  59 ++++++++++++++++++++++
 3 files changed, 60 insertions(+), 106 deletions(-)
 delete mode 100644 Documentation/DocBook/sh.tmpl
 create mode 100644 Documentation/sh/interfaces.rst

-- 
2.7.4

Re: [PATCH 0/1] Documentation: convert sh interfaces to RST

[Jonathan Corbet]

On Fri, 20 Jan 2017 09:06:41 +1100
Steve Kowalik <steven@wedontsleep.org> wrote:

> The following patch converts the SuperH interfaces DocBook into RST,
> however, I've not added it to the toctree, since I'm not 100% clear
> where it best fits.

So I have to apologize, this fell through the cracks in the disaster that
is my inbox.

The conversion itself looks mostly OK.  There is, however, a copyright
assertion in the original template file that should really be preserved
in the new file as well; usually I put those in as comments at the top of
the RST file.

As for where it fits; it seems maybe we need a subbook for
architecture-specific stuff.  Documentation/arch or /arch-guide?

Thanks,

jon

Re: [PATCH 0/1] Documentation: convert sh interfaces to RST

[Rob Landley]

On 02/12/2017 05:35 PM, Jonathan Corbet wrote:
> On Fri, 20 Jan 2017 09:06:41 +1100
> Steve Kowalik <steven@wedontsleep.org> wrote:
> 
>> The following patch converts the SuperH interfaces DocBook into RST,
>> however, I've not added it to the toctree, since I'm not 100% clear
>> where it best fits.
> 
> So I have to apologize, this fell through the cracks in the disaster that
> is my inbox.
> 
> The conversion itself looks mostly OK.  There is, however, a copyright
> assertion in the original template file that should really be preserved
> in the new file as well; usually I put those in as comments at the top of
> the RST file.
> 
> As for where it fits; it seems maybe we need a subbook for
> architecture-specific stuff.  Documentation/arch or /arch-guide?

Documentation/arch mirrors the kernel source layout, and I actually
submitted patches to collate the various arch directories under that
many moons ago. You may remember:

  https://lwn.net/Articles/244448/

> Thanks,
> 
> jon

Rob