From: Jonathan Corbet <corbet@lwn.net>
To: Kees Cook <keescook@chromium.org>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
Jani Nikula <jani.nikula@linux.intel.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 0/2] docs: Programmatically render MAINTAINERS into ReST
Date: Wed, 2 Oct 2019 10:25:35 -0600 [thread overview]
Message-ID: <20191002102535.1e518877@lwn.net> (raw)
In-Reply-To: <20191001182532.21538-1-keescook@chromium.org>
On Tue, 1 Oct 2019 11:25:30 -0700
Kees Cook <keescook@chromium.org> wrote:
> v1: https://lore.kernel.org/lkml/20190924230208.12414-1-keescook@chromium.org
>
> v2: fix python2 utf-8 issue thanks to Jonathan Corbet
>
>
> Commit log from Patch 2 repeated here for cover letter:
>
> In order to have the MAINTAINERS file visible in the rendered ReST
> output, this makes some small changes to the existing MAINTAINERS file
> to allow for better machine processing, and adds a new Sphinx directive
> "maintainers-include" to perform the rendering.
OK, I've applied this. Some notes, none of which really require any
action...
It adds a new warning:
/stuff/k/git/kernel/MAINTAINERS:40416: WARNING: unknown document: ../misc-devices/xilinx_sdfec
I wonder if it's worth checking to be sure that documents referenced in
MAINTAINERS actually exist. OTOH, things as they are generate a warning,
which is what we want anyway.
I did various experiments corrupting the MAINTAINERS file and got some
fairly unphotogenic results. Again, though, I'm not sure that adding a
bunch of code to generate warnings is really worth the trouble.
The resulting HTML file is 3.4MB and definitely makes my browser sweat when
loading it :)
It adds about 20 seconds to a full "make htmldocs" build, which takes just
over 3 minutes on the system in question. So a 10% overhead, essentially.
All told, it does what it's expected to do. Thanks for doing this.
jon
next prev parent reply other threads:[~2019-10-02 16:25 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-01 18:25 [PATCH v2 0/2] docs: Programmatically render MAINTAINERS into ReST Kees Cook
2019-10-01 18:25 ` [PATCH v2 1/2] doc-rst: Reduce CSS padding around Field Kees Cook
2019-10-01 18:25 ` [PATCH v2 2/2] doc-rst: Programmatically render MAINTAINERS into ReST Kees Cook
2019-10-02 16:25 ` Jonathan Corbet [this message]
2019-10-02 16:57 ` [PATCH v2 0/2] docs: " Kees Cook
2019-10-02 17:24 ` Mauro Carvalho Chehab
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=20191002102535.1e518877@lwn.net \
--to=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=keescook@chromium.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@kernel.org \
/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