Skip to content

Commit a8fa658

Browse files
Yang Lirostedt
authored andcommitted
eventfs: Fix kernel-doc comments to functions
This commit fix kernel-doc style comments with complete parameter descriptions for the lookup_file(),lookup_dir_entry() and lookup_file_dentry(). Link: https://lore.kernel.org/linux-trace-kernel/[email protected] Signed-off-by: Yang Li <[email protected]> Signed-off-by: Steven Rostedt (Google) <[email protected]>
1 parent fec50db commit a8fa658

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

fs/tracefs/event_inode.c

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,7 @@ static void update_inode_attr(struct dentry *dentry, struct inode *inode,
336336

337337
/**
338338
* lookup_file - look up a file in the tracefs filesystem
339+
* @parent_ei: Pointer to the eventfs_inode that represents parent of the file
339340
* @dentry: the dentry to look up
340341
* @mode: the permission that the file should have.
341342
* @attr: saved attributes changed by user
@@ -389,6 +390,7 @@ static struct dentry *lookup_file(struct eventfs_inode *parent_ei,
389390
/**
390391
* lookup_dir_entry - look up a dir in the tracefs filesystem
391392
* @dentry: the directory to look up
393+
* @pei: Pointer to the parent eventfs_inode if available
392394
* @ei: the eventfs_inode that represents the directory to create
393395
*
394396
* This function will look up a dentry for a directory represented by
@@ -478,16 +480,20 @@ void eventfs_d_release(struct dentry *dentry)
478480

479481
/**
480482
* lookup_file_dentry - create a dentry for a file of an eventfs_inode
483+
* @dentry: The parent dentry under which the new file's dentry will be created
481484
* @ei: the eventfs_inode that the file will be created under
482485
* @idx: the index into the entry_attrs[] of the @ei
483-
* @parent: The parent dentry of the created file.
484-
* @name: The name of the file to create
485486
* @mode: The mode of the file.
486487
* @data: The data to use to set the inode of the file with on open()
487488
* @fops: The fops of the file to be created.
488489
*
489-
* Create a dentry for a file of an eventfs_inode @ei and place it into the
490-
* address located at @e_dentry.
490+
* This function creates a dentry for a file associated with an
491+
* eventfs_inode @ei. It uses the entry attributes specified by @idx,
492+
* if available. The file will have the specified @mode and its inode will be
493+
* set up with @data upon open. The file operations will be set to @fops.
494+
*
495+
* Return: Returns a pointer to the newly created file's dentry or an error
496+
* pointer.
491497
*/
492498
static struct dentry *
493499
lookup_file_dentry(struct dentry *dentry,

0 commit comments

Comments
 (0)