Commit ac8e9f64 authored by Randy Dunlap's avatar Randy Dunlap Committed by Richard Weinberger
Browse files

ubifs: fix kernel-doc warnings 



Fix kernel-doc warnings found when using "W=1".

file.c:1385: warning: Excess function parameter 'time' description in 'ubifs_update_time'
and 9 warnings like this one:
file.c:326: warning: No description found for return value of 'allocate_budget'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reported-by: default avatarkernel test robot <lkp@intel.com>
Link: https://lore.kernel.org/oe-kbuild-all/202312030417.66c5PwHj-lkp@intel.com/


Cc: Richard Weinberger <richard@nod.at>
Cc: linux-mtd@lists.infradead.org
Reviewed-by: default avatarZhihao Cheng <chengzhihao1@huawei.com>
[rw: massaged patch to resolve conflict ]
Signed-off-by: default avatarRichard Weinberger <richard@nod.at>
parent 2fe48aaa

fs/ubifs/file.c

+21 −9
Original line number Diff line number Diff line
@@ -318,8 +318,9 @@ static int write_begin_slow(struct address_space *mapping, 
 * This is a helper function for 'ubifs_write_begin()' which allocates budget

 * for the operation. The budget is allocated differently depending on whether

 * this is appending, whether the page is dirty or not, and so on. This

 * function leaves the @ui->ui_mutex locked in case of appending. Returns zero

 * in case of success and %-ENOSPC in case of failure.

 * function leaves the @ui->ui_mutex locked in case of appending.

 *

 * Returns: %0 in case of success and %-ENOSPC in case of failure.

 */

static int allocate_budget(struct ubifs_info *c, struct page *page,

			   struct ubifs_inode *ui, int appending)
@@ -600,7 +601,7 @@ static int ubifs_write_end(struct file *file, struct address_space *mapping, 
 * @bu: bulk-read information

 * @n: next zbranch slot

 *

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

 * Returns: %0 on success and a negative error code on failure.

 */

static int populate_page(struct ubifs_info *c, struct page *page,

			 struct bu_info *bu, int *n)
@@ -711,7 +712,7 @@ static int populate_page(struct ubifs_info *c, struct page *page, 
 * @bu: bulk-read information

 * @page1: first page to read

 *

 * This function returns %1 if the bulk-read is done, otherwise %0 is returned.

 * Returns: %1 if the bulk-read is done, otherwise %0 is returned.

 */

static int ubifs_do_bulk_read(struct ubifs_info *c, struct bu_info *bu,

			      struct page *page1)
@@ -821,7 +822,9 @@ static int ubifs_do_bulk_read(struct ubifs_info *c, struct bu_info *bu, 
 * Some flash media are capable of reading sequentially at faster rates. UBIFS

 * bulk-read facility is designed to take advantage of that, by reading in one

 * go consecutive data nodes that are also located consecutively in the same

 * LEB. This function returns %1 if a bulk-read is done and %0 otherwise.

 * LEB.

 *

 * Returns: %1 if a bulk-read is done and %0 otherwise.

 */

static int ubifs_bulk_read(struct page *page)

{
@@ -1109,7 +1112,9 @@ static void do_attr_changes(struct inode *inode, const struct iattr *attr) 
 * @attr: inode attribute changes description

 *

 * This function implements VFS '->setattr()' call when the inode is truncated

 * to a smaller size. Returns zero in case of success and a negative error code

 * to a smaller size.

 *

 * Returns: %0 in case of success and a negative error code

 * in case of failure.

 */

static int do_truncation(struct ubifs_info *c, struct inode *inode,
@@ -1215,7 +1220,9 @@ static int do_truncation(struct ubifs_info *c, struct inode *inode, 
 * @attr: inode attribute changes description

 *

 * This function implements VFS '->setattr()' call for all cases except

 * truncations to smaller size. Returns zero in case of success and a negative

 * truncations to smaller size.

 *

 * Returns: %0 in case of success and a negative

 * error code in case of failure.

 */

static int do_setattr(struct ubifs_info *c, struct inode *inode,
@@ -1360,6 +1367,8 @@ int ubifs_fsync(struct file *file, loff_t start, loff_t end, int datasync) 
 * This helper function checks if the inode mtime/ctime should be updated or

 * not. If current values of the time-stamps are within the UBIFS inode time

 * granularity, they are not updated. This is an optimization.

 *

 * Returns: %1 if time update is needed, %0 if not

 */

static inline int mctime_update_needed(const struct inode *inode,

				       const struct timespec64 *now)
@@ -1375,11 +1384,12 @@ static inline int mctime_update_needed(const struct inode *inode, 
/**

 * ubifs_update_time - update time of inode.

 * @inode: inode to update

 * @time:  timespec structure to hold the current time value

 * @flags: time updating control flag determines updating

 *	    which time fields of @inode

 *

 * This function updates time of the inode.

 *

 * Returns: %0 for success or a negative error code otherwise.

 */

int ubifs_update_time(struct inode *inode, int flags)

{
@@ -1413,7 +1423,9 @@ int ubifs_update_time(struct inode *inode, int flags) 
 * @inode: inode to update

 *

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

 * current time. Returns zero in case of success and a negative error code in

 * current time.

 *

 * Returns: %0 in case of success and a negative error code in

 * case of failure.

 */

static int update_mctime(struct inode *inode)