.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "DEBUGFS_CREATE_BOOL" "9" "09 October 2005" "" ""

.SH NAME
debugfs_create_bool \- create a file in the debugfs filesystem that is used to read and write a boolean value.
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
struct dentry * debugfs_create_bool  (const char * \fIname\fB, mode_t \fImode\fB, struct dentry * \fIparent\fB, u32 * \fIvalue\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIname\fB\fR
a pointer to a string containing the name of the file to create.
.TP
\fB\fImode\fB\fR
the permission that the file should have
.TP
\fB\fIparent\fB\fR
a pointer to the parent dentry for this file.  This should be a
directory dentry if set.  If this paramater is NULL, then the
file will be created in the root of the debugfs filesystem.
.TP
\fB\fIvalue\fB\fR
a pointer to the variable that the file should read to and write
from.
.SH "DESCRIPTION"
.PP
This function creates a file in debugfs with the given name that
contains the value of the variable \fIvalue\fR\&.  If the \fImode\fR variable is so
set, it can be read from, and written to.
.PP
This function will return a pointer to a dentry if it succeeds.  This
pointer must be passed to the \fBdebugfs_remove\fR 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, NULL will be returned.
.PP
If debugfs is not enabled in the kernel, the value -ENODEV will be
returned.  It is not wise to check for this value, but rather, check for
NULL or !NULL instead as to eliminate the need for #ifdef in the calling
code.
.SH "DESCRIPTION"
.PP
This function creates a file in debugfs with the given name that
contains the value of the variable \fIvalue\fR\&.  If the \fImode\fR variable is so
set, it can be read from, and written to.
.PP
This function will return a pointer to a dentry if it succeeds.  This
pointer must be passed to the \fBdebugfs_remove\fR 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, NULL will be returned.
.PP
If debugfs is not enabled in the kernel, the value -ENODEV will be
returned.  It is not wise to check for this value, but rather, check for
NULL or !NULL instead as to eliminate the need for #ifdef in the calling
code.