lkml.org 
[lkml]   [2016]   [Oct]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH] doc-rst: DocBook to reST migration of the uio-howto.tmpl
From
Date

Am 18.10.2016 um 17:59 schrieb Greg KH <greg@kroah.com>:

> On Tue, Oct 18, 2016 at 05:52:58PM +0200, Markus Heiser wrote:
>> The migration is done with the dbxml2rst project with small additional
>> handmade. The uio-howto is chunked along its chapters into smal parts.
>
> "small"? :)

ups

> And why small parts? Is that the new "desired" way?

We can chunk as you prefer. The DocBook uio-howto (HTML) was
chunked nearly the same (e.g. <?dbhtml filename="aboutthis.html"?>).

When we place it into "driver-api" (see below) it might be the
best not to chunk.

>>
>> [1] https://return42.github.io/dbxml2rst/
>>
>> Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
>> ---
>> Documentation/DocBook/Makefile | 2 +-
>> Documentation/DocBook/uio-howto.tmpl | 1050 ----------------------
>> Documentation/conf.py | 2 +
>> Documentation/index.rst | 1 +
>> Documentation/uio-howto/about_uio.rst | 150 ++++
>> Documentation/uio-howto/aboutthisdoc.rst | 103 +++
>> Documentation/uio-howto/conf.py | 10 +
>> Documentation/uio-howto/custom_kernel_module.rst | 245 +++++
>> Documentation/uio-howto/index.rst | 45 +
>> Documentation/uio-howto/uio_pci_generic.rst | 168 ++++
>> Documentation/uio-howto/userspace_driver.rst | 86 ++
>
> As this isn't just a howto, can we have it in Documentation/uio/
> instead?

Then we should also change the title "The Userspace I/O HOWTO" also?

> Or, if we are going to mirror the source tree, would
> Documentation/drivers/uio/ make more sense? I'll defer to the
> Documentation maintainer about this as I'm sure they have an idea of
> what they want to do.

As Jon says "driver-api":

Am 18.10.2016 um 17:58 schrieb Jonathan Corbet <corbet@lwn.net>:

> Markus, slow down just a little bit, please. Let me get docs-next going
> for 4.9 (will happen once I get LWN together for this week) and get
> Steve's patch applied. Then I'll be happy to see it reworked.
>
> When you do that, it should almost certainly be folded into the driver-api
> book.

OK, when the time comes, send me a short mail with hints what way you prefer.

-- Markus --

\
 
 \ /
  Last update: 2016-10-18 18:38    [W:0.054 / U:0.516 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site