Commit aa0b42b7 authored by Randy Dunlap's avatar Randy Dunlap Committed by Andrew Morton
Browse files

ntfs: fix multiple kernel-doc warnings 

Fix many W=1 kernel-doc warnings in fs/ntfs/:

fs/ntfs/aops.c:30: warning: Incorrect use of kernel-doc format:  * ntfs_end_buffer_async_read - async io completion for reading attributes
fs/ntfs/aops.c:46: warning: expecting prototype for aops.c(). Prototype was for ntfs_end_buffer_async_read() instead
fs/ntfs/aops.c:1655: warning: cannot understand function prototype: 'const struct address_space_operations ntfs_normal_aops = '
fs/ntfs/aops.c:1670: warning: cannot understand function prototype: 'const struct address_space_operations ntfs_compressed_aops = '
fs/ntfs/aops.c:1685: warning: cannot understand function prototype: 'const struct address_space_operations ntfs_mst_aops = '
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: expecting prototype for ntfs_cb_lock(). Prototype was for DEFINE_SPINLOCK() instead
fs/ntfs/dir.c:21: warning: Incorrect use of kernel-doc format:  * The little endian Unicode string $I30 as a global constant.
fs/ntfs/dir.c:23: warning: cannot understand function prototype: 'ntfschar I30[5] = '
fs/ntfs/inode.c:31: warning: Incorrect use of kernel-doc format:  * ntfs_test_inode - compare two (possibly fake) inodes for equality
fs/ntfs/inode.c:47: warning: expecting prototype for inode.c(). Prototype was for ntfs_test_inode() instead
fs/ntfs/inode.c:2956: warning: expecting prototype for ntfs_write_inode(). Prototype was for __ntfs_write_inode() instead
fs/ntfs/mft.c:24: warning: expecting prototype for mft.c - NTFS kernel mft record operations. Part of the Linux(). Prototype was for MAX_BHS() instead
fs/ntfs/namei.c:263: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Inode operations for directories.
fs/ntfs/namei.c:368: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Export operations allowing NFS exporting of mounted NTFS partitions.
fs/ntfs/runlist.c:16: warning: Incorrect use of kernel-doc format:  * ntfs_rl_mm - runlist memmove
fs/ntfs/runlist.c:22: warning: expecting prototype for runlist.c - NTFS runlist handling code.  Part of the Linux(). Prototype was for ntfs_rl_mm() instead
fs/ntfs/super.c:61: warning: missing initial short description on line:
 * simple_getbool -
fs/ntfs/super.c:2661: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * The complete super operations.

Link: https://lkml.kernel.org/r/20230109010041.21442-1-rdunlap@infradead.org


Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Anton Altaparmakov <anton@tuxera.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent d3fcf834

fs/ntfs/aops.c

+5 −5
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-or-later

/**

/*

 * aops.c - NTFS kernel address space operations and page cache handling.

 *

 * Copyright (c) 2001-2014 Anton Altaparmakov and Tuxera Inc.
@@ -1646,7 +1646,7 @@ static sector_t ntfs_bmap(struct address_space *mapping, sector_t block) 
	return block;

}



/**

/*

 * ntfs_normal_aops - address space operations for normal inodes and attributes

 *

 * Note these are not used for compressed or mst protected inodes and
@@ -1664,7 +1664,7 @@ const struct address_space_operations ntfs_normal_aops = { 
	.error_remove_page = generic_error_remove_page,

};



/**

/*

 * ntfs_compressed_aops - address space operations for compressed inodes

 */

const struct address_space_operations ntfs_compressed_aops = {
@@ -1678,7 +1678,7 @@ const struct address_space_operations ntfs_compressed_aops = { 
	.error_remove_page = generic_error_remove_page,

};



/**

/*

 * ntfs_mst_aops - general address space operations for mst protecteed inodes

 *			  and attributes

 */

fs/ntfs/aops.h

+1 −1
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0-or-later */

/**

/*

 * aops.h - Defines for NTFS kernel address space operations and page cache

 *	    handling.  Part of the Linux-NTFS project.

 *

fs/ntfs/compress.c

+3 −3
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-or-later

/**

/*

 * compress.c - NTFS kernel compressed attributes handling.

 *		Part of the Linux-NTFS project.

 *
@@ -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);

fs/ntfs/dir.c

+2 −2
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-or-later

/**

/*

 * dir.c - NTFS kernel directory operations. Part of the Linux-NTFS project.

 *

 * Copyright (c) 2001-2007 Anton Altaparmakov
@@ -17,7 +17,7 @@ 
#include "debug.h"

#include "ntfs.h"



/**

/*

 * The little endian Unicode string $I30 as a global constant.

 */

ntfschar I30[5] = { cpu_to_le16('$'), cpu_to_le16('I'),

fs/ntfs/inode.c

+3 −3
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-or-later

/**

/*

 * inode.c - NTFS kernel inode handling.

 *

 * Copyright (c) 2001-2014 Anton Altaparmakov and Tuxera Inc.
@@ -2935,7 +2935,7 @@ int ntfs_setattr(struct user_namespace *mnt_userns, struct dentry *dentry, 
}



/**

 * ntfs_write_inode - write out a dirty inode

 * __ntfs_write_inode - write out a dirty inode

 * @vi:		inode to write out

 * @sync:	if true, write out synchronously

 *
@@ -3033,7 +3033,7 @@ int __ntfs_write_inode(struct inode *vi, int sync) 
	 * might not need to be written out.

	 * NOTE: It is not a problem when the inode for $MFT itself is being

	 * written out as mark_ntfs_record_dirty() will only set I_DIRTY_PAGES

	 * on the $MFT inode and hence ntfs_write_inode() will not be

	 * on the $MFT inode and hence __ntfs_write_inode() will not be

	 * re-invoked because of it which in turn is ok since the dirtied mft

	 * record will be cleaned and written out to disk below, i.e. before

	 * this function returns.