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

Commit e6716b87 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

docbook: fix filesystems content 



Fix filesystems docbook warnings.

Warning(linux-2.6.23-git8//fs/debugfs/file.c:241): No description found for parameter 'name'
Warning(linux-2.6.23-git8//fs/debugfs/file.c:241): No description found for parameter 'mode'
Warning(linux-2.6.23-git8//fs/debugfs/file.c:241): No description found for parameter 'parent'
Warning(linux-2.6.23-git8//fs/debugfs/file.c:241): No description found for parameter 'value'
Warning(linux-2.6.23-git8//include/linux/jbd.h:404): No description found for parameter 'h_lockdep_map'

Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent fd39c86b

fs/debugfs/file.c

+35 −6
Original line number Diff line number Diff line
@@ -227,15 +227,24 @@ DEFINE_SIMPLE_ATTRIBUTE(fops_x16, debugfs_u16_get, debugfs_u16_set, "0x%04llx\n" 


DEFINE_SIMPLE_ATTRIBUTE(fops_x32, debugfs_u32_get, debugfs_u32_set, "0x%08llx\n");



/**

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

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

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

/*

 * debugfs_create_x{8,16,32} - create a debugfs file that is used to read and write an unsigned {8,16,32}-bit value

 *

 * These functions are exactly the same as the above functions, (but use a hex

 * output for the decimal challenged) for details look at the above unsigned

 * These functions are exactly the same as the above functions (but use a hex

 * output for the decimal challenged). For details look at the above unsigned

 * decimal functions.

 */



/**

 * debugfs_create_x8 - 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 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.

 */

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

				 struct dentry *parent, u8 *value)

{
@@ -243,6 +252,16 @@ struct dentry *debugfs_create_x8(const char *name, mode_t mode, 
}

EXPORT_SYMBOL_GPL(debugfs_create_x8);



/**

 * debugfs_create_x16 - 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 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.

 */

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

				 struct dentry *parent, u16 *value)

{
@@ -250,6 +269,16 @@ struct dentry *debugfs_create_x16(const char *name, mode_t mode, 
}

EXPORT_SYMBOL_GPL(debugfs_create_x16);



/**

 * debugfs_create_x32 - 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 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.

 */

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

				 struct dentry *parent, u32 *value)

{

include/linux/jbd.h

+1 −0
Original line number Diff line number Diff line
@@ -372,6 +372,7 @@ struct jbd_revoke_table_s; 
 * @h_sync: flag for sync-on-close

 * @h_jdata: flag to force data journaling

 * @h_aborted: flag indicating fatal error on handle

 * @h_lockdep_map: lockdep info for debugging lock problems

 **/



/* Docbook can't yet cope with the bit fields, but will leave the documentation