[PATCH 1/3] debugfs: update comment of debugfs_rename()

From: Qi Zheng <zhengqi.arch@bytedance.com>
To: gregkh@linuxfoundation.org, rafael@kernel.org,
	j.vosburgh@gmail.com, vfalico@gmail.com, andy@greyhouse.net,
	vireshk@kernel.org, nm@ti.com, sboyd@kernel.org
Cc: linux-kernel@vger.kernel.org, linux-pm@vger.kernel.org,
	netdev@vger.kernel.org, Qi Zheng <zhengqi.arch@bytedance.com>
Subject: [PATCH 1/3] debugfs: update comment of debugfs_rename()
Date: Thu,  2 Feb 2023 17:32:54 +0800	[thread overview]
Message-ID: <20230202093256.32458-2-zhengqi.arch@bytedance.com> (raw)
In-Reply-To: <20230202093256.32458-1-zhengqi.arch@bytedance.com>

Since commit ff9fb72bc077 ("debugfs: return error values,
not NULL") changed return value of debugfs_rename() in
error cases from %NULL to %ERR_PTR(-ERROR), the comment
of debugfs_rename should also be updated so as not to
mislead readers.

Signed-off-by: Qi Zheng <zhengqi.arch@bytedance.com>
---
 fs/debugfs/inode.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/fs/debugfs/inode.c b/fs/debugfs/inode.c
index 2e8e112b1993..58a35afb7c5d 100644
--- a/fs/debugfs/inode.c
+++ b/fs/debugfs/inode.c
@@ -802,8 +802,8 @@ EXPORT_SYMBOL_GPL(debugfs_lookup_and_remove);
  * exist for rename to succeed.
  *
  * This function will return a pointer to old_dentry (which is updated to
- * reflect renaming) if it succeeds. If an error occurs, %NULL will be
- * returned.
+ * reflect renaming) if it succeeds. If an error occurs, %ERR_PTR(-ERROR)
+ * will be returned.
  *
  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
  * returned.
-- 
2.20.1

