From: sashiko-bot@kernel.org
To: "David Howells" <dhowells@redhat.com>
Cc: v9fs@lists.linux.dev, "Chuck Lever" <cel@kernel.org>,
"Jeff Layton" <jlayton@kernel.org>,
"Anna Schumaker" <anna@kernel.org>
Subject: Re: [PATCH v19 05/17] iov_iter: Add an API document for the bvecq structure
Date: Thu, 19 Nov 2026 08:53:09 +0000 [thread overview]
Message-ID: <sashiko-outbox-222734@kernel.org> (raw)
In-Reply-To: <20261119083851.3306418-6-dhowells@redhat.com>
Thank you for your contribution! Sashiko AI review found 1 potential
issue to consider:
- [Low] docs: bvecq: malformed kernel-doc markup in bvecq.c and bvecq.h
--
commit 4351a64f55127d5c3a801238a9cedf6a1d7b17ac
Author: David Howells <dhowells@redhat.com>
iov_iter: Add an API document for the bvecq structure
This commit adds Documentation/core-api/bvecq.rst documenting the bvecq
structure and its API, and links it into the core-api index and
MAINTAINERS.
> diff --git a/Documentation/core-api/bvecq.rst b/Documentation/core-api/bvecq.rst
> new file mode 100644
> index 0000000000000..7e06ca81512ab
> --- /dev/null
> +++ b/Documentation/core-api/bvecq.rst
[ ... ]
> +API Function Reference
> +======================
> +
> +.. kernel-doc:: include/linux/bvecq.h
> +.. kernel-doc:: fs/netfs/bvecq.c
[Severity: Low]
Pulling these two files into the documentation build exposes a few
kernel-doc issues in the comments introduced earlier in the series.
In fs/netfs/bvecq.c, the kernel-doc comments for bvecq_alloc_one(),
bvecq_alloc_chain() and bvecq_alloc_buffer2() write *flags and *%flags
instead of *@flags, which leaves unmatched single asterisks in the
generated reStructuredText and triggers docutils inline emphasis warnings
during make htmldocs:
fs/netfs/bvecq.c:bvecq_alloc_chain()
* Allocate a chain of bvecq nodes providing at least the requested cumulative
* number of slots. Each node is a maximum of 4KiB in size. If
* %BVECQ_SHORT_OKAY is set in *%flags, then the chain may be shortened on OOM.
*
* Return: The first node pointer or NULL on allocation failure. BVECQ_HIT_OOM
* is set in *flags if an allocation failure occurs.
Also, in include/linux/bvecq.h, the kernel-doc summary line for
bvecq_append() appears to be copy-pasted from bvecq_next():
include/linux/bvecq.h:bvecq_append()
/**
* bvecq_append - Get the next bvecq with appropriate barrier
* @to: The bvecq to append to
* @add: The bvecq to append
--
Sashiko AI review · https://sashiko.dev/#/patchset/20261119083851.3306418-1-dhowells@redhat.com?part=5
next prev parent reply other threads:[~2026-11-19 8:53 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-19 8:38 [PATCH v19 00/17] netfs, iov_iter: Use a chain of bio_vec arrays instead of folio_queue David Howells
2026-11-19 8:38 ` [PATCH v19 01/17] iov_iter: Fix kunit test to remove __init and __refdata marks David Howells
2026-11-19 8:47 ` sashiko-bot
2026-11-19 9:21 ` Wang Yibo
2026-11-19 8:38 ` [PATCH v19 02/17] block: Add a function to kmap one page of a multipage bio_vec David Howells
2026-11-19 8:44 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 03/17] iov_iter: Add a segmented queue of bio_vec[] David Howells
2026-11-19 8:52 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 04/17] netfs: Add some tools for managing bvecq chains David Howells
2026-11-19 9:07 ` sashiko-bot
2026-11-19 11:49 ` David Howells
2026-11-19 8:38 ` [PATCH v19 05/17] iov_iter: Add an API document for the bvecq structure David Howells
2026-11-19 8:53 ` sashiko-bot [this message]
2026-11-19 8:38 ` [PATCH v19 06/17] iov_iter: Add a bvecq kunit test David Howells
2026-11-19 8:50 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 07/17] afs: Fix an inconsistency in the symlink code David Howells
2026-11-19 8:57 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 08/17] netfs: Explicitly pass tail padding to netfs_writeback_single() David Howells
2026-11-19 9:15 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 09/17] netfs: Change netfs_writeback_single() to not look inside the iterator David Howells
2026-11-19 9:09 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 10/17] netfs: Pass the write length to request creation where appropriate David Howells
2026-11-19 8:56 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 11/17] afs: Use a bvecq to hold dir content rather than folioq David Howells
2026-11-19 9:29 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 12/17] cifs: Use a bvecq for buffering instead of a folioq David Howells
2026-11-19 9:10 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 13/17] smbdirect: Support ITER_BVECQ in smbdirect_map_sges_from_iter() David Howells
2026-11-19 9:15 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 14/17] netfs: Switch folioq to bvecq David Howells
2026-11-19 9:38 ` sashiko-bot
2026-11-19 11:49 ` David Howells
2026-11-19 8:38 ` [PATCH v19 15/17] smbdirect: Remove support for ITER_FOLIOQ from smbdirect_map_sges_from_iter() David Howells
2026-11-19 9:13 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 16/17] iov_iter: Remove ITER_FOLIOQ David Howells
2026-11-19 9:20 ` sashiko-bot
2026-11-19 8:38 ` [PATCH v19 17/17] netfs: Remove folio_queue David Howells
2026-11-19 9:18 ` sashiko-bot
2026-11-20 9:38 ` [PATCH v19 00/17] netfs, iov_iter: Use a chain of bio_vec arrays instead of folio_queue Christian Brauner
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=sashiko-outbox-222734@kernel.org \
--to=sashiko-bot@kernel.org \
--cc=anna@kernel.org \
--cc=cel@kernel.org \
--cc=dhowells@redhat.com \
--cc=jlayton@kernel.org \
--cc=sashiko-reviews@lists.linux.dev \
--cc=v9fs@lists.linux.dev \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.