debugfs: document that debugfs_remove*() accepts NULL and error values

According to commit a59d6293e5 ("debugfs: change parameter check in
debugfs_remove() functions"), this is meant to make cleanup easier for
callers. In that case it ought to be documented.

Signed-off-by: Ulf Magnusson <ulfalizer@gmail.com>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
This commit is contained in:
Ulf Magnusson 2015-09-04 01:54:22 +02:00 committed by Jiri Kosina
parent b5ffe63442
commit 636db7a96c

View File

@ -533,7 +533,8 @@ static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
/** /**
* debugfs_remove - removes a file or directory from the debugfs filesystem * debugfs_remove - removes a file or directory from the debugfs filesystem
* @dentry: a pointer to a the dentry of the file or directory to be * @dentry: a pointer to a the dentry of the file or directory to be
* removed. * removed. If this parameter is NULL or an error value, nothing
* will be done.
* *
* This function removes a file or directory in debugfs that was previously * This function removes a file or directory in debugfs that was previously
* created with a call to another debugfs function (like * created with a call to another debugfs function (like
@ -565,7 +566,8 @@ EXPORT_SYMBOL_GPL(debugfs_remove);
/** /**
* debugfs_remove_recursive - recursively removes a directory * debugfs_remove_recursive - recursively removes a directory
* @dentry: a pointer to a the dentry of the directory to be removed. * @dentry: a pointer to a the dentry of the directory to be removed. If this
* parameter is NULL or an error value, nothing will be done.
* *
* This function recursively removes a directory tree in debugfs that * This function recursively removes a directory tree in debugfs that
* was previously created with a call to another debugfs function * was previously created with a call to another debugfs function