[PATCH] kernfs: update comment about kernfs_path() return value

[PATCH] kernfs: update comment about kernfs_path() return value

[Konstantin Khlebnikov]

Now it returns the length of the full path or error code.

Signed-off-by: Konstantin Khlebnikov <khlebnikov@yandex-team.ru>
Fixes: 3abb1d90f5d9 ("kernfs: make kernfs_path*() behave in the style of strlcpy()")
---
 include/linux/kernfs.h |    9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/include/linux/kernfs.h b/include/linux/kernfs.h
index ab25c8b6d9e3..0174ec25950e 100644
--- a/include/linux/kernfs.h
+++ b/include/linux/kernfs.h
@@ -472,10 +472,11 @@ static inline void kernfs_init(void) { }
  * @buf: buffer to copy @kn's name into
  * @buflen: size of @buf
  *
- * Builds and returns the full path of @kn in @buf of @buflen bytes.  The
- * path is built from the end of @buf so the returned pointer usually
- * doesn't match @buf.  If @buf isn't long enough, @buf is nul terminated
- * and %NULL is returned.
+ * If @kn is NULL result will be "(null)".
+ *
+ * Returns the length of the full path.  If the full length is equal to or
+ * greater than @buflen, @buf contains the truncated path with the trailing
+ * '\0'.  On error, -errno is returned.
  */
 static inline int kernfs_path(struct kernfs_node *kn, char *buf, size_t buflen)
 {

Re: [PATCH] kernfs: update comment about kernfs_path() return value

[Tejun Heo]

On Mon, Aug 13, 2018 at 09:52:09AM +0300, Konstantin Khlebnikov wrote:
> Now it returns the length of the full path or error code.
> 
> Signed-off-by: Konstantin Khlebnikov <khlebnikov@yandex-team.ru>
> Fixes: 3abb1d90f5d9 ("kernfs: make kernfs_path*() behave in the style of strlcpy()")

Acked-by: Tejun Heo <tj@kernel.org>

Thanks.

-- 
tejun