public inbox for linux-next@vger.kernel.org
 help / color / mirror / Atom feed
From: Eric Biggers <ebiggers@kernel.org>
To: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: "Jason A. Donenfeld" <Jason@zx2c4.com>,
	Ard Biesheuvel <ardb@kernel.org>,
	David Howells <dhowells@redhat.com>,
	Linux Crypto List <linux-crypto@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Next Mailing List <linux-next@vger.kernel.org>
Subject: Re: linux-next: build warning after merge of the libcrypto tree
Date: Wed, 5 Nov 2025 19:55:21 -0800	[thread overview]
Message-ID: <20251106035521.GA1650@sol> (raw)
In-Reply-To: <20251106143623.06b23d57@canb.auug.org.au>

On Thu, Nov 06, 2025 at 02:36:23PM +1100, Stephen Rothwell wrote:
> Hi all,
> 
> After merging the libcrypto tree, today's linux-next build (htmldocs)
> produced this warning:
> 
> WARNING: /home/sfr/kernels/next/next/include/crypto/sha3.h:74 This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Zeroize a sha3_ctx.  This is already called by sha3_final().  Call this
> 
> Introduced by commit
> 
>   58873ecf091b ("lib/crypto: sha3: Add SHA-3 support")

Thanks.  Do you know if there's an easy way to find these ahead of time?
I usually run './scripts/kernel-doc -v -none ${filename}' to catch
kerneldoc issues.  I did run it on include/crypto/sha3.h, but for some
reason it doesn't detect this issue.

'make htmldocs' doesn't find it either, but does generate a bunch of
unrelated warnings.  I may be missing an option to make it even more
verbose.  Either way, it's also slow to run.

- Eric

  reply	other threads:[~2025-11-06  3:57 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-06  3:36 linux-next: build warning after merge of the libcrypto tree Stephen Rothwell
2025-11-06  3:55 ` Eric Biggers [this message]
2025-11-06  4:19   ` Eric Biggers
2025-11-06  7:27     ` Stephen Rothwell
2025-11-06  5:43   ` Randy Dunlap

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=20251106035521.GA1650@sol \
    --to=ebiggers@kernel.org \
    --cc=Jason@zx2c4.com \
    --cc=ardb@kernel.org \
    --cc=dhowells@redhat.com \
    --cc=linux-crypto@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-next@vger.kernel.org \
    --cc=sfr@canb.auug.org.au \
    /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