summaryrefslogtreecommitdiffstats
path: root/fs/debugfs
diff options
context:
space:
mode:
authorIvan Orlov <ivan.orlov0322@gmail.com>2023-05-14 21:23:53 +0400
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2023-05-31 19:02:14 +0100
commit266bff73451afb2c98541acac41386ef4f08bb5e (patch)
treec058ad52c08c53b78d20c56aa6309c081f589ffb /fs/debugfs
parent9e6aa7c22d0777da16cec0d056382c9bd181aa78 (diff)
downloadlinux-266bff73451afb2c98541acac41386ef4f08bb5e.tar.gz
linux-266bff73451afb2c98541acac41386ef4f08bb5e.tar.bz2
linux-266bff73451afb2c98541acac41386ef4f08bb5e.zip
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>
Diffstat (limited to 'fs/debugfs')
-rw-r--r--fs/debugfs/file.c9
1 files changed, 0 insertions, 9 deletions
diff --git a/fs/debugfs/file.c b/fs/debugfs/file.c
index 1f971c880dde..b7711888dd17 100644
--- a/fs/debugfs/file.c
+++ b/fs/debugfs/file.c
@@ -940,15 +940,6 @@ static const struct file_operations fops_str_wo = {
* This function creates a file in debugfs with the given name that
* contains the value of the variable @value. If the @mode variable is so
* set, it can be read from, and written to.
- *
- * This function will return a pointer to a dentry if it succeeds. This
- * pointer must be passed to the debugfs_remove() function when the file is
- * to be removed (no automatic cleanup happens if your module is unloaded,
- * you are responsible here.) If an error occurs, ERR_PTR(-ERROR) will be
- * returned.
- *
- * If debugfs is not enabled in the kernel, the value ERR_PTR(-ENODEV) will
- * be returned.
*/
void debugfs_create_str(const char *name, umode_t mode,
struct dentry *parent, char **value)