From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Jani Nikula <jani.nikula@linux.intel.com>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
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 12:27:55 -0300 [thread overview]
Message-ID: <20190614122755.1c7b4898@coco.lan> (raw)
In-Reply-To: <20190614140603.GB7234@kroah.com>
Em Fri, 14 Jun 2019 16:06:03 +0200
Greg Kroah-Hartman <gregkh@linuxfoundation.org> escreveu:
> On Fri, Jun 14, 2019 at 04:42:20PM +0300, Jani Nikula wrote:
> > 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
>
> What would that exactly look like? What would it require for new
> developers for when they write new entries? Why not rely on a helper
> script, that allows us to validate things better?
Funny enough, this e-mail arrived here after Greg's reply, and my
reply over his one :-)
-
With regards to the script, my idea is to have it run on a new
"validate" mode, when the Kernel is built with COMPILE_TEST:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=abi_patches_v4
NB: the last patch is not yet... somehow, the building system is not
passing CONFIG_WARN_ABI_ERRORS to Documentation/Makefile. I'm
debugging it.
Personally, I would prefer to keep it the way it is, with two
additions:
1) I would add a SPDX header at the fist line of each file there;
2) It would make sense to have a new field - or indicator - to let
add ReST markups at the description.
The advantage of using a parseable ABI file is that it is possible
to parse it, for example, to search for a symbol:
$ ./scripts/get_abi.pl voltage_max
/sys/class/power_supply/<supply_name>/voltage_max
-------------------------------------------------
Date: January 2008
Contact: linux-pm@vger.kernel.org
Defined on file: Documentation/ABI/testing/sysfs-class-power
Description:
Reports the maximum VBUS voltage the supply can support.
Access: Read
Valid values: Represented in microvolts
...
>
> > 2) Have the python extension read the ABI files directly, without an
> > extra pipeline.
>
> He who writes the script, get's to dictate the language of the script :)
No idea about how much time it would take if written in python,
but this perl script is really fast:
$ time ./scripts/get_abi.pl search voltage_max >/dev/null
real 0m0,139s
user 0m0,132s
sys 0m0,006s
That's the time it takes here (SSD disks) to read all files under
Documentation/ABI, parse them and seek for a string.
That's about half of the time a python script takes to just import the
the sphinx modules and print its version, running at the same machine:
$ time sphinx-build --version >/dev/null
real 0m0,224s
user 0m0,199s
sys 0m0,024s
> Personally, this looks sane to me, I'm going to apply the ABI fixups to
> my tree at least, and then see how the script works out. The script can
> always be replaced with a different one in a different language at a
> later point in time of people think it really mattes.
Thanks,
Mauro
next prev parent reply other threads:[~2019-06-14 15:28 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 [this message]
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
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=20190614122755.1c7b4898@coco.lan \
--to=mchehab+samsung@kernel.org \
--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@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;
as well as URLs for NNTP newsgroup(s).