public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: Jani Nikula <jani.nikula@intel.com>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
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 15:47:30 +0200	[thread overview]
Message-ID: <233a2366263111e61700da07f3692a029fc51a50@intel.com> (raw)
In-Reply-To: <20260123123215.32f6c40a@foz.lan>

On Fri, 23 Jan 2026, Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> On Fri, 23 Jan 2026 13:06:51 +0200
> Jani Nikula <jani.nikula@intel.com> wrote:
>
>> On Fri, 23 Jan 2026, Jani Nikula <jani.nikula@intel.com> wrote:
>> > I was trying to get the regular sphinx-build output.
>
> Just do:
>
> 	$ make V=1 htmldocs
>
> or:
> 	$ ./tools/docs/sphinx-build-wrapper -v htmldocs
>
>> > The monster sphinx-build-wrapper thing has this obnoxious and complex
>> > logic of forcing -q unless you specify verbose in SPHINXOPTS. You'd
>> > think those defaults should be specified in the Makefile. But no.
>
> It is like there to mimic what we used to have at Makefile.
>
>> > Anyway, setting SPHINXOPTS in the environment or on the make
>> > command-line doesn't work, because Documentation/Makefile overrides it
>> > to empty.  
>> 
>> Oh, it's more sad than just this. There is no way to use SPHINXOPTS to
>> get sphinx-build to produce the regular non-quiet output (that the
>> wrapper calls verbose).
>>
>> You have to use KBUILD_VERBOSE to make the damn wrapper not pass -q to
>> sphinx-build. 
>
> KBUILD_VERBOSE is the Makefile's env var that handles V=1.
>
>>The wrapper appends the -q overwriting anything the user
>> might want to pass on SPHINXOPTS. Which can't be passed anyway because
>> the Makefile overwrites it.
>
> It is like there to mimic what we used to have at Makefile: it was
> was always passing "-q", except when called with V=1.

I don't want verbose output from e.g. kernel-doc saying "Scanning doc
for function" bla bla blaa, but I do want the regular Sphinx messages on
what phase of the build it's at.

There doesn't seem to be a way to get the regular Sphinx "not quiet, not
verbose" output, without also going verbose on silly kernel-doc
messages.


BR,
Jani.

-- 
Jani Nikula, Intel

  reply	other threads:[~2026-01-23 13:47 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 [this message]
2026-01-23 14:10       ` Mauro Carvalho Chehab
2026-01-23 14:28         ` Jani Nikula
2026-01-23 15:09           ` Mauro Carvalho Chehab
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=233a2366263111e61700da07f3692a029fc51a50@intel.com \
    --to=jani.nikula@intel.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=mchehab+huawei@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