Documentation: debugfs: Document debugfs helper for unsigned long values
authorGeert Uytterhoeven <geert+renesas@glider.be>
Mon, 21 Oct 2019 15:06:45 +0000 (17:06 +0200)
committerJonathan Corbet <corbet@lwn.net>
Thu, 24 Oct 2019 18:04:31 +0000 (12:04 -0600)
When debugfs_create_ulong() was added, it was not documented.

Fixes: c23fe83138ed7b11 ("debugfs: Add debugfs_create_ulong()")
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Acked-by: Viresh Kumar <viresh.kumar@linaro.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/filesystems/debugfs.txt

index 9e27c843d00ea0602e391f760c05764066a544c0..2ca99152cb6ed7a6dde51e36be20ebf1f29af7c3 100644 (file)
@@ -93,8 +93,8 @@ the following functions can be used instead:
 
 These functions are useful as long as the developer knows the size of the
 value to be exported.  Some types can have different widths on different
-architectures, though, complicating the situation somewhat.  There is a
-function meant to help out in one special case:
+architectures, though, complicating the situation somewhat.  There are
+functions meant to help out in such special cases:
 
     struct dentry *debugfs_create_size_t(const char *name, umode_t mode,
                                         struct dentry *parent, 
@@ -103,6 +103,12 @@ function meant to help out in one special case:
 As might be expected, this function will create a debugfs file to represent
 a variable of type size_t.
 
+Similarly, there is a helper for variables of type unsigned long:
+
+    struct dentry *debugfs_create_ulong(const char *name, umode_t mode,
+                                       struct dentry *parent,
+                                       unsigned long *value);
+
 Boolean values can be placed in debugfs with:
 
     struct dentry *debugfs_create_bool(const char *name, umode_t mode,