This series fixes the inadequacies in the return value descriptions in
nilfs2's kernel-doc comments (mainly incorrect formatting), as well as
the lack of return value descriptions themselves, and fixes most of
the remaining warnings that are output when the kernel-doc script is
run with the "-Wall" option.
Changes since v1 (in response to Brian G.'s comments):
- Fix typos in the comments. Plus, fix spell checker detections.
- Fix missing -ENOMEM in the return code list of nilfs_ioctl_set_suinfo().
- Ensure that the adjective "negative" is included for negative error
codes.
- Change the description style of return codes that list multiple error
codes to match "..., or one of the following negative error codes on
failure:" (applied across patches).
- Apply similar style adjustments to existing return code descriptions that
are not warned about by the kernel-doc script (patch 7/7).
The patch 7/7 is an addition, and the rest are revisions that correspond
one-to-one to the -v1 series.
Thanks,
Ryusuke Konishi
Ryusuke Konishi (7):
nilfs2: correct return value kernel-doc descriptions for ioctl
functions
nilfs2: correct return value kernel-doc descriptions for bmap
functions
nilfs2: correct return value kernel-doc descriptions for sufile
nilfs2: correct return value kernel-doc descriptions for metadata
files
nilfs2: correct return value kernel-doc descriptions for the rest
nilfs2: add missing return value kernel-doc descriptions
nilfs2: revise the return value description style for consistency.
fs/nilfs2/alloc.c | 67 +++++++++++-
fs/nilfs2/alloc.h | 2 +
fs/nilfs2/bmap.c | 124 ++++++++++------------
fs/nilfs2/btnode.c | 3 +-
fs/nilfs2/btree.c | 7 +-
fs/nilfs2/cpfile.c | 69 ++++++------
fs/nilfs2/dat.c | 45 ++++----
fs/nilfs2/gcinode.c | 24 ++---
fs/nilfs2/ifile.c | 37 ++++---
fs/nilfs2/inode.c | 16 ++-
fs/nilfs2/ioctl.c | 236 ++++++++++++++++++------------------------
fs/nilfs2/mdt.c | 63 ++++++-----
fs/nilfs2/page.c | 8 +-
fs/nilfs2/recovery.c | 62 +++++++----
fs/nilfs2/segbuf.c | 12 +--
fs/nilfs2/segment.c | 62 ++++++-----
fs/nilfs2/sufile.c | 112 +++++++++-----------
fs/nilfs2/sufile.h | 22 ++--
fs/nilfs2/super.c | 10 +-
fs/nilfs2/the_nilfs.c | 26 +++--
20 files changed, 507 insertions(+), 500 deletions(-)
--
2.43.0
