tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

nilfs2: fix missing initial short descriptions of kernel-doc comments

Update some kernel-doc comments that are missing the initial short
description and fix the following warnings output by the kernel-doc
script:

fs/nilfs2/bmap.c:353: warning: missing initial short description on line:
* nilfs_bmap_lookup_dirty_buffers -
fs/nilfs2/cpfile.c:708: warning: missing initial short description on line:
* nilfs_cpfile_delete_checkpoint -
fs/nilfs2/cpfile.c:972: warning: missing initial short description on line:
* nilfs_cpfile_is_snapshot -
fs/nilfs2/dat.c:275: warning: missing initial short description on line:
* nilfs_dat_mark_dirty -
fs/nilfs2/sufile.c:844: warning: missing initial short description on line:
* nilfs_sufile_get_suinfo -

Link: https://lkml.kernel.org/r/20240816074319.3253-9-konishi.ryusuke@gmail.com
Signed-off-by: Ryusuke Konishi <konishi.ryusuke@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>

authored by

Ryusuke Konishi and committed by
Andrew Morton caaab566 7876bc1b

+32 -39
+1 -1
fs/nilfs2/bmap.c
··· 349 349 } 350 350 351 351 /** 352 - * nilfs_bmap_lookup_dirty_buffers - 352 + * nilfs_bmap_lookup_dirty_buffers - collect dirty block buffers 353 353 * @bmap: bmap 354 354 * @listp: pointer to buffer head list 355 355 */
+16 -16
fs/nilfs2/cpfile.c
··· 704 704 } 705 705 706 706 /** 707 - * nilfs_cpfile_delete_checkpoint - 708 - * @cpfile: 709 - * @cno: 707 + * nilfs_cpfile_delete_checkpoint - delete a checkpoint 708 + * @cpfile: checkpoint file inode 709 + * @cno: checkpoint number to delete 710 + * 711 + * Return: 0 on success, or the following negative error code on failure. 712 + * * %-EBUSY - Checkpoint in use (snapshot specified). 713 + * * %-EIO - I/O error (including metadata corruption). 714 + * * %-ENOENT - No valid checkpoint found. 715 + * * %-ENOMEM - Insufficient memory available. 710 716 */ 711 717 int nilfs_cpfile_delete_checkpoint(struct inode *cpfile, __u64 cno) 712 718 { ··· 974 968 } 975 969 976 970 /** 977 - * nilfs_cpfile_is_snapshot - 971 + * nilfs_cpfile_is_snapshot - determine if checkpoint is a snapshot 978 972 * @cpfile: inode of checkpoint file 979 - * @cno: checkpoint number 973 + * @cno: checkpoint number 980 974 * 981 - * Description: 982 - * 983 - * Return Value: On success, 1 is returned if the checkpoint specified by 984 - * @cno is a snapshot, or 0 if not. On error, one of the following negative 985 - * error codes is returned. 986 - * 987 - * %-EIO - I/O error. 988 - * 989 - * %-ENOMEM - Insufficient amount of memory available. 990 - * 991 - * %-ENOENT - No such checkpoint. 975 + * Return: 1 if the checkpoint specified by @cno is a snapshot, 0 if not, or 976 + * the following negative error code on failure. 977 + * * %-EIO - I/O error (including metadata corruption). 978 + * * %-ENOENT - No such checkpoint. 979 + * * %-ENOMEM - Insufficient memory available. 992 980 */ 993 981 int nilfs_cpfile_is_snapshot(struct inode *cpfile, __u64 cno) 994 982 {
+7 -10
fs/nilfs2/dat.c
··· 271 271 } 272 272 273 273 /** 274 - * nilfs_dat_mark_dirty - 275 - * @dat: DAT file inode 274 + * nilfs_dat_mark_dirty - mark the DAT block buffer containing the specified 275 + * virtual block address entry as dirty 276 + * @dat: DAT file inode 276 277 * @vblocknr: virtual block number 277 278 * 278 - * Description: 279 - * 280 - * Return Value: On success, 0 is returned. On error, one of the following 281 - * negative error codes is returned. 282 - * 283 - * %-EIO - I/O error. 284 - * 285 - * %-ENOMEM - Insufficient amount of memory available. 279 + * Return: 0 on success, or the following negative error code on failure. 280 + * * %-EINVAL - Invalid DAT entry (internal code). 281 + * * %-EIO - I/O error (including metadata corruption). 282 + * * %-ENOMEM - Insufficient memory available. 286 283 */ 287 284 int nilfs_dat_mark_dirty(struct inode *dat, __u64 vblocknr) 288 285 {
+8 -12
fs/nilfs2/sufile.c
··· 840 840 } 841 841 842 842 /** 843 - * nilfs_sufile_get_suinfo - 843 + * nilfs_sufile_get_suinfo - get segment usage information 844 844 * @sufile: inode of segment usage file 845 845 * @segnum: segment number to start looking 846 - * @buf: array of suinfo 847 - * @sisz: byte size of suinfo 848 - * @nsi: size of suinfo array 846 + * @buf: array of suinfo 847 + * @sisz: byte size of suinfo 848 + * @nsi: size of suinfo array 849 849 * 850 - * Description: 851 - * 852 - * Return Value: On success, 0 is returned and .... On error, one of the 853 - * following negative error codes is returned. 854 - * 855 - * %-EIO - I/O error. 856 - * 857 - * %-ENOMEM - Insufficient amount of memory available. 850 + * Return: Count of segment usage info items stored in the output buffer on 851 + * success, or the following negative error code on failure. 852 + * * %-EIO - I/O error (including metadata corruption). 853 + * * %-ENOMEM - Insufficient memory available. 858 854 */ 859 855 ssize_t nilfs_sufile_get_suinfo(struct inode *sufile, __u64 segnum, void *buf, 860 856 unsigned int sisz, size_t nsi)