linux-kernel - [PATCH 05/15] fs: ntfs: compress: Demote a few non-conformant kernel-doc headers

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>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Thu, 20 May 2021 13:00:33 +0100
From:   Lee Jones <lee.jones@...aro.org>
To:     lee.jones@...aro.org
Cc:     linux-kernel@...r.kernel.org,
        Anton Altaparmakov <anton@...era.com>,
        linux-ntfs-dev@...ts.sourceforge.net
Subject: [PATCH 05/15] fs: ntfs: compress: Demote a few non-conformant kernel-doc headers

Fixes the following W=1 kernel build warning(s):

 fs/ntfs/compress.c:22: warning: Incorrect use of kernel-doc format:  * ntfs_compression_constants - enum of constants used in the compression code
 fs/ntfs/compress.c:24: warning: cannot understand function prototype: 'typedef enum '
 fs/ntfs/compress.c:47: warning: cannot understand function prototype: 'u8 *ntfs_compression_buffer; '
 fs/ntfs/compress.c:52: warning: Function parameter or member 'ntfs_cb_lock' not described in 'DEFINE_SPINLOCK'
 fs/ntfs/compress.c:52: warning: expecting prototype for ntfs_cb_lock(). Prototype was for DEFINE_SPINLOCK() instead
 fs/ntfs/compress.c:88: warning: Function parameter or member 'page' not described in 'zero_partial_compressed_page'
 fs/ntfs/compress.c:88: warning: Function parameter or member 'initialized_size' not described in 'zero_partial_compressed_page'
 fs/ntfs/compress.c:107: warning: Function parameter or member 'page' not described in 'handle_bounds_compressed_page'
 fs/ntfs/compress.c:107: warning: Function parameter or member 'i_size' not described in 'handle_bounds_compressed_page'
 fs/ntfs/compress.c:107: warning: Function parameter or member 'initialized_size' not described in 'handle_bounds_compressed_page'

Cc: Anton Altaparmakov <anton@...era.com>
Cc: linux-ntfs-dev@...ts.sourceforge.net
Signed-off-by: Lee Jones <lee.jones@...aro.org>
---
 fs/ntfs/compress.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/fs/ntfs/compress.c b/fs/ntfs/compress.c
index d2f9d6a0ee323..12444ac8f8ec5 100644
--- a/fs/ntfs/compress.c
+++ b/fs/ntfs/compress.c
@@ -18,7 +18,7 @@
 #include "debug.h"
 #include "ntfs.h"

-/**
+/*
  * ntfs_compression_constants - enum of constants used in the compression code
  */
 typedef enum {
@@ -41,12 +41,12 @@ typedef enum {
 	NTFS_MAX_CB_SIZE	= 64 * 1024,
 } ntfs_compression_constants;

-/**
+/*
  * ntfs_compression_buffer - one buffer for the decompression engine
  */
 static u8 *ntfs_compression_buffer;

-/**
+/*
  * ntfs_cb_lock - spinlock which protects ntfs_compression_buffer
  */
 static DEFINE_SPINLOCK(ntfs_cb_lock);
@@ -80,7 +80,7 @@ void free_compression_buffers(void)
 	ntfs_compression_buffer = NULL;
 }

-/**
+/*
  * zero_partial_compressed_page - zero out of bounds compressed page region
  */
 static void zero_partial_compressed_page(struct page *page,
@@ -99,7 +99,7 @@ static void zero_partial_compressed_page(struct page *page,
 	return;
 }

-/**
+/*
  * handle_bounds_compressed_page - test for&handle out of bounds compressed page
  */
 static inline void handle_bounds_compressed_page(struct page *page,
-- 
2.31.1