Commit ec037dfc authored by Julia Lawall's avatar Julia Lawall Committed by Richard Weinberger
Browse files

UBIFS: improve function-level documentation 

Fix various inconsistencies in the documentation associated with various
functions.

In the case of fs/ubifs/lprops.c, the second parameter of
ubifs_get_lp_stats was renamed from st to lst in commit 84abf972
("UBIFS: add re-mount debugging checks")

In the case of fs/ubifs/lpt_commit.c, the excess variables have never
existed in the associated functions since the code was introduced into the
kernel.

The others appear to be straightforward typos.

Issues detected using Coccinelle (http://coccinelle.lip6.fr/

)

Signed-off-by: default avatarJulia Lawall <Julia.Lawall@lip6.fr>
Signed-off-by: default avatarRichard Weinberger <richard@nod.at>
parent 74e9c700

fs/ubifs/file.c

+1 −1
Original line number Diff line number Diff line
@@ -1397,7 +1397,7 @@ int ubifs_update_time(struct inode *inode, struct timespec *time, 
#endif



/**

 * update_ctime - update mtime and ctime of an inode.

 * update_mctime - update mtime and ctime of an inode.

 * @inode: inode to update

 *

 * This function updates mtime and ctime of the inode if it is not equivalent to

fs/ubifs/gc.c

+1 −1
Original line number Diff line number Diff line
@@ -113,7 +113,7 @@ static int switch_gc_head(struct ubifs_info *c) 
 * data_nodes_cmp - compare 2 data nodes.

 * @priv: UBIFS file-system description object

 * @a: first data node

 * @a: second data node

 * @b: second data node

 *

 * This function compares data nodes @a and @b. Returns %1 if @a has greater

 * inode or block number, and %-1 otherwise.

fs/ubifs/lprops.c

+1 −1
Original line number Diff line number Diff line
@@ -636,7 +636,7 @@ const struct ubifs_lprops *ubifs_change_lp(struct ubifs_info *c, 
/**

 * ubifs_get_lp_stats - get lprops statistics.

 * @c: UBIFS file-system description object

 * @st: return statistics

 * @lst: return statistics

 */

void ubifs_get_lp_stats(struct ubifs_info *c, struct ubifs_lp_stats *lst)

{

fs/ubifs/lpt_commit.c

+1 −3
Original line number Diff line number Diff line
@@ -34,7 +34,6 @@ static int dbg_populate_lsave(struct ubifs_info *c); 


/**

 * first_dirty_cnode - find first dirty cnode.

 * @c: UBIFS file-system description object

 * @nnode: nnode at which to start

 *

 * This function returns the first dirty cnode or %NULL if there is not one.
@@ -1623,7 +1622,6 @@ static int dbg_is_node_dirty(struct ubifs_info *c, int node_type, int lnum, 
 * dbg_check_ltab_lnum - check the ltab for a LPT LEB number.

 * @c: the UBIFS file-system description object

 * @lnum: LEB number where node was written

 * @offs: offset where node was written

 *

 * This function returns %0 on success and a negative error code on failure.

 */
@@ -1870,7 +1868,7 @@ int dbg_chk_lpt_sz(struct ubifs_info *c, int action, int len) 
}



/**

 * ubifs_dump_lpt_leb - dump an LPT LEB.

 * dump_lpt_leb - dump an LPT LEB.

 * @c: UBIFS file-system description object

 * @lnum: LEB number to dump

 *

fs/ubifs/replay.c

+1 −1
Original line number Diff line number Diff line
@@ -267,7 +267,7 @@ static int apply_replay_entry(struct ubifs_info *c, struct replay_entry *r) 
 * replay_entries_cmp - compare 2 replay entries.

 * @priv: UBIFS file-system description object

 * @a: first replay entry

 * @a: second replay entry

 * @b: second replay entry

 *

 * This is a comparios function for 'list_sort()' which compares 2 replay

 * entries @a and @b by comparing their sequence numer.  Returns %1 if @a has

CRA Git | Maintained and supported by SUSTech CRA and CCSE