Re: Kernel docs: muddying the waters a bit
From: Mauro Carvalho Chehab
Date: Tue Mar 08 2016 - 06:30:07 EST
Em Tue, 08 Mar 2016 11:49:35 +0200
Jani Nikula <jani.nikula@xxxxxxxxx> escreveu:
> On Tue, 08 Mar 2016, Dan Allen <dan@xxxxxxxxxxxxx> wrote:
> > One of the key goals of the Asciidoctor project is to be able to directly
> > produce a wide variety of outputs from the same source (without DocBook).
> > We've added flexibility and best practices into the syntax and matured the
> > converter mechanism to bridge this (sometimes very wide) gap.
> I think our conclusion so far was that the native AsciiDoc (and
> Asciidoctor) outputs fell short of our needs, forcing us to use the
> DocBook pipeline. I, for one, was hoping we could eventually simplify
> the toolchain. For example, there was no support for chunked, or split
> to chapters, HTML, and the single page result was simply way too big.
> > Asciidoctor is the future of AsciiDoc. Even the AsciiDoc Python maintainers
> > acknowledge that (including the original creator).
> Thanks for the input. We've touched the topic of AsciiDoc
> vs. Asciidoctor before . So we should be using Asciidoctor instead of
> AsciiDoc. That actually makes choosing asciidoc harder, because
> requiring another language environment complicates, not simplifies, the
> toolchain. I'd really like to lower the bar for building the
> documentation, for everyone, so much so that it becomes part of the
> normal checks for patch inclusion.
As I failed to find a way to solve the issues with Sphinx/RST, I started
a PoC using Asciidoctor for the Media uAPI docbook conversion, in order
to see if this would work for us.
I'm not a big fan of using a language that I don't domain, like
Ruby (and the same applies to Python), but, as I said before,
provided that the toolchain works, can easily be installed on
Fedora and Debian, and provide the functionality I need, I'm
ok with that.
On my tests, Asciidoctor is really fast. It takes a fraction of the
time require to build from DocBook, with is a good thing.
Yet, I suspect that it doesn't have the strict checks that xmllint
have. For example, I didn't see any warning about a missing cross-ref.
We use those warnings to discover if something is added at the code,
but were not documented. Its error reports are also crappy, as it
doesn't tell where the problem is. For example:
$ asciidoctor -n -b docbook media_api.adoc
asciidoctor: WARNING: tables must have at least one body row
On a document with 33793 lines (this is the size of the uAPI doc
when converted to AsciiDoc format), the above warning doesn't help.
So, I'm actually planning to use AsciiDoc/xmllint to check for
documentation troubles, if possible.
Even with AsciiDoc/Asciidoctor, there are several features at the
media documents that aren't well supported. For example, we widely
use the Docbook's tags to generate a manpage-like description:
<refpurpose>Open a V4L2 device</refpurpose>
<paramdef>const char *<parameter>device_name</parameter></paramdef>
Asciidoctor doesn't produce anything like that, if the booktype is not
"manpage". Well, the media documentation is a multi-part book.
So, all those tags should be manually converted (actually, pandoc
made a mess with those tags - so manual work is required anyway,
no matter what markdown language we use). It will be a hard work,
but, at least, this is doable.
Also, it doesn't accept images with PDF format. We have a few PDF
images, although I we have them also in GIF. So, not a big issue here.
I also did lots of table conversions, to see if our complex tables
would fit. The answer is: Yes: on all cases I converted, it worked
There are two ways of doing that:
- Nested tables
- Merging cells
Some tables we use won't work fine with nested tables, as they have
cells merging the entire line of such tables.
Also, converting some tables to nested tables would be incredible hard,
as we have really big tables there that would need to add dozens of nested
tables inside, like this one:
Using merging cells works fine, tough, and it is not hard to use.
The tables are easy to edit. The Asciidoctor syntax (not sure if AsciiDoc
also accepts this) is:
.MFC 5.1 Control IDs
|ID |Type 2+| Description
The "2+|" tells that the next content should be merged into two cells.
One of the good things is that we're not forced to use asciiart, with
would make it really hard to handle the tables.
For those wanting to see the results so far:
The html is at:
The testing tree is at:
PS.: pandoc did a really crap job on the conversion. To convert this
into something useful, we'll need to spend a lot of time, as it lost
most of the cross-references, as they were defined via DocBook macros.
It also dropped without even warning all nested tables. So, even for
a PoC, we'll need to spend some time to make it barely resembling
what we currently have on DocBook.