Re: [PATCH 12/14] doc-rst: add ABI documentation to the admin-guide book

From: Markus Heiser
Date: Fri Jun 14 2019 - 10:15:22 EST



Am 14.06.19 um 15:42 schrieb Jani Nikula:
On Thu, 13 Jun 2019, Mauro Carvalho Chehab<mchehab+samsung@xxxxxxxxxx> wrote:
From: Mauro Carvalho Chehab<mchehab@xxxxxxxxxxxxxxxx>

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 --