Skip to content

Commit 266bff7

Browse files
ivanorlov2206gregkh
authored andcommitted
debugfs: Correct the 'debugfs_create_str' docs
The documentation of the 'debugfs_create_str' says that the function returns a pointer to a dentry created, or an ERR_PTR in case of error. Actually, this is not true: this function doesn't return anything at all. Correct the documentation correspondingly. Signed-off-by: Ivan Orlov <ivan.orlov0322@gmail.com> Link: https://lore.kernel.org/r/20230514172353.52878-1-ivan.orlov0322@gmail.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parent 9e6aa7c commit 266bff7

1 file changed

Lines changed: 0 additions & 9 deletions

File tree

fs/debugfs/file.c

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -940,15 +940,6 @@ static const struct file_operations fops_str_wo = {
940940
* This function creates a file in debugfs with the given name that
941941
* contains the value of the variable @value. If the @mode variable is so
942942
* set, it can be read from, and written to.
943-
*
944-
* This function will return a pointer to a dentry if it succeeds. This
945-
* pointer must be passed to the debugfs_remove() function when the file is
946-
* to be removed (no automatic cleanup happens if your module is unloaded,
947-
* you are responsible here.) If an error occurs, ERR_PTR(-ERROR) will be
948-
* returned.
949-
*
950-
* If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
951-
* be returned.
952943
*/
953944
void debugfs_create_str(const char *name, umode_t mode,
954945
struct dentry *parent, char **value)

0 commit comments

Comments
 (0)