From: Randy Dunlap <rdunlap@infradead.org>
To: LKML <linux-kernel@vger.kernel.org>,
Andrew Morton <akpm@linux-foundation.org>
Cc: George Spelvin <lkml@sdf.org>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>
Subject: [PATCH] lib/sort.c: fix kernel-doc notation warnings
Date: Mon, 20 May 2019 14:20:43 -0700
Message-ID: <60e25d3d-68d1-bde2-3b39-e4baa0b14907@infradead.org> (raw)
From: Randy Dunlap <rdunlap@infradead.org>
Fix kernel-doc notation in lib/sort.c by using correct function
parameter names.
../lib/sort.c:59: warning: Excess function parameter 'size' description in 'swap_words_32'
../lib/sort.c:83: warning: Excess function parameter 'size' description in 'swap_words_64'
../lib/sort.c:110: warning: Excess function parameter 'size' description in 'swap_bytes'
Fixes: 37d0ec34d111a ("lib/sort: make swap functions more generic")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: George Spelvin <lkml@sdf.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
---
This patch still leaves these Sphinx warnings, which appears to be
some kind of "feature." :(
../lib/list_sort.c:128: WARNING: Definition list ends without a blank line; unexpected unindent.
../lib/list_sort.c:161: WARNING: Unexpected indentation.
../lib/list_sort.c:162: WARNING: Block quote ends without a blank line; unexpected unindent.
lib/sort.c | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
--- lnx-52-rc1.orig/lib/sort.c
+++ lnx-52-rc1/lib/sort.c
@@ -43,8 +43,9 @@ static bool is_aligned(const void *base,
/**
* swap_words_32 - swap two elements in 32-bit chunks
- * @a, @b: pointers to the elements
- * @size: element size (must be a multiple of 4)
+ * @a: pointer to the first element to swap
+ * @b: pointer to the second element to swap
+ * @n: element size (must be a multiple of 4)
*
* Exchange the two objects in memory. This exploits base+index addressing,
* which basically all CPUs have, to minimize loop overhead computations.
@@ -65,8 +66,9 @@ static void swap_words_32(void *a, void
/**
* swap_words_64 - swap two elements in 64-bit chunks
- * @a, @b: pointers to the elements
- * @size: element size (must be a multiple of 8)
+ * @a: pointer to the first element to swap
+ * @b: pointer to the second element to swap
+ * @n: element size (must be a multiple of 8)
*
* Exchange the two objects in memory. This exploits base+index
* addressing, which basically all CPUs have, to minimize loop overhead
@@ -100,8 +102,9 @@ static void swap_words_64(void *a, void
/**
* swap_bytes - swap two elements a byte at a time
- * @a, @b: pointers to the elements
- * @size: element size
+ * @a: pointer to the first element to swap
+ * @b: pointer to the second element to swap
+ * @n: element size
*
* This is the fallback if alignment doesn't allow using larger chunks.
*/
reply index
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=60e25d3d-68d1-bde2-3b39-e4baa0b14907@infradead.org \
--to=rdunlap@infradead.org \
--cc=akpm@linux-foundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkml@sdf.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