From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH RESEND v3 00/15] Split sphinx call logic from docs Makefile
Date: Thu, 4 Sep 2025 00:57:11 +0200 [thread overview]
Message-ID: <20250904005711.142ebaae@foz.lan> (raw)
In-Reply-To: <873493p2vt.fsf@trenco.lwn.net>
Em Wed, 03 Sep 2025 16:50:14 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
>
> > This series does a major cleanup at docs Makefile by moving the
> > actual doc build logic to a helper script (scripts/sphinx-build-wrapper).
> >
> > Such script was written in a way that it can be called either
> > directly or via a makefile. When running via makefile, it will
> > use GNU jobserver to ensure that, when sphinx-build is
> > called, the number of jobs will match at most what it is
> > specified by the "-j" parameter.
>
> So I've been playing with these a bit more, still trying to wrap my head
> around them. I do wish that we were somehow ending up with something
> simpler than the status quo, but perhaps the problem domain just isn't
> that simple.
No, it isn't. We can do some cleanups later on by removing some env
vars, but still the sphinx-build logic we use is complex.
> > The first 3 patches do a cleanup at scripts/jobserver-exec
> > and moves the actual code to a library. Such library is used
> > by both the jobserver-exec command line and by sphinx-build-wrappper.
>
> These three seem OK, anyway, and could probably go in anytime.
Sure. Yet, we need them to ensure that sphinx-build-wrapper can
run jobs in parallel respecting make limits. If you prefer, you
can merge those three to reduce the number of patches I'll be
sending on the next version.
> > The change also gets rid of parallel-wrapper.sh, whose
> > functions are now part of the wrapper code.
> >
> > I added two patches at the end adding an extra target: "mandocs".
> > The patches came from a series I sent in separate with 2 patches.
>
> As for the rest, a couple of notes from where I am so far:
>
> - The separation of the comments into their own patch is ... a bit
> strange and makes the patches harder to review. I plan to spend some
> time looking at the end product, but still ...
Feel free to merge it after reviewing. The only reason I split it
is because you complained about the number of lines that the new
script have. With the split, it becomes clearer how much lines are
the actual code, and how much are the comments.
> - Acting on a hint from Akira, I note that "make O=elsewhere htmldocs"
> no longer works - the output goes into Documentation/output
> regardless. That, I think, needs to be fixed.
Sure thing. I'll run some tests here and send a new version.
Thanks,
Mauro
prev parent reply other threads:[~2025-09-03 22:57 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-01 15:33 [PATCH RESEND v3 00/15] Split sphinx call logic from docs Makefile Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 01/15] scripts/jobserver-exec: move the code to a class Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 02/15] scripts/jobserver-exec: move its class to the lib directory Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 03/15] scripts/jobserver-exec: add a help message Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 04/15] scripts: sphinx-pre-install: move it to tools/docs Mauro Carvalho Chehab
2025-09-03 23:00 ` Jonathan Corbet
2025-09-04 7:05 ` Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 05/15] tools/docs: sphinx-pre-install: move Python version handling to lib Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 06/15] tools/docs: sphinx-build-wrapper: add a wrapper for sphinx-build Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 07/15] tools/docs: sphinx-build-wrapper: add comments and blank lines Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 08/15] tools/docs: sphinx-build-wrapper: add support to run inside venv Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 09/15] docs: parallel-wrapper.sh: remove script Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 10/15] docs: Makefile: document latex/PDF PAPER= parameter Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 11/15] tools/docs: sphinx-build-wrapper: add an argument for LaTeX interactive mode Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 12/15] tools/docs,scripts: sphinx-*: prevent sphinx-build crashes Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 13/15] tools/docs: sphinx-build-wrapper: allow building PDF files in parallel Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 14/15] docs: add support to build manpages from kerneldoc output Mauro Carvalho Chehab
2025-09-01 15:33 ` [PATCH RESEND v3 15/15] tools: kernel-doc: add a see also section at man pages Mauro Carvalho Chehab
2025-09-03 22:50 ` [PATCH RESEND v3 00/15] Split sphinx call logic from docs Makefile Jonathan Corbet
2025-09-03 22:57 ` Mauro Carvalho Chehab [this message]
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=20250904005711.142ebaae@foz.lan \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.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;
as well as URLs for NNTP newsgroup(s).