public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jani Nikula <jani.nikula@intel.com>
Cc: linux-doc@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: Re: Passing SPHINXOPTS is broken
Date: Fri, 23 Jan 2026 16:09:33 +0100	[thread overview]
Message-ID: <20260123160933.45ebb2bc@localhost> (raw)
In-Reply-To: <faac4df15ab5b87dc5795143ecafb9b725b9118e@intel.com>

On Fri, 23 Jan 2026 16:28:37 +0200
Jani Nikula <jani.nikula@intel.com> wrote:

> On Fri, 23 Jan 2026, Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> > With Makefile, there isn't. This didn't change: it is just the same
> > behavior we used to have before the wrapper addition, after this
> > changeset (merged in 2022):
> >
> > 	c0d3b83100c8 ("kbuild: do not print extra logs for V=2")
> >
> > Now, currently it is possible to do that by calling the wrapper
> > directly:
> >
> > 	$ ./tools/docs/sphinx-build-wrapper -v htmldocs --sphinxdirs peci
> >
> > Here, "-v" instructs the wrapper to drop "-q" flag, but doesn't touch
> > KBUILD_VERBOSE, so you won't see kernel-doc debug messages.  
> 
> I'm not really interested in using the wrapper directly. I use make O=
> builds, and I don't want to and I should not have to figure out how to
> do that with the wrapper.
> 
> Again, it should be possible to pass user SPHINXOPTS to sphinx-build.

Agreed, but the problem is that, since a long time, "-q" was always 
aways added when V=0, and we don't have V=2 for docs anymore.

Unfortunately, Sphinx doesn't have a --no-quiet option. So, right now it
preserves the behavior it had for a long time:

- if V=0, defaults to "-q"
- if V=1, defaults to not use "-q", but one can add SPHINXOPTS=-q
  to keep Sphinx build in quiet mode.

What we could do is to add something like this:

	diff --git a/tools/docs/sphinx-build-wrapper b/tools/docs/sphinx-build-wrapper
	index 7a5fcef25429..13731b478822 100755
	--- a/tools/docs/sphinx-build-wrapper
	+++ b/tools/docs/sphinx-build-wrapper
	@@ -165,6 +165,7 @@ class SphinxBuilder:
	         parser = argparse.ArgumentParser()
	         parser.add_argument('-j', '--jobs', type=int)
	         parser.add_argument('-q', '--quiet', action='store_true')
	+        parser.add_argument('-n', '--not-quiet', action='store_true')
 
	         #
	         # Other sphinx-build arguments go as-is, so place them
	@@ -181,6 +182,9 @@ class SphinxBuilder:
	         if sphinx_args.quiet is True:
	             verbose = False
	 
	+        if sphinx_args.not_quiet is True:
	+            verbose = True
	+
	         #
	         # If the user explicitly sets "-j" at command line, use it.
	         # Otherwise, pick it from SPHINXOPTS args

Regards,
Mauro

  reply	other threads:[~2026-01-23 15:09 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-23 10:57 Passing SPHINXOPTS is broken Jani Nikula
2026-01-23 11:06 ` Jani Nikula
2026-01-23 11:35   ` Mauro Carvalho Chehab
2026-01-23 13:47     ` Jani Nikula
2026-01-23 14:10       ` Mauro Carvalho Chehab
2026-01-23 14:28         ` Jani Nikula
2026-01-23 15:09           ` Mauro Carvalho Chehab [this message]
2026-01-23 20:33             ` 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=20260123160933.45ebb2bc@localhost \
    --to=mchehab+huawei@kernel.org \
    --cc=corbet@lwn.net \
    --cc=jani.nikula@intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=mchehab@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