Skip to content

Commit

Permalink
Documentation: debugfs: Document debugfs helper for unsigned long values
Browse files Browse the repository at this point in the history
When debugfs_create_ulong() was added, it was not documented.

Fixes: c23fe83 ("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>
  • Loading branch information
Geert Uytterhoeven authored and Jonathan Corbet committed Oct 24, 2019
1 parent dc5fcc5 commit 98919f4
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions Documentation/filesystems/debugfs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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,
Expand Down

0 comments on commit 98919f4

Please sign in to comment.