Commit 6377a38b authored by Eric Biggers's avatar Eric Biggers
Browse files

fs-verity: fix all kerneldoc warnings 

Fix all kerneldoc warnings in fs/verity/ and include/linux/fsverity.h.
Most of these were due to missing documentation for function parameters.

Detected with:

    scripts/kernel-doc -v -none fs/verity/*.{c,h} include/linux/fsverity.h

This cleanup makes it possible to check new patches for kerneldoc
warnings without having to filter out all the existing ones.

Link: https://lore.kernel.org/r/20200511192118.71427-2-ebiggers@kernel.org


Signed-off-by: default avatarEric Biggers <ebiggers@google.com>
parent 2ef96a5b

fs/verity/enable.c

+2 −0
Original line number Diff line number Diff line
@@ -329,6 +329,8 @@ rollback: 


/**

 * fsverity_ioctl_enable() - enable verity on a file

 * @filp: file to enable verity on

 * @uarg: user pointer to fsverity_enable_arg

 *

 * Enable fs-verity on a file.  See the "FS_IOC_ENABLE_VERITY" section of

 * Documentation/filesystems/fsverity.rst for the documentation.

fs/verity/fsverity_private.h

+1 −1
Original line number Diff line number Diff line
@@ -61,7 +61,7 @@ struct merkle_tree_params { 
	u64 level_start[FS_VERITY_MAX_LEVELS];

};



/**

/*

 * fsverity_info - cached verity metadata for an inode

 *

 * When a verity file is first opened, an instance of this struct is allocated

fs/verity/measure.c

+2 −0
Original line number Diff line number Diff line
@@ -11,6 +11,8 @@ 


/**

 * fsverity_ioctl_measure() - get a verity file's measurement

 * @filp: file to get measurement of

 * @_uarg: user pointer to fsverity_digest

 *

 * Retrieve the file measurement that the kernel is enforcing for reads from a

 * verity file.  See the "FS_IOC_MEASURE_VERITY" section of

fs/verity/open.c

+1 −0
Original line number Diff line number Diff line
@@ -330,6 +330,7 @@ EXPORT_SYMBOL_GPL(fsverity_prepare_setattr); 


/**

 * fsverity_cleanup_inode() - free the inode's verity info, if present

 * @inode: an inode being evicted

 *

 * Filesystems must call this on inode eviction to free ->i_verity_info.

 */

fs/verity/signature.c

+3 −0
Original line number Diff line number Diff line
@@ -28,6 +28,9 @@ static struct key *fsverity_keyring; 


/**

 * fsverity_verify_signature() - check a verity file's signature

 * @vi: the file's fsverity_info

 * @desc: the file's fsverity_descriptor

 * @desc_size: size of @desc

 *

 * If the file's fs-verity descriptor includes a signature of the file

 * measurement, verify it against the certificates in the fs-verity keyring.

CRA Git | Maintained and supported by SUSTech CRA and CCSE