linux-kernel - [PATCH] lib/sort.c: fix kernel-doc notation warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <60e25d3d-68d1-bde2-3b39-e4baa0b14907@infradead.org>
Date:   Mon, 20 May 2019 14:20:43 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     LKML <linux-kernel@...r.kernel.org>,
        Andrew Morton <akpm@...ux-foundation.org>
Cc:     George Spelvin <lkml@....org>,
        "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>
Subject: [PATCH] lib/sort.c: fix kernel-doc notation warnings

From: Randy Dunlap <rdunlap@...radead.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@...radead.org>
Cc: George Spelvin <lkml@....org>
Cc: Andrew Morton <akpm@...ux-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.
  */