Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6468b3af authored by Randy Dunlap's avatar Randy Dunlap Committed by Greg Kroah-Hartman
Browse files

Debugfs: kernel-doc fixes for debugfs 



Fix kernel-doc and typos/spellos in fs/debugfs/.

Signed-off-by: default avatarRandy Dunlap <rdunlap@xenotime.net>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@suse.de>
parent eea3f891

fs/debugfs/file.c

+25 −31
Original line number Diff line number Diff line
@@ -55,12 +55,11 @@ static u64 debugfs_u8_get(void *data) 
DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n");



/**

 * debugfs_create_u8 - create a file in the debugfs filesystem that is used to read and write an unsigned 8 bit value.

 *

 * debugfs_create_u8 - create a debugfs file that is used to read and write an unsigned 8-bit value

 * @name: a pointer to a string containing the name of the file to create.

 * @mode: the permission that the file should have

 * @parent: a pointer to the parent dentry for this file.  This should be a

 *          directory dentry if set.  If this paramater is NULL, then the

 *          directory dentry if set.  If this parameter is %NULL, then the

 *          file will be created in the root of the debugfs filesystem.

 * @value: a pointer to the variable that the file should read to and write

 *         from.
@@ -72,11 +71,11 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_u8, debugfs_u8_get, debugfs_u8_set, "%llu\n"); 
 * This function will return a pointer to a dentry if it succeeds.  This

 * pointer must be passed to the debugfs_remove() function when the file is

 * to be removed (no automatic cleanup happens if your module is unloaded,

 * you are responsible here.)  If an error occurs, NULL will be returned.

 * you are responsible here.)  If an error occurs, %NULL will be returned.

 *

 * If debugfs is not enabled in the kernel, the value -ENODEV will be

 * If debugfs is not enabled in the kernel, the value -%ENODEV will be

 * returned.  It is not wise to check for this value, but rather, check for

 * NULL or !NULL instead as to eliminate the need for #ifdef in the calling

 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling

 * code.

 */

