Linux-Doc Archive on lore.kernel.org
 help / color / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	Randy Dunlap <rdunlap@infradead.org>
Subject: Re: [PATCH] scripts/kernel-doc: optionally treat warnings as errors
Date: Mon, 27 Jul 2020 16:28:05 -0600
Message-ID: <20200727162805.3ef9bacf@lwn.net> (raw)
In-Reply-To: <20200724230138.153178-1-pierre-louis.bossart@linux.intel.com>

On Fri, 24 Jul 2020 18:01:38 -0500
Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> wrote:

> The kbuild bot recently added the W=1 option, which triggered
> documentation cleanups to squelch hundreds of kernel-doc warnings.
> 
> To make sure new kernel contributions don't add regressions to
> kernel-doc descriptors, this patch suggests an option to treat
> warnings as errors in CI/automated tests. A command-line option is
> provided to the kernel-doc script, as well as a check on environment
> variables to turn this optional behavior on.
> 
> Examples for the two subsystems I contribute to:
> 
> KCFLAGS="-Wall -Werror" make W=1 sound/
> KCFLAGS="-Wall -Werror" make W=1 drivers/soundwire/
> 
> Randy Dunlap also suggested adding a log for when generating
> documentation. The documentation build is however not stopped for now.
> 
> KDOC_WERROR=1 make htmldocs

So I'm not opposed to this, but I'm missing a couple of things in the
changelog:

 - A statement that you are adding a -Werror option that invokes this
   behavior.

 - Mention of the fact that you also cause it to look at a couple of
   environment variables and change its behavior based on that.

Could I get a version with that clarified a bit?

Thanks,

jon

  reply index

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-24 23:01 Pierre-Louis Bossart
2020-07-27 22:28 ` Jonathan Corbet [this message]
2020-07-27 23:09   ` Pierre-Louis Bossart
2020-07-27 23:15     ` Jonathan Corbet
2020-07-27 23:18       ` Pierre-Louis Bossart

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=20200727162805.3ef9bacf@lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pierre-louis.bossart@linux.intel.com \
    --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

Linux-Doc Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-doc/0 linux-doc/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-doc linux-doc/ https://lore.kernel.org/linux-doc \
		linux-doc@vger.kernel.org
	public-inbox-index linux-doc

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-doc


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git