From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: "Jonathan Corbet" <corbet@lwn.net>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org,
Randy Dunlap <rdunlap@infradead.org>,
Mark Brown <mchehab+huawei@kernel.org>,
Akira Yokosawa <akiyks@gmail.com>
Subject: [PATCH v2 0/3] fixes/improvements for top of docs/build-script
Date: Mon, 22 Sep 2025 13:27:37 +0200 [thread overview]
Message-ID: <cover.1758539031.git.mchehab+huawei@kernel.org> (raw)
Hi Jon,
This series contain the 3 patches against build-script I sent in
separate:
- patch 1 solves a problem with Tumbleweed build. I opted to be verbose
at the comments to properly describe what we're addressing and why;
- patch 2 solves an issue that sometimes happen on my machine while checking
for CONFIG_RUST=y;
- patch 3 contains a request from Akira to allow running just the PDF
step when pdfdocs target is selected.
on patch 3, I opted to not modify Makefile, as I don't see why most
people would want to proceed with PDF builds when latex build fails.
For those who want such feature, e. g. simulate "make -i pdfdocs" behavior,
all it is needed after the change is to run:
tools/docs/sphinx-build-wrapper latexdocs || echo "LaTeX error: $?"
tools/docs/sphinx-build-wrapper -s pdfdocs
eventually adding some extra flags to the second command from the command
line arguments below:
--paper {,a4,letter} Paper size for LaTeX/PDF output
--deny-vf DENY_VF Configuration to deny variable fonts on pdf builds
-v, --verbose place build in verbose mode
-j, --jobs JOBS Sets number of jobs to use with sphinx-build
-i, --interactive Change latex default to run in interactive mode
-s, --skip-sphinx-build
Skip sphinx-build step
E.g. running the second step with, for instance, with:
tools/docs/sphinx-build-wrapper -v -s -i --deny-vf ~/.my-deny pdfdocs
to:
- assume that sphinx-build --builder latex was already executed (-s);
- provide a summary of what PDF files were built at the end (-v);
- run LaTeX in interactive mode in case of errors (-i);
- use a custom deny-list for variable fonts (--deny-vf).
If we add this at docs Makefile, and allow all possible alternatives,
this would just add uneeded complexity there, IMO.
Mauro Carvalho Chehab (3):
tools/docs: sphinx-build-wrapper: fix compat with recent Tumbleweed
docs: Makefile: fix rustdoc detection
tools/docs/sphinx-build-wrapper: allow skipping sphinx-build step
Documentation/Makefile | 4 ++-
tools/docs/sphinx-build-wrapper | 43 ++++++++++++++++++++++++++-------
2 files changed, 37 insertions(+), 10 deletions(-)
--
2.51.0
next reply other threads:[~2025-09-22 11:28 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-09-22 11:27 Mauro Carvalho Chehab [this message]
2025-09-22 11:27 ` [PATCH v2 1/3] tools/docs: sphinx-build-wrapper: fix compat with recent Tumbleweed Mauro Carvalho Chehab
2025-09-24 5:05 ` Randy Dunlap
2025-09-22 11:27 ` [PATCH v2 2/3] docs: Makefile: fix rustdoc detection Mauro Carvalho Chehab
2025-09-22 11:27 ` [PATCH v2 3/3] tools/docs/sphinx-build-wrapper: allow skipping sphinx-build step Mauro Carvalho Chehab
2025-09-25 17:17 ` [PATCH v2 0/3] fixes/improvements for top of docs/build-script Jonathan Corbet
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=cover.1758539031.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.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).