From: Markus Heiser <markus.heiser@darmarit.de>
To: Jani Nikula <jani.nikula@linux.intel.com>,
Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH 12/14] doc-rst: add ABI documentation to the admin-guide book
Date: Fri, 14 Jun 2019 16:10:31 +0200 [thread overview]
Message-ID: <2955920a-3d6a-8e41-e8fe-b7db3cefed8b@darmarit.de> (raw)
In-Reply-To: <87o930uvur.fsf@intel.com>
Am 14.06.19 um 15:42 schrieb Jani Nikula:
> On Thu, 13 Jun 2019, Mauro Carvalho Chehab<mchehab+samsung@kernel.org> wrote:
>> From: Mauro Carvalho Chehab<mchehab@s-opensource.com>
>>
>> As we don't want a generic Sphinx extension to execute commands,
>> change the one proposed to Markus to call the abi_book.pl
>> script.
>>
>> Use a script to parse the Documentation/ABI directory and output
>> it at the admin-guide.
> We had a legacy kernel-doc perl script so we used that instead of
> rewriting it in python. Just to keep it bug-for-bug compatible with the
> past. That was the only reason.
>
> I see absolutely zero reason to add a new perl monstrosity with a python
> extension to call it. All of this could be better done in python,
> directly.
>
> Please don't complicate the documentation build. I know you know we all
> worked hard to take apart the old DocBook Rube Goldberg machine to
> replace it with Sphinx. Please don't turn the Sphinx build to another
> complicated mess.
>
> My strong preferences are, in this order:
>
> 1) Convert the ABI documentation to reStructuredText
>
> 2) Have the python extension read the ABI files directly, without an
> extra pipeline.
>
I agree with Jani. No matter how the decision ends, since I can't help here, I'd
rather not show up in the copyright.
-- Markus --
next prev parent reply other threads:[~2019-06-14 14:10 UTC|newest]
Thread overview: 63+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-06-14 2:04 [PATCH 00/14] Add support to generate ABI documentation at admin-guide Mauro Carvalho Chehab
2019-06-14 2:04 ` [PATCH 01/14] ABI: fix some syntax issues at the ABI database Mauro Carvalho Chehab
2019-06-14 7:20 ` Andrew Donnellan
2019-06-14 16:16 ` Greg Kroah-Hartman
2019-06-14 8:30 ` Rafael J. Wysocki
2019-06-14 2:04 ` [PATCH 02/14] ABI: sysfs-driver-hid: the "What" field doesn't parse fine Mauro Carvalho Chehab
2019-06-14 2:04 ` [PATCH 03/14] ABI: sysfs-class-uwb_rc: remove a duplicated incomplete entry Mauro Carvalho Chehab
2019-06-14 2:04 ` [PATCH 04/14] ABI: better identificate tables Mauro Carvalho Chehab
2019-06-19 12:51 ` Johan Hovold
2019-06-19 13:56 ` Mauro Carvalho Chehab
2019-06-19 15:02 ` Greg Kroah-Hartman
2019-06-19 16:14 ` Mauro Carvalho Chehab
2019-06-20 14:27 ` Mauro Carvalho Chehab
2019-06-21 7:21 ` Greg Kroah-Hartman
2019-06-21 9:49 ` Mauro Carvalho Chehab
2019-06-20 12:01 ` Johan Hovold
2019-06-20 12:54 ` Greg Kroah-Hartman
2019-06-20 14:20 ` Mauro Carvalho Chehab
2019-06-20 16:29 ` Greg Kroah-Hartman
2019-06-20 17:16 ` Mauro Carvalho Chehab
2019-06-20 17:55 ` Greg Kroah-Hartman
2019-06-14 2:04 ` [PATCH 05/14] scripts: add an script to parse the ABI files Mauro Carvalho Chehab
2019-06-14 13:31 ` Jani Nikula
2019-06-14 13:39 ` Greg Kroah-Hartman
2019-06-14 13:58 ` Mauro Carvalho Chehab
2019-06-14 14:00 ` Jani Nikula
2019-06-14 14:14 ` Jonathan Corbet
2019-06-14 16:24 ` Greg Kroah-Hartman
2019-06-14 2:04 ` [PATCH 06/14] scripts/get_abi.pl: parse files with text at beginning Mauro Carvalho Chehab
2019-06-14 2:04 ` [PATCH 07/14] scripts/get_abi.pl: avoid use literal blocks when not needed Mauro Carvalho Chehab
2019-06-14 2:04 ` [PATCH 08/14] scripts/get_abi.pl: split label naming from xref logic Mauro Carvalho Chehab
2019-06-14 2:04 ` [PATCH 09/14] scripts/get_abi.pl: add support for searching for ABI symbols Mauro Carvalho Chehab
2019-06-14 2:04 ` [PATCH 10/14] scripts/get_abi.pl: represent what in tables Mauro Carvalho Chehab
2019-06-14 2:04 ` [PATCH 11/14] scripts/get_abi.pl: fix parse issues with some files Mauro Carvalho Chehab
2019-06-14 2:04 ` [PATCH 12/14] doc-rst: add ABI documentation to the admin-guide book Mauro Carvalho Chehab
2019-06-14 13:42 ` Jani Nikula
2019-06-14 14:06 ` Greg Kroah-Hartman
2019-06-14 15:27 ` Mauro Carvalho Chehab
2019-06-17 12:36 ` Jani Nikula
2019-06-17 12:54 ` Greg Kroah-Hartman
2019-06-17 13:48 ` Jonathan Corbet
2019-06-17 13:50 ` Jani Nikula
2019-06-17 13:51 ` Mauro Carvalho Chehab
2019-06-18 8:47 ` Jani Nikula
2019-06-19 16:37 ` Mauro Carvalho Chehab
2019-06-21 14:27 ` Mauro Carvalho Chehab
2019-06-27 9:48 ` Jani Nikula
2019-06-27 10:52 ` Mauro Carvalho Chehab
2019-06-14 14:10 ` Markus Heiser [this message]
2019-06-14 14:15 ` Jonathan Corbet
2019-06-16 16:04 ` Markus Heiser
2019-06-17 9:11 ` Mauro Carvalho Chehab
2019-06-17 16:31 ` Markus Heiser
2019-06-14 2:04 ` [PATCH 13/14] sphinx/kernel_abi.py: make it compatible with Sphinx 1.7+ Mauro Carvalho Chehab
2019-06-14 2:04 ` [PATCH 14/14] docs: sphinx/kernel_abi.py: fix UTF-8 support Mauro Carvalho Chehab
2019-06-14 16:18 ` Greg Kroah-Hartman
2019-06-14 16:25 ` Mauro Carvalho Chehab
2019-06-15 6:16 ` Greg Kroah-Hartman
2019-06-16 15:43 ` Markus Heiser
2019-06-17 9:16 ` Mauro Carvalho Chehab
2019-06-17 13:56 ` Jonathan Corbet
2019-06-17 15:55 ` Mauro Carvalho Chehab
2019-06-14 16:20 ` [PATCH 00/14] Add support to generate ABI documentation at admin-guide Greg Kroah-Hartman
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=2955920a-3d6a-8e41-e8fe-b7db3cefed8b@darmarit.de \
--to=markus.heiser@darmarit.de \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
--cc=mchehab@infradead.org \
--cc=mchehab@s-opensource.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®