Received-SPF: pass (google.com: domain of linux-kernel+bounces-6444-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Ryusuke Konishi <konishi.ryusuke@gmail.com>,
	linux-nilfs@vger.kernel.org
Subject: [PATCH] nilfs2: cpfile: fix some kernel-doc warnings
Date: Tue, 19 Dec 2023 22:59:31 -0800
Message-ID: <20231220065931.2372-1-rdunlap@infradead.org>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

Correct the function parameter names for nilfs_cpfile_get_info():

cpfile.c:564: warning: Function parameter or member 'cnop' not described in 'nilfs_cpfile_get_cpinfo'
cpfile.c:564: warning: Function parameter or member 'mode' not described in 'nilfs_cpfile_get_cpinfo'
cpfile.c:564: warning: Function parameter or member 'buf' not described in 'nilfs_cpfile_get_cpinfo'
cpfile.c:564: warning: Function parameter or member 'cisz' not described in 'nilfs_cpfile_get_cpinfo'
cpfile.c:564: warning: Excess function parameter 'cno' description in 'nilfs_cpfile_get_cpinfo'
cpfile.c:564: warning: Excess function parameter 'ci' description in 'nilfs_cpfile_get_cpinfo'

This still leaves a few kernel-doc warnings.
Also, the function parameters should have descriptions after them.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Ryusuke Konishi <konishi.ryusuke@gmail.com>
Cc: linux-nilfs@vger.kernel.org
---
 fs/nilfs2/cpfile.c |    6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff -- a/fs/nilfs2/cpfile.c b/fs/nilfs2/cpfile.c
--- a/fs/nilfs2/cpfile.c
+++ b/fs/nilfs2/cpfile.c
@@ -554,8 +554,10 @@ static ssize_t nilfs_cpfile_do_get_ssinf
 /**
  * nilfs_cpfile_get_cpinfo -
  * @cpfile:
- * @cno:
- * @ci:
+ * @cnop:
+ * @mode:
+ * @buf:
+ * @cisz:
  * @nci:
  */