struct dentry *debugfs_create_u8(const char *name, mode_t mode,
@@ -97,12 +96,11 @@ static u64 debugfs_u16_get(void *data) 
DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n");



/**

 * debugfs_create_u16 - create a file in the debugfs filesystem that is used to read and write an unsigned 16 bit value.

 *

 * debugfs_create_u16 - create a debugfs file that is used to read and write an unsigned 16-bit value

 * @name: a pointer to a string containing the name of the file to create.

 * @mode: the permission that the file should have

 * @parent: a pointer to the parent dentry for this file.  This should be a

 *          directory dentry if set.  If this paramater is NULL, then the

 *          directory dentry if set.  If this parameter is %NULL, then the

 *          file will be created in the root of the debugfs filesystem.

 * @value: a pointer to the variable that the file should read to and write

 *         from.
@@ -114,11 +112,11 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_u16, debugfs_u16_get, debugfs_u16_set, "%llu\n"); 
 * This function will return a pointer to a dentry if it succeeds.  This

 * pointer must be passed to the debugfs_remove() function when the file is

 * to be removed (no automatic cleanup happens if your module is unloaded,

 * you are responsible here.)  If an error occurs, NULL will be returned.

 * you are responsible here.)  If an error occurs, %NULL will be returned.

 *

 * If debugfs is not enabled in the kernel, the value -ENODEV will be

 * If debugfs is not enabled in the kernel, the value -%ENODEV will be

 * returned.  It is not wise to check for this value, but rather, check for

 * NULL or !NULL instead as to eliminate the need for #ifdef in the calling

 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling

 * code.

 */

struct dentry *debugfs_create_u16(const char *name, mode_t mode,
@@ -139,12 +137,11 @@ static u64 debugfs_u32_get(void *data) 
DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n");



/**

 * debugfs_create_u32 - create a file in the debugfs filesystem that is used to read and write an unsigned 32 bit value.

 *

 * debugfs_create_u32 - create a debugfs file that is used to read and write an unsigned 32-bit value

 * @name: a pointer to a string containing the name of the file to create.

 * @mode: the permission that the file should have

 * @parent: a pointer to the parent dentry for this file.  This should be a

 *          directory dentry if set.  If this paramater is NULL, then the

 *          directory dentry if set.  If this parameter is %NULL, then the

 *          file will be created in the root of the debugfs filesystem.

 * @value: a pointer to the variable that the file should read to and write

 *         from.
@@ -156,11 +153,11 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_u32, debugfs_u32_get, debugfs_u32_set, "%llu\n"); 
 * This function will return a pointer to a dentry if it succeeds.  This

 * pointer must be passed to the debugfs_remove() function when the file is

 * to be removed (no automatic cleanup happens if your module is unloaded,

 * you are responsible here.)  If an error occurs, NULL will be returned.

 * you are responsible here.)  If an error occurs, %NULL will be returned.

 *

 * If debugfs is not enabled in the kernel, the value -ENODEV will be

 * If debugfs is not enabled in the kernel, the value -%ENODEV will be

 * returned.  It is not wise to check for this value, but rather, check for

 * NULL or !NULL instead as to eliminate the need for #ifdef in the calling

 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling

 * code.

 */

struct dentry *debugfs_create_u32(const char *name, mode_t mode,
@@ -219,12 +216,11 @@ static const struct file_operations fops_bool = { 
};



/**

 * debugfs_create_bool - create a file in the debugfs filesystem that is used to read and write a boolean value.

 *

 * debugfs_create_bool - create a debugfs file that is used to read and write a boolean value

 * @name: a pointer to a string containing the name of the file to create.

 * @mode: the permission that the file should have

 * @parent: a pointer to the parent dentry for this file.  This should be a

 *          directory dentry if set.  If this paramater is NULL, then the

 *          directory dentry if set.  If this parameter is %NULL, then the

 *          file will be created in the root of the debugfs filesystem.

 * @value: a pointer to the variable that the file should read to and write

 *         from.
@@ -236,11 +232,11 @@ static const struct file_operations fops_bool = { 
 * This function will return a pointer to a dentry if it succeeds.  This

 * pointer must be passed to the debugfs_remove() function when the file is

 * to be removed (no automatic cleanup happens if your module is unloaded,

 * you are responsible here.)  If an error occurs, NULL will be returned.

 * you are responsible here.)  If an error occurs, %NULL will be returned.

 *

 * If debugfs is not enabled in the kernel, the value -ENODEV will be

 * If debugfs is not enabled in the kernel, the value -%ENODEV will be

 * returned.  It is not wise to check for this value, but rather, check for

 * NULL or !NULL instead as to eliminate the need for #ifdef in the calling

 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling

 * code.

 */

struct dentry *debugfs_create_bool(const char *name, mode_t mode,
@@ -264,13 +260,11 @@ static struct file_operations fops_blob = { 
};



/**

 * debugfs_create_blob - create a file in the debugfs filesystem that is

 * used to read and write a binary blob.

 *

 * debugfs_create_blob - create a debugfs file that is used to read and write a binary blob

 * @name: a pointer to a string containing the name of the file to create.

 * @mode: the permission that the file should have

 * @parent: a pointer to the parent dentry for this file.  This should be a

 *          directory dentry if set.  If this paramater is NULL, then the

 *          directory dentry if set.  If this parameter is %NULL, then the

 *          file will be created in the root of the debugfs filesystem.

 * @blob: a pointer to a struct debugfs_blob_wrapper which contains a pointer

 *        to the blob data and the size of the data.
@@ -282,11 +276,11 @@ static struct file_operations fops_blob = { 
 * This function will return a pointer to a dentry if it succeeds.  This

 * pointer must be passed to the debugfs_remove() function when the file is

 * to be removed (no automatic cleanup happens if your module is unloaded,

 * you are responsible here.)  If an error occurs, NULL will be returned.

 * you are responsible here.)  If an error occurs, %NULL will be returned.

 *

 * If debugfs is not enabled in the kernel, the value -ENODEV will be

 * If debugfs is not enabled in the kernel, the value -%ENODEV will be

 * returned.  It is not wise to check for this value, but rather, check for

 * NULL or !NULL instead as to eliminate the need for #ifdef in the calling

 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling

 * code.

 */

struct dentry *debugfs_create_blob(const char *name, mode_t mode,

fs/debugfs/inode.c

+6 −9
Original line number Diff line number Diff line
@@ -162,7 +162,6 @@ static int debugfs_create_by_name(const char *name, mode_t mode, 


/**

 * debugfs_create_file - create a file in the debugfs filesystem

 *

 * @name: a pointer to a string containing the name of the file to create.

 * @mode: the permission that the file should have

 * @parent: a pointer to the parent dentry for this file.  This should be a
@@ -182,11 +181,11 @@ static int debugfs_create_by_name(const char *name, mode_t mode, 
 * This function will return a pointer to a dentry if it succeeds.  This

 * pointer must be passed to the debugfs_remove() function when the file is

 * to be removed (no automatic cleanup happens if your module is unloaded,

 * you are responsible here.)  If an error occurs, NULL will be returned.

 * you are responsible here.)  If an error occurs, %NULL will be returned.

 *

 * If debugfs is not enabled in the kernel, the value -ENODEV will be

 * If debugfs is not enabled in the kernel, the value -%ENODEV will be

 * returned.  It is not wise to check for this value, but rather, check for

 * NULL or !NULL instead as to eliminate the need for #ifdef in the calling

 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling

 * code.

 */

struct dentry *debugfs_create_file(const char *name, mode_t mode,
@@ -221,7 +220,6 @@ EXPORT_SYMBOL_GPL(debugfs_create_file); 


/**

 * debugfs_create_dir - create a directory in the debugfs filesystem

 *

 * @name: a pointer to a string containing the name of the directory to

 *        create.

 * @parent: a pointer to the parent dentry for this file.  This should be a
@@ -233,11 +231,11 @@ EXPORT_SYMBOL_GPL(debugfs_create_file); 
 * This function will return a pointer to a dentry if it succeeds.  This

 * pointer must be passed to the debugfs_remove() function when the file is

 * to be removed (no automatic cleanup happens if your module is unloaded,

 * you are responsible here.)  If an error occurs, NULL will be returned.

 * you are responsible here.)  If an error occurs, %NULL will be returned.

 *

 * If debugfs is not enabled in the kernel, the value -ENODEV will be

 * If debugfs is not enabled in the kernel, the value -%ENODEV will be

 * returned.  It is not wise to check for this value, but rather, check for

 * NULL or !NULL instead as to eliminate the need for #ifdef in the calling

 * %NULL or !%NULL instead as to eliminate the need for #ifdef in the calling

 * code.

 */

struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
@@ -250,7 +248,6 @@ EXPORT_SYMBOL_GPL(debugfs_create_dir); 


/**

 * debugfs_remove - removes a file or directory from the debugfs filesystem

 *

 * @dentry: a pointer to a the dentry of the file or directory to be

 *          removed.

 *