Skip to content

Commit

Permalink
fs-verity: fix all kerneldoc warnings
Browse files Browse the repository at this point in the history
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: Eric Biggers <ebiggers@google.com>
  • Loading branch information
Eric Biggers committed May 12, 2020
1 parent 2ef96a5 commit 6377a38
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 1 deletion.
2 changes: 2 additions & 0 deletions fs/verity/enable.c
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,8 @@ static int enable_verity(struct file *filp,

/**
* 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.
Expand Down
2 changes: 1 addition & 1 deletion fs/verity/fsverity_private.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions fs/verity/measure.c
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions fs/verity/open.c
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down
3 changes: 3 additions & 0 deletions fs/verity/signature.c
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 3 additions & 0 deletions fs/verity/verify.c
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ static bool verify_page(struct inode *inode, const struct fsverity_info *vi,

/**
* fsverity_verify_page() - verify a data page
* @page: the page to verity
*
* Verify a page that has just been read from a verity file. The page must be a
* pagecache page that is still locked and not yet uptodate.
Expand Down Expand Up @@ -206,6 +207,7 @@ EXPORT_SYMBOL_GPL(fsverity_verify_page);
#ifdef CONFIG_BLOCK
/**
* fsverity_verify_bio() - verify a 'read' bio that has just completed
* @bio: the bio to verify
*
* Verify a set of pages that have just been read from a verity file. The pages
* must be pagecache pages that are still locked and not yet uptodate. Pages
Expand Down Expand Up @@ -264,6 +266,7 @@ EXPORT_SYMBOL_GPL(fsverity_verify_bio);

/**
* fsverity_enqueue_verify_work() - enqueue work on the fs-verity workqueue
* @work: the work to enqueue
*
* Enqueue verification work for asynchronous processing.
*/
Expand Down
3 changes: 3 additions & 0 deletions include/linux/fsverity.h
Original file line number Diff line number Diff line change
Expand Up @@ -200,13 +200,16 @@ static inline void fsverity_enqueue_verify_work(struct work_struct *work)

/**
* fsverity_active() - do reads from the inode need to go through fs-verity?
* @inode: inode to check
*
* This checks whether ->i_verity_info has been set.
*
* Filesystems call this from ->readpages() to check whether the pages need to
* be verified or not. Don't use IS_VERITY() for this purpose; it's subject to
* a race condition where the file is being read concurrently with
* FS_IOC_ENABLE_VERITY completing. (S_VERITY is set before ->i_verity_info.)
*
* Return: true if reads need to go through fs-verity, otherwise false
*/
static inline bool fsverity_active(const struct inode *inode)
{
Expand Down

0 comments on commit 6377a38

Please sign in to comment.