Commit 39986148 authored by Jeff Johnson's avatar Jeff Johnson Committed by Richard Weinberger
Browse files

ubifs: fix kernel-doc warnings 



make C=1 reports the following kernel-doc warnings:

fs/ubifs/compress.c:103: warning: Function parameter or struct member 'c' not described in 'ubifs_compress'
fs/ubifs/compress.c:155: warning: Function parameter or struct member 'c' not described in 'ubifs_decompress'
fs/ubifs/find.c:353: warning: Excess function parameter 'data' description in 'scan_for_free_cb'
fs/ubifs/find.c:353: warning: Function parameter or struct member 'arg' not described in 'scan_for_free_cb'
fs/ubifs/find.c:594: warning: Excess function parameter 'data' description in 'scan_for_idx_cb'
fs/ubifs/find.c:594: warning: Function parameter or struct member 'arg' not described in 'scan_for_idx_cb'
fs/ubifs/find.c:786: warning: Excess function parameter 'data' description in 'scan_dirty_idx_cb'
fs/ubifs/find.c:786: warning: Function parameter or struct member 'arg' not described in 'scan_dirty_idx_cb'
fs/ubifs/find.c:86: warning: Excess function parameter 'data' description in 'scan_for_dirty_cb'
fs/ubifs/find.c:86: warning: Function parameter or struct member 'arg' not described in 'scan_for_dirty_cb'
fs/ubifs/journal.c:369: warning: expecting prototype for wake_up_reservation(). Prototype was for add_or_start_queue() instead
fs/ubifs/lprops.c:1018: warning: Excess function parameter 'lst' description in 'scan_check_cb'
fs/ubifs/lprops.c:1018: warning: Function parameter or struct member 'arg' not described in 'scan_check_cb'
fs/ubifs/lpt.c:1938: warning: Function parameter or struct member 'ptr' not described in 'lpt_scan_node'
fs/ubifs/replay.c:60: warning: Function parameter or struct member 'hash' not described in 'replay_entry'

Fix them.

Signed-off-by: default avatarJeff Johnson <quic_jjohnson@quicinc.com>
Reviewed-by: default avatarZhihao Cheng <chengzhihao1@huawei.com>
Signed-off-by: default avatarRichard Weinberger <richard@nod.at>
parent 7037c96d

fs/ubifs/compress.c

+2 −0
Original line number Diff line number Diff line
@@ -82,6 +82,7 @@ struct ubifs_compressor *ubifs_compressors[UBIFS_COMPR_TYPES_CNT]; 


/**

 * ubifs_compress - compress data.

 * @c: UBIFS file-system description object

 * @in_buf: data to compress

 * @in_len: length of the data to compress

 * @out_buf: output buffer where compressed data should be stored
@@ -140,6 +141,7 @@ void ubifs_compress(const struct ubifs_info *c, const void *in_buf, 


/**

 * ubifs_decompress - decompress data.

 * @c: UBIFS file-system description object

 * @in_buf: data to decompress

 * @in_len: length of the data to decompress

 * @out_buf: output buffer where decompressed data should

fs/ubifs/find.c

+4 −4
Original line number Diff line number Diff line
@@ -73,7 +73,7 @@ static int valuable(struct ubifs_info *c, const struct ubifs_lprops *lprops) 
 * @c: the UBIFS file-system description object

 * @lprops: LEB properties to scan

 * @in_tree: whether the LEB properties are in main memory

 * @data: information passed to and from the caller of the scan

 * @arg: information passed to and from the caller of the scan

 *

 * This function returns a code that indicates whether the scan should continue

 * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
@@ -340,7 +340,7 @@ int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp, 
 * @c: the UBIFS file-system description object

 * @lprops: LEB properties to scan

 * @in_tree: whether the LEB properties are in main memory

 * @data: information passed to and from the caller of the scan

 * @arg: information passed to and from the caller of the scan

 *

 * This function returns a code that indicates whether the scan should continue

 * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
@@ -581,7 +581,7 @@ int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *offs, 
 * @c: the UBIFS file-system description object

 * @lprops: LEB properties to scan

 * @in_tree: whether the LEB properties are in main memory

 * @data: information passed to and from the caller of the scan

 * @arg: information passed to and from the caller of the scan

 *

 * This function returns a code that indicates whether the scan should continue

 * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
@@ -773,7 +773,7 @@ int ubifs_save_dirty_idx_lnums(struct ubifs_info *c) 
 * @c: the UBIFS file-system description object

 * @lprops: LEB properties to scan

 * @in_tree: whether the LEB properties are in main memory

 * @data: information passed to and from the caller of the scan

 * @arg: information passed to and from the caller of the scan

 *

 * This function returns a code that indicates whether the scan should continue

 * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree

fs/ubifs/journal.c

+1 −1
Original line number Diff line number Diff line
@@ -359,7 +359,7 @@ static void wake_up_reservation(struct ubifs_info *c) 
}



/**

 * wake_up_reservation - add current task in queue or start queuing.

 * add_or_start_queue - add current task in queue or start queuing.

 * @c: UBIFS file-system description object

 *

 * This function starts queuing if queuing is not started, otherwise adds

fs/ubifs/lprops.c

+1 −1
Original line number Diff line number Diff line
@@ -1005,7 +1005,7 @@ void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat, 
 * @c: the UBIFS file-system description object

 * @lp: LEB properties to scan

 * @in_tree: whether the LEB properties are in main memory

 * @lst: lprops statistics to update

 * @arg: lprops statistics to update

 *

 * This function returns a code that indicates whether the scan should continue

 * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree

fs/ubifs/lpt.c

+1 −0
Original line number Diff line number Diff line
@@ -1918,6 +1918,7 @@ int ubifs_lpt_init(struct ubifs_info *c, int rd, int wr) 
 * @pnode: where to keep a pnode

 * @cnode: where to keep a cnode

 * @in_tree: is the node in the tree in memory

 * @ptr: union of node pointers

 * @ptr.nnode: pointer to the nnode (if it is an nnode) which may be here or in

 * the tree

 * @ptr.pnode: ditto for pnode