From: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
To: Dan Allen <dan@opendevise.io>
Cc: Jani Nikula <jani.nikula@intel.com>,
Russel Winder <russel@winder.org.uk>,
Keith Packard <keithp@keithp.com>,
Jonathan Corbet <corbet@lwn.net>,
LKML <linux-kernel@vger.kernel.org>,
linux-doc@vger.kernel.org, Daniel Vetter <daniel.vetter@ffwll.ch>,
Hans Verkuil <hverkuil@xs4all.nl>,
linux-media@vger.kernel.org,
Graham Whaley <graham.whaley@linux.intel.com>
Subject: Re: Kernel docs: muddying the waters a bit
Date: Tue, 8 Mar 2016 12:39:21 -0300 [thread overview]
Message-ID: <20160308123921.6f2248ab@recife.lan> (raw)
In-Reply-To: <20160308103922.48d87d9d@recife.lan>
Em Tue, 8 Mar 2016 10:39:22 -0300
Mauro Carvalho Chehab <mchehab@osg.samsung.com> escreveu:
> Em Tue, 08 Mar 2016 05:13:13 -0700
> Dan Allen <dan@opendevise.io> escreveu:
>
> > On Tue, Mar 8, 2016 at 4:29 AM, Mauro Carvalho Chehab <
> > mchehab@osg.samsung.com> wrote:
> >
> > > 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.
> > >
> >
> > I agree pandoc creates crappy AsciiDoc. We have a much better converter in
> > the works called DocBookRx.
> >
> > https://github.com/opendevise/docbookrx
> >
> > It has converted several very serious DocBook documents and we're
> > continuing to improve it. It's also a lot easier to hack than pandoc.
>
> Didn't work:
>
> $ ./bin/docbookrx ~/devel/docbook_test/v4l2.xml
> No visitor defined for <part>! Skipping.
> No visitor defined for <part>! Skipping.
> No visitor defined for <part>! Skipping.
> No visitor defined for <part>! Skipping.
> No visitor defined for <appendixinfo>! Skipping.
I tried to use docbookrx for the bits that were not properly converted,
like the manpage-like pages:
$ ../docbookrx/bin/docbookrx Documentation/DocBook/media/v4l/func-ioctl.xml
No visitor defined for <refentry>! Skipping.
Dan, if you want to take a look on what's going wrong here,
the XML I'm trying to convert is:
https://git.linuxtv.org/media_tree.git/tree/Documentation/DocBook/media/v4l/func-ioctl.xml
If this would work, it should be generating something like:
https://git.linuxtv.org/mchehab/asciidoc-poc.git/tree/func-ioctl.adoc
Pandoc failed to fully convert it, but at least it left all the texts,
with prevented rewriting it from scratch. This is the manual fix
I applied to it:
https://git.linuxtv.org/mchehab/asciidoc-poc.git/commit/func-ioctl.adoc?id=801d336c3742f26731e08c284290c32c0b4632fc
FYI, we have 133 xml files at the media uAPI doc with refmeta.
--
Thanks,
Mauro
next prev parent reply other threads:[~2016-03-08 15:39 UTC|newest]
Thread overview: 95+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-02-13 21:53 Kernel docs: muddying the waters a bit Jonathan Corbet
2016-02-14 0:57 ` Keith Packard
2016-02-14 12:27 ` Daniel Vetter
2016-02-14 16:27 ` Keith Packard
2016-02-17 22:14 ` Jonathan Corbet
2016-02-17 22:29 ` Daniel Vetter
2016-02-18 9:11 ` Jani Nikula
2016-02-18 9:24 ` Daniel Vetter
2016-02-18 10:26 ` Mauro Carvalho Chehab
2016-02-18 11:23 ` Jani Nikula
2016-02-18 12:04 ` Mauro Carvalho Chehab
2016-02-18 12:07 ` Hans Verkuil
2016-02-18 12:44 ` Mauro Carvalho Chehab
2016-02-18 13:34 ` Patrick Boettcher
2016-02-18 13:01 ` Jonathan Corbet
2016-02-18 14:39 ` Daniel Vetter
2016-02-16 8:25 ` Jani Nikula
2016-02-16 16:08 ` Jonathan Corbet
2016-02-16 17:11 ` Jani Nikula
2016-02-16 19:13 ` Keith Packard
2016-02-16 19:59 ` Jonathan Corbet
2016-02-17 0:01 ` Keith Packard
2016-03-03 14:03 ` Jani Nikula
2016-03-03 14:13 ` Jonathan Corbet
2016-03-03 14:34 ` One Thousand Gnomes
2016-03-03 15:17 ` Jonathan Corbet
2016-03-03 15:45 ` Daniel Vetter
2016-03-03 18:50 ` Mauro Carvalho Chehab
2016-03-03 23:23 ` Keith Packard
2016-03-04 1:19 ` Mauro Carvalho Chehab
2016-03-04 8:29 ` Jani Nikula
2016-03-04 8:59 ` Johannes Stezenbach
2016-03-04 12:59 ` Mauro Carvalho Chehab
2016-03-04 14:09 ` Johannes Stezenbach
2016-03-06 2:29 ` Mauro Carvalho Chehab
2016-03-06 23:29 ` Johannes Stezenbach
2016-03-07 8:48 ` Johannes Stezenbach
2016-03-07 12:15 ` Mauro Carvalho Chehab
2016-03-07 12:19 ` Mauro Carvalho Chehab
2016-03-04 7:28 ` Russel Winder
2016-03-04 7:46 ` Jani Nikula
2016-03-08 4:53 ` Russel Winder
[not found] ` <CAKeHnO6sSV1x2xh_HgbD5ddZ8rp+SVvbdjVhczhudc9iv_-UCQ@mail.gmail.com>
2016-03-08 9:49 ` Jani Nikula
2016-03-08 11:29 ` Mauro Carvalho Chehab
[not found] ` <CAKeHnO7R25knFH07+3trdi0ZotsrEE+5ZzDZXdx33+DUW=q2Ug@mail.gmail.com>
2016-03-08 13:39 ` Mauro Carvalho Chehab
2016-03-08 15:39 ` Mauro Carvalho Chehab [this message]
2016-03-09 21:27 ` Mauro Carvalho Chehab
2016-03-10 10:25 ` Jani Nikula
2016-03-10 15:21 ` Mauro Carvalho Chehab
2016-03-13 15:33 ` Markus Heiser
2016-04-08 15:12 ` Markus Heiser
2016-04-12 9:18 ` Hans Verkuil
2016-04-12 15:46 ` Jonathan Corbet
2016-04-18 9:49 ` Markus Heiser
2016-04-27 14:28 ` Grant Likely
2016-05-03 14:31 ` Daniel Vetter
2016-05-03 15:54 ` Keith Packard
2016-05-04 9:34 ` Markus Heiser
2016-05-04 9:58 ` Jani Nikula
2016-05-04 12:40 ` Markus Heiser
2016-05-04 13:41 ` Jani Nikula
2016-05-04 15:09 ` Jonathan Corbet
2016-05-04 13:43 ` Daniel Vetter
2016-05-04 14:18 ` Daniel Vetter
2016-05-04 14:57 ` Jonathan Corbet
2016-05-04 15:02 ` Daniel Vetter
2016-05-04 16:32 ` Daniel Vetter
2016-05-04 15:44 ` Jani Nikula
2016-05-04 16:38 ` Mauro Carvalho Chehab
2016-05-04 15:55 ` Markus Heiser
2016-05-04 16:13 ` Jani Nikula
2016-05-04 16:50 ` Mauro Carvalho Chehab
2016-05-04 16:59 ` Jonathan Corbet
2016-05-04 17:57 ` Mauro Carvalho Chehab
2016-05-05 13:02 ` Jonathan Corbet
2016-05-05 13:23 ` Mauro Carvalho Chehab
2016-05-06 11:23 ` Markus Heiser
2016-05-06 11:44 ` Markus Heiser
[not found] ` <20160506083529.31ad2fa0@recife.lan>
[not found] ` <BAE3C147-6C21-4242-BD3C-8989C1626E10@darmarit.de>
[not found] ` <20160506104210.12197832@recife.lan>
2016-05-06 14:27 ` Markus Heiser
2016-05-06 14:27 ` Markus Heiser
2016-05-06 15:06 ` Jani Nikula
2016-05-06 15:23 ` Mauro Carvalho Chehab
2016-05-06 15:35 ` Markus Heiser
2016-05-06 15:52 ` Jani Nikula
2016-05-06 15:14 ` Mauro Carvalho Chehab
2016-05-04 16:15 ` Mauro Carvalho Chehab
2016-05-06 10:05 ` Markus Heiser
[not found] ` <20160506080304.56307066@recife.lan>
2016-05-06 16:26 ` Markus Heiser
2016-05-06 17:06 ` Mauro Carvalho Chehab
[not found] ` <20160412105850.50e02108@recife.lan>
2016-04-18 8:10 ` Markus Heiser
2016-04-18 11:16 ` Mauro Carvalho Chehab
[not found] ` <CAKeHnO7_7k8Qc5Jmu_x2OzAVT4YXxW8PSe_m6QUP-8V7XxbTVw@mail.gmail.com>
2016-03-08 13:30 ` Mauro Carvalho Chehab
2016-03-08 13:58 ` Jani Nikula
[not found] ` <CAKeHnO7e5Escm0Ndm50eFX-qUXf7Lg9n=iXvwUGjz2M4KHLMsQ@mail.gmail.com>
2016-03-09 8:57 ` Jani Nikula
2016-03-07 3:48 ` Jonathan Corbet
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=20160308123921.6f2248ab@recife.lan \
--to=mchehab@osg.samsung.com \
--cc=corbet@lwn.net \
--cc=dan@opendevise.io \
--cc=daniel.vetter@ffwll.ch \
--cc=graham.whaley@linux.intel.com \
--cc=hverkuil@xs4all.nl \
--cc=jani.nikula@intel.com \
--cc=keithp@keithp.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=russel@winder.org.uk \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.