linux-kernel - [PATCH 1/2] lib/842: Fix kernel-doc warnings for sw842

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 for Android: free password hash cracker in your pocket

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

Message-ID: <20251113164019.48840-1-adelodunolaoluwa@yahoo.com>
Date: Thu, 13 Nov 2025 17:40:18 +0100
From: Sunday Adelodun <adelodunolaoluwa@...oo.com>
To: haren@...ibm.com
Cc: linux-kernel@...r.kernel.org,
	skhan@...uxfoundation.org,
	david.hunter.linux@...il.com,
	linux-kernel-mentees@...ts.linuxfoundation.org,
	Sunday Adelodun <adelodunolaoluwa@...oo.com>
Subject: [PATCH 1/2] lib/842: Fix kernel-doc warnings for sw842_compress()

The following warnings were reported:
  Warning: lib/842/842_compress.c:467 missing initial short
	 description
  Warning: lib/842/842_compress.c:478 function parameter
        'in' not described
  Warning: lib/842/842_compress.c:478 function parameter
        'ilen' not described
  Warning: lib/842/842_compress.c:478 function parameter
         'out' not described
  Warning: lib/842/842_compress.c:478 function parameter
         'olen' not described
  Warning: lib/842/842_compress.c:478 function parameter
         'wmem' not described

Fix several kernel-doc warnings in sw842_compress() due to missing
function description and undocumented parameters.

Signed-off-by: Sunday Adelodun <adelodunolaoluwa@...oo.com>
---
 lib/842/842_compress.c | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/lib/842/842_compress.c b/lib/842/842_compress.c
index 055356508d97..0423e3af20ee 100644
--- a/lib/842/842_compress.c
+++ b/lib/842/842_compress.c
@@ -465,10 +465,12 @@ static int process_next(struct sw842_param *p)
 }
 
 /**
- * sw842_compress
- *
- * Compress the uncompressed buffer of length @ilen at @in to the output buffer
- * @out, using no more than @olen bytes, using the 842 compression format.
+ * sw842_compress -  Compress the uncompressed buffer using 842 format
+ * @in: Pointer to the input (uncompressed) buffer.
+ * @ilen: Length (in bytes) of the input buffer.
+ * @out: Pointer to the output buffer where compressed data is written
+ * @olen: Pointer to a variable holding the maximum output length.
+ * @wmem: Working memory used internally by the compressor.
  *
  * Returns: 0 on success, error on failure.  The @olen parameter
  * will contain the number of output bytes written on success, or
-- 
2.43.0