From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Tyler Hicks <code@tyhicks.com>,
Christian Brauner <christian.brauner@ubuntu.com>,
James Morris <jamorris@linux.microsoft.com>,
"Michael A. Halcrow" <mahalcro@us.ibm.com>,
"Michael C. Thompson" <mcthomps@us.ibm.com>,
ecryptfs@vger.kernel.org
Subject: [PATCH 26/31] fs: ecryptfs: main: Demote a bunch of non-conformant kernel-doc headers
Date: Tue, 30 Mar 2021 17:44:53 +0100 [thread overview]
Message-ID: <20210330164458.1625478-27-lee.jones@linaro.org> (raw)
In-Reply-To: <20210330164458.1625478-1-lee.jones@linaro.org>
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 <code@tyhicks.com>
Cc: Christian Brauner <christian.brauner@ubuntu.com>
Cc: James Morris <jamorris@linux.microsoft.com>
Cc: "Michael A. Halcrow" <mahalcro@us.ibm.com>
Cc: "Michael C. Thompson" <mcthomps@us.ibm.com>
Cc: ecryptfs@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
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 <linux/magic.h>
#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
* @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
next prev parent reply other threads:[~2021-03-30 16:46 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-30 16:44 [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Lee Jones
2021-03-30 16:44 ` [PATCH 01/31] fs: gfs2: dir: Finish off mostly complete headers demote others Lee Jones
2021-03-30 16:44 ` [PATCH 02/31] fs: gfs2: xattr: Help out some kernel-doc header demote non-conformant ones Lee Jones
2021-03-30 16:44 ` [PATCH 03/31] fs: gfs2: bmap: Demote half-complete kernel-doc headers fix others Lee Jones
2021-03-30 16:44 ` [PATCH 04/31] fs: gfs2: glops: Fix a couple of kernel-doc misdemeanours demote others Lee Jones
2021-03-30 16:44 ` [PATCH 05/31] fs: gfs2: log: Fix a couple of param descriptions and demote non-conformant headers Lee Jones
2021-03-30 16:44 ` [PATCH 06/31] fs: gfs2: lops: Help out worthy kernel-doc headers and demote others Lee Jones
2021-03-30 16:44 ` [PATCH 07/31] fs: gfs2: glock: Fix some deficient kernel-doc headers and demote non-conformant ones Lee Jones
2021-03-30 16:44 ` [PATCH 08/31] fs: gfs2: aops: Fix a little potential doc-rot Lee Jones
2021-03-30 16:44 ` [PATCH 09/31] fs: gfs2: meta_io: Add missing description for 'rahead' param Lee Jones
2021-03-30 16:44 ` [PATCH 10/31] fs: gfs2: inode: Fix worthy function headers demote others Lee Jones
2021-03-30 16:44 ` [PATCH 11/31] fs: gfs2: file: Strip out superfluous param description and demote kernel-doc abuse Lee Jones
2021-03-30 16:44 ` [PATCH 12/31] fs: gfs2: ops_fstype: Fix a little doc-rot Lee Jones
2021-03-30 16:44 ` [PATCH 13/31] fs: gfs2: quota: Fix incorrect param name in 'gfs2_quotad' Lee Jones
2021-03-30 16:44 ` [PATCH 14/31] fs: gfs2: rgrp: Fix a few kernel-doc misdemeanours Lee Jones
2021-03-30 16:44 ` [PATCH 15/31] fs: gfs2: recovery: Provide missing param descriptions and remove one other Lee Jones
2021-03-30 16:44 ` [PATCH 16/31] fs: gfs2: super: Fix kernel-doc issues where feasible demote " Lee Jones
2021-03-30 16:44 ` [PATCH 17/31] fs: gfs2: util: Fix one conformant kernel-doc header and demote a bunch of abuses Lee Jones
2021-03-30 16:44 ` [PATCH 18/31] fs: gfs2: lock_dlm: Demote incomplete kernel-doc header Lee Jones
2021-03-30 16:44 ` [PATCH 19/31] fs: ecryptfs: read_write: File headers do not make good candidates for kernel-doc Lee Jones
2021-03-30 16:44 ` [PATCH 20/31] fs: ecryptfs: debug: Demote a couple of kernel-doc abuses Lee Jones
2021-03-30 16:44 ` [PATCH 21/31] fs: ecryptfs: dentry: File headers are not good candidates for kernel-doc Lee Jones
2021-03-30 16:44 ` [PATCH 22/31] fs: ecryptfs: kthread: Demote file header and provide description for 'cred' Lee Jones
2021-03-30 16:44 ` [PATCH 23/31] fs: ecryptfs: file: Demote kernel-doc abuses Lee Jones
2021-03-30 16:44 ` [PATCH 24/31] fs: ecryptfs: super: Fix formatting, naming and " Lee Jones
2021-03-30 16:44 ` [PATCH 25/31] fs: ecryptfs: messaging: Add missing param descriptions and demote abuses Lee Jones
2021-03-30 16:44 ` Lee Jones [this message]
2021-04-18 17:19 ` [PATCH 26/31] fs: ecryptfs: main: Demote a bunch of non-conformant kernel-doc headers Tyler Hicks
2021-03-30 16:44 ` [PATCH 27/31] fs: ecryptfs: miscdev: File headers are not good kernel-doc candidates Lee Jones
2021-03-30 16:44 ` [PATCH 28/31] fs: ecryptfs: crypto: Supply some missing param descriptions and demote abuses Lee Jones
2021-04-18 17:17 ` Tyler Hicks
2021-03-30 16:44 ` [PATCH 29/31] fs: ecryptfs: mmap: Help out one function header and demote other abuses Lee Jones
2021-03-30 16:44 ` [PATCH 30/31] fs: ecryptfs: inode: Help out nearly-there header and demote non-conformant ones Lee Jones
2021-03-30 16:44 ` [PATCH 31/31] fs: ecryptfs: keystore: Fix some kernel-doc issues and demote non-conformant headers Lee Jones
2021-04-19 5:09 ` [PATCH 00/31] Rid W=1 warnings from GFS2 and EncryptFS Tyler Hicks
2021-04-19 7:26 ` Lee Jones
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210330164458.1625478-27-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=christian.brauner@ubuntu.com \
--cc=code@tyhicks.com \
--cc=ecryptfs@vger.kernel.org \
--cc=jamorris@linux.microsoft.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mahalcro@us.ibm.com \
--cc=mcthomps@us.ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).