linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Tyler Hicks <code@tyhicks.com>,
	"Michael A. Halcrow" <mhalcrow@us.ibm.com>,
	"Michael C. Thompson" <mcthomps@us.ibm.com>,
	"Trevor S. Highland" <trevor.highland@gmail.com>,
	ecryptfs@vger.kernel.org
Subject: [PATCH 31/31] fs: ecryptfs: keystore: Fix some kernel-doc issues and demote non-conformant headers
Date: Tue, 30 Mar 2021 17:44:58 +0100	[thread overview]
Message-ID: <20210330164458.1625478-32-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/keystore.c:25: warning: Incorrect use of kernel-doc format:  * request_key returned an error instead of a valid key address;
 fs/ecryptfs/keystore.c:30: warning: Function parameter or member 'err_code' not described in 'process_request_key_err'
 fs/ecryptfs/keystore.c:30: warning: expecting prototype for eCryptfs(). Prototype was for process_request_key_err() instead
 fs/ecryptfs/keystore.c:558: warning: Function parameter or member 'auth_tok_key' not described in 'ecryptfs_find_auth_tok_for_sig'
 fs/ecryptfs/keystore.c:558: warning: Function parameter or member 'mount_crypt_stat' not described in 'ecryptfs_find_auth_tok_for_sig'
 fs/ecryptfs/keystore.c:558: warning: Excess function parameter 'crypt_stat' description in 'ecryptfs_find_auth_tok_for_sig'
 fs/ecryptfs/keystore.c:584: warning: cannot understand function prototype: 'struct ecryptfs_write_tag_70_packet_silly_stack '
 fs/ecryptfs/keystore.c:622: warning: Function parameter or member 'dest' not described in 'ecryptfs_write_tag_70_packet'
 fs/ecryptfs/keystore.c:622: warning: Function parameter or member 'remaining_bytes' not described in 'ecryptfs_write_tag_70_packet'
 fs/ecryptfs/keystore.c:622: warning: Function parameter or member 'packet_size' not described in 'ecryptfs_write_tag_70_packet'
 fs/ecryptfs/keystore.c:622: warning: Function parameter or member 'mount_crypt_stat' not described in 'ecryptfs_write_tag_70_packet'
 fs/ecryptfs/keystore.c:622: warning: Function parameter or member 'filename_size' not described in 'ecryptfs_write_tag_70_packet'
 fs/ecryptfs/keystore.c:622: warning: expecting prototype for write_tag_70_packet(). Prototype was for ecryptfs_write_tag_70_packet() instead
 fs/ecryptfs/keystore.c:895: warning: expecting prototype for parse_tag_70_packet(). Prototype was for ecryptfs_parse_tag_70_packet() instead

Cc: Tyler Hicks <code@tyhicks.com>
Cc: "Michael A. Halcrow" <mhalcrow@us.ibm.com>
Cc: "Michael C. Thompson" <mcthomps@us.ibm.com>
Cc: "Trevor S. Highland" <trevor.highland@gmail.com>
Cc: ecryptfs@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 fs/ecryptfs/keystore.c | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/fs/ecryptfs/keystore.c b/fs/ecryptfs/keystore.c
index 2abd219cfeec6..3fe41964c0d8d 100644
--- a/fs/ecryptfs/keystore.c
+++ b/fs/ecryptfs/keystore.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
-/**
+/*
  * eCryptfs: Linux filesystem encryption layer
  * In-kernel key management code.  Includes functions to parse and
  * write authentication token-related packets with the underlying
@@ -21,7 +21,7 @@
 #include <linux/slab.h>
 #include "ecryptfs_kernel.h"
 
-/**
+/*
  * request_key returned an error instead of a valid key address;
  * determine the type of error, make appropriate log entries, and
  * return an error code.
@@ -536,8 +536,9 @@ ecryptfs_find_global_auth_tok_for_sig(
 
 /**
  * ecryptfs_find_auth_tok_for_sig
+ * @auth_tok_key: key containing the authentication token
  * @auth_tok: Set to the matching auth_tok; NULL if not found
- * @crypt_stat: inode crypt_stat crypto context
+ * @mount_crypt_stat: inode crypt_stat crypto context
  * @sig: Sig of auth_tok to find
  *
  * For now, this function simply looks at the registered auth_tok's
@@ -576,7 +577,7 @@ ecryptfs_find_auth_tok_for_sig(
 	return rc;
 }
 
-/**
+/*
  * write_tag_70_packet can gobble a lot of stack space. We stuff most
  * of the function's parameters in a kmalloc'd struct to help reduce
  * eCryptfs' overall stack usage.
@@ -604,7 +605,7 @@ struct ecryptfs_write_tag_70_packet_silly_stack {
 	struct shash_desc *hash_desc;
 };
 
-/**
+/*
  * write_tag_70_packet - Write encrypted filename (EFN) packet against FNEK
  * @filename: NULL-terminated filename string
  *
@@ -873,7 +874,7 @@ struct ecryptfs_parse_tag_70_packet_silly_stack {
 };
 
 /**
- * parse_tag_70_packet - Parse and process FNEK-encrypted passphrase packet
+ * ecryptfs_parse_tag_70_packet - Parse and process FNEK-encrypted passphrase packet
  * @filename: This function kmalloc's the memory for the filename
  * @filename_size: This function sets this to the amount of memory
  *                 kmalloc'd for the filename
-- 
2.27.0


  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 ` [PATCH 26/31] fs: ecryptfs: main: Demote a bunch of non-conformant kernel-doc headers Lee Jones
2021-04-18 17:19   ` 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 ` Lee Jones [this message]
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-32-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=code@tyhicks.com \
    --cc=ecryptfs@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mcthomps@us.ibm.com \
    --cc=mhalcrow@us.ibm.com \
    --cc=trevor.highland@gmail.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).