Re: [PATCH v2] vfs: fix docstring of hash_name()

[Jan Kara <jack@suse.cz>]

On Wed 18-03-26 21:39:52, Jori Koolstra wrote:
> The docstring of hash_name() is falsely reporting that it returns the
> component length, whereas it returns a pointer to the terminating '/'
> or NUL character in the pathname being resolved.
> 
> Signed-off-by: Jori Koolstra <jkoolstra@xs4all.nl>

Looks good. Feel free to add:

Reviewed-by: Jan Kara <jack@suse.cz>

								Honza

> ---
>  fs/namei.c | 10 ++++++++--
>  1 file changed, 8 insertions(+), 2 deletions(-)
> 
> diff --git a/fs/namei.c b/fs/namei.c
> index 58f715f7657e..9e5500dad14f 100644
> --- a/fs/namei.c
> +++ b/fs/namei.c
> @@ -2437,8 +2437,14 @@ u64 hashlen_string(const void *salt, const char *name)
>  EXPORT_SYMBOL(hashlen_string);
>  
>  /*
> - * Calculate the length and hash of the path component, and
> - * return the length as the result.
> + * hash_name - Calculate the length and hash of the path component
> + * @nd: the path resolution state
> + * @name: the pathname to read the component from
> + * @lastword: if the component fits in a single word, LAST_WORD_IS_DOT,
> + * LAST_WORD_IS_DOTDOT, or some other value depending on whether the
> + * component is '.', '..', or something else. Otherwise, @lastword is 0.
> + *
> + * Returns: a pointer to the terminating '/' or NUL character in @name.
>   */
>  static inline const char *hash_name(struct nameidata *nd,
>  				    const char *name,
> -- 
> 2.53.0
> 
-- 
Jan Kara <jack@suse.com>
SUSE Labs, CR