Skip to content

Commit ac8e9f6

Browse files
rddunlaprichardweinberger
authored andcommitted
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: Randy Dunlap <rdunlap@infradead.org> Reported-by: kernel 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: Zhihao Cheng <chengzhihao1@huawei.com> [rw: massaged patch to resolve conflict ] Signed-off-by: Richard Weinberger <richard@nod.at>
1 parent 2fe48aa commit ac8e9f6

1 file changed

Lines changed: 21 additions & 9 deletions

File tree

fs/ubifs/file.c

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -318,8 +318,9 @@ static int write_begin_slow(struct address_space *mapping,
318318
* This is a helper function for 'ubifs_write_begin()' which allocates budget
319319
* for the operation. The budget is allocated differently depending on whether
320320
* this is appending, whether the page is dirty or not, and so on. This
321-
* function leaves the @ui->ui_mutex locked in case of appending. Returns zero
322-
* in case of success and %-ENOSPC in case of failure.
321+
* function leaves the @ui->ui_mutex locked in case of appending.
322+
*
323+
* Returns: %0 in case of success and %-ENOSPC in case of failure.
323324
*/
324325
static int allocate_budget(struct ubifs_info *c, struct page *page,
325326
struct ubifs_inode *ui, int appending)
@@ -600,7 +601,7 @@ static int ubifs_write_end(struct file *file, struct address_space *mapping,
600601
* @bu: bulk-read information
601602
* @n: next zbranch slot
602603
*
603-
* This function returns %0 on success and a negative error code on failure.
604+
* Returns: %0 on success and a negative error code on failure.
604605
*/
605606
static int populate_page(struct ubifs_info *c, struct page *page,
606607
struct bu_info *bu, int *n)
@@ -711,7 +712,7 @@ static int populate_page(struct ubifs_info *c, struct page *page,
711712
* @bu: bulk-read information
712713
* @page1: first page to read
713714
*
714-
* This function returns %1 if the bulk-read is done, otherwise %0 is returned.
715+
* Returns: %1 if the bulk-read is done, otherwise %0 is returned.
715716
*/
716717
static int ubifs_do_bulk_read(struct ubifs_info *c, struct bu_info *bu,
717718
struct page *page1)
@@ -821,7 +822,9 @@ static int ubifs_do_bulk_read(struct ubifs_info *c, struct bu_info *bu,
821822
* Some flash media are capable of reading sequentially at faster rates. UBIFS
822823
* bulk-read facility is designed to take advantage of that, by reading in one
823824
* go consecutive data nodes that are also located consecutively in the same
824-
* LEB. This function returns %1 if a bulk-read is done and %0 otherwise.
825+
* LEB.
826+
*
827+
* Returns: %1 if a bulk-read is done and %0 otherwise.
825828
*/
826829
static int ubifs_bulk_read(struct page *page)
827830
{
@@ -1109,7 +1112,9 @@ static void do_attr_changes(struct inode *inode, const struct iattr *attr)
11091112
* @attr: inode attribute changes description
11101113
*
11111114
* This function implements VFS '->setattr()' call when the inode is truncated
1112-
* to a smaller size. Returns zero in case of success and a negative error code
1115+
* to a smaller size.
1116+
*
1117+
* Returns: %0 in case of success and a negative error code
11131118
* in case of failure.
11141119
*/
11151120
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,
12151220
* @attr: inode attribute changes description
12161221
*
12171222
* This function implements VFS '->setattr()' call for all cases except
1218-
* truncations to smaller size. Returns zero in case of success and a negative
1223+
* truncations to smaller size.
1224+
*
1225+
* Returns: %0 in case of success and a negative
12191226
* error code in case of failure.
12201227
*/
12211228
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)
13601367
* This helper function checks if the inode mtime/ctime should be updated or
13611368
* not. If current values of the time-stamps are within the UBIFS inode time
13621369
* granularity, they are not updated. This is an optimization.
1370+
*
1371+
* Returns: %1 if time update is needed, %0 if not
13631372
*/
13641373
static inline int mctime_update_needed(const struct inode *inode,
13651374
const struct timespec64 *now)
@@ -1375,11 +1384,12 @@ static inline int mctime_update_needed(const struct inode *inode,
13751384
/**
13761385
* ubifs_update_time - update time of inode.
13771386
* @inode: inode to update
1378-
* @time: timespec structure to hold the current time value
13791387
* @flags: time updating control flag determines updating
13801388
* which time fields of @inode
13811389
*
13821390
* This function updates time of the inode.
1391+
*
1392+
* Returns: %0 for success or a negative error code otherwise.
13831393
*/
13841394
int ubifs_update_time(struct inode *inode, int flags)
13851395
{
@@ -1413,7 +1423,9 @@ int ubifs_update_time(struct inode *inode, int flags)
14131423
* @inode: inode to update
14141424
*
14151425
* This function updates mtime and ctime of the inode if it is not equivalent to
1416-
* current time. Returns zero in case of success and a negative error code in
1426+
* current time.
1427+
*
1428+
* Returns: %0 in case of success and a negative error code in
14171429
* case of failure.
14181430
*/
14191431
static int update_mctime(struct inode *inode)

0 commit comments

Comments
 (0)