From mboxrd@z Thu Jan 1 00:00:00 1970 From: Tyler Hicks Subject: Re: [PATCH 26/31] fs: ecryptfs: main: Demote a bunch of non-conformant kernel-doc headers Date: Sun, 18 Apr 2021 12:19:02 -0500 Message-ID: <20210418171902.GB398325@elm> References: <20210330164458.1625478-1-lee.jones@linaro.org> <20210330164458.1625478-27-lee.jones@linaro.org> Mime-Version: 1.0 Return-path: Received: from lindbergh.monkeyblade.net ([23.128.96.19]:52704 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229783AbhDRRTd (ORCPT ); Sun, 18 Apr 2021 13:19:33 -0400 Received: from mail-oi1-x231.google.com (mail-oi1-x231.google.com [IPv6:2607:f8b0:4864:20::231]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 632ACC06174A for ; Sun, 18 Apr 2021 10:19:05 -0700 (PDT) Received: by mail-oi1-x231.google.com with SMTP id l17so1923969oil.11 for ; Sun, 18 Apr 2021 10:19:05 -0700 (PDT) Content-Disposition: inline In-Reply-To: <20210330164458.1625478-27-lee.jones@linaro.org> List-ID: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: Lee Jones Cc: linux-kernel@vger.kernel.org, Christian Brauner , James Morris , "Michael A. Halcrow" , "Michael C. Thompson" , ecryptfs@vger.kernel.org On 2021-03-30 17:44:53, Lee Jones wrote: > Fixes the following W=1 kernel build warning(s): > > fs/ecryptfs/main.c:28: warning: Incorrect use of kernel-doc format: * Module parameter that defines the ecryptfs_verbosity level. > fs/ecryptfs/main.c:30: warning: cannot understand function prototype: 'int ecryptfs_verbosity = 0; ' > fs/ecryptfs/main.c:40: warning: cannot understand function prototype: 'unsigned int ecryptfs_message_buf_len = ECRYPTFS_DEFAULT_MSG_CTX_ELEMS; ' > fs/ecryptfs/main.c:52: warning: cannot understand function prototype: 'signed long ecryptfs_message_wait_timeout = ECRYPTFS_MAX_MSG_CTX_TTL / HZ; ' > fs/ecryptfs/main.c:65: warning: cannot understand function prototype: 'unsigned int ecryptfs_number_of_users = ECRYPTFS_DEFAULT_NUM_USERS; ' > fs/ecryptfs/main.c:106: warning: Function parameter or member 'dentry' not described in 'ecryptfs_init_lower_file' > fs/ecryptfs/main.c:106: warning: Function parameter or member 'lower_file' not described in 'ecryptfs_init_lower_file' > fs/ecryptfs/main.c:106: warning: Excess function parameter 'ecryptfs_dentry' description in 'ecryptfs_init_lower_file' > fs/ecryptfs/main.c:244: warning: Function parameter or member 'sbi' not described in 'ecryptfs_parse_options' > fs/ecryptfs/main.c:244: warning: Excess function parameter 'sb' description in 'ecryptfs_parse_options' > fs/ecryptfs/main.c:478: warning: Function parameter or member 'fs_type' not described in 'ecryptfs_mount' > fs/ecryptfs/main.c:478: warning: Function parameter or member 'flags' not described in 'ecryptfs_mount' > fs/ecryptfs/main.c:478: warning: expecting prototype for ecryptfs_get_sb(). Prototype was for ecryptfs_mount() instead > fs/ecryptfs/main.c:645: warning: Function parameter or member 'vptr' not described in 'inode_info_init_once' > > Cc: Tyler Hicks > Cc: Christian Brauner > Cc: James Morris > Cc: "Michael A. Halcrow" > Cc: "Michael C. Thompson" > Cc: ecryptfs@vger.kernel.org > Signed-off-by: Lee Jones > --- > fs/ecryptfs/main.c | 20 +++++++++----------- > 1 file changed, 9 insertions(+), 11 deletions(-) > > diff --git a/fs/ecryptfs/main.c b/fs/ecryptfs/main.c > index cdf40a54a35d8..0a6ef2472f205 100644 > --- a/fs/ecryptfs/main.c > +++ b/fs/ecryptfs/main.c > @@ -1,5 +1,5 @@ > // SPDX-License-Identifier: GPL-2.0-or-later > -/** > +/* > * eCryptfs: Linux filesystem encryption layer > * > * Copyright (C) 1997-2003 Erez Zadok > @@ -24,7 +24,7 @@ > #include > #include "ecryptfs_kernel.h" > > -/** > +/* > * Module parameter that defines the ecryptfs_verbosity level. > */ > int ecryptfs_verbosity = 0; > @@ -34,7 +34,7 @@ MODULE_PARM_DESC(ecryptfs_verbosity, > "Initial verbosity level (0 or 1; defaults to " > "0, which is Quiet)"); > > -/** > +/* > * Module parameter that defines the number of message buffer elements > */ > unsigned int ecryptfs_message_buf_len = ECRYPTFS_DEFAULT_MSG_CTX_ELEMS; > @@ -43,7 +43,7 @@ module_param(ecryptfs_message_buf_len, uint, 0); > MODULE_PARM_DESC(ecryptfs_message_buf_len, > "Number of message buffer elements"); > > -/** > +/* > * Module parameter that defines the maximum guaranteed amount of time to wait > * for a response from ecryptfsd. The actual sleep time will be, more than > * likely, a small amount greater than this specified value, but only less if > @@ -57,7 +57,7 @@ MODULE_PARM_DESC(ecryptfs_message_wait_timeout, > "sleep while waiting for a message response from " > "userspace"); > > -/** > +/* > * Module parameter that is an estimate of the maximum number of users > * that will be concurrently using eCryptfs. Set this to the right > * value to balance performance and memory use. > @@ -80,7 +80,7 @@ void __ecryptfs_printk(const char *fmt, ...) > va_end(args); > } > > -/** > +/* > * ecryptfs_init_lower_file > * @ecryptfs_dentry: Fully initialized eCryptfs dentry object, with > * the lower dentry and the lower mount set > @@ -221,7 +221,7 @@ static void ecryptfs_init_mount_crypt_stat( > > /** > * ecryptfs_parse_options > - * @sb: The ecryptfs super block > + * @sbi: The ecryptfs super block > * @options: The options passed to the kernel > * @check_ruid: set to 1 if device uid should be checked against the ruid > * > @@ -466,10 +466,8 @@ static int ecryptfs_parse_options(struct ecryptfs_sb_info *sbi, char *options, > struct kmem_cache *ecryptfs_sb_info_cache; > static struct file_system_type ecryptfs_fs_type; > > -/** > +/* > * ecryptfs_get_sb > - * @fs_type > - * @flags This wasn't quite the right change. This function documentation block was for ecryptfs_mount(). It was probably ecryptfs_get_sb() in the past and the docs weren't updated. I've adjusted the function doc header and added descriptions for @fs_type and @flags. Tyler > * @dev_name: The path to mount over > * @raw_data: The options passed into the kernel > */ > @@ -635,7 +633,7 @@ static struct file_system_type ecryptfs_fs_type = { > }; > MODULE_ALIAS_FS("ecryptfs"); > > -/** > +/* > * inode_info_init_once > * > * Initializes the ecryptfs_inode_info_cache when it is created > -- > 2.27.0 >