Linux NILFS development
 help / color / mirror / Atom feed
From: Ryusuke Konishi <konishi.ryusuke@gmail.com>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: linux-nilfs@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH 1/8] nilfs2: add missing argument description for __nilfs_error()
Date: Fri, 16 Aug 2024 16:43:12 +0900	[thread overview]
Message-ID: <20240816074319.3253-2-konishi.ryusuke@gmail.com> (raw)
In-Reply-To: <20240816074319.3253-1-konishi.ryusuke@gmail.com>

Add missing argument description to __nilfs_error function and remove
the following warnings from kernel-doc script output:

 fs/nilfs2/super.c:121: warning: Function parameter or struct member 'sb'
  not described in '__nilfs_error'
 fs/nilfs2/super.c:121: warning: Function parameter or struct member
  'function' not described in '__nilfs_error'
 fs/nilfs2/super.c:121: warning: Function parameter or struct member 'fmt'
  not described in '__nilfs_error'

Signed-off-by: Ryusuke Konishi <konishi.ryusuke@gmail.com>
---
 fs/nilfs2/super.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/fs/nilfs2/super.c b/fs/nilfs2/super.c
index 76e35e6773d1..8eb8dbc9f51c 100644
--- a/fs/nilfs2/super.c
+++ b/fs/nilfs2/super.c
@@ -105,6 +105,10 @@ static void nilfs_set_error(struct super_block *sb)
 
 /**
  * __nilfs_error() - report failure condition on a filesystem
+ * @sb:       super block instance
+ * @function: name of calling function
+ * @fmt:      format string for message to be output
+ * @...:      optional arguments to @fmt
  *
  * __nilfs_error() sets an ERROR_FS flag on the superblock as well as
  * reporting an error message.  This function should be called when
-- 
2.34.1


  reply	other threads:[~2024-08-16  7:43 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-16  7:43 [PATCH 0/8] nilfs2: clean up kernel-doc warnings Ryusuke Konishi
2024-08-16  7:43 ` Ryusuke Konishi [this message]
2024-08-16  7:43 ` [PATCH 2/8] nilfs2: add missing argument descriptions for ioctl-related helpers Ryusuke Konishi
2024-08-16  7:43 ` [PATCH 3/8] nilfs2: improve kernel-doc comments for b-tree node helpers Ryusuke Konishi
2024-08-16  7:43 ` [PATCH 4/8] nilfs2: fix incorrect kernel-doc declaration of nilfs_palloc_req structure Ryusuke Konishi
2024-08-16  7:43 ` [PATCH 5/8] nilfs2: add missing description of nilfs_btree_path structure Ryusuke Konishi
2024-08-16  7:43 ` [PATCH 6/8] nilfs2: describe the members of nilfs_bmap_operations structure Ryusuke Konishi
2024-08-16  7:43 ` [PATCH 7/8] nilfs2: fix inconsistencies in kernel-doc comments in segment.h Ryusuke Konishi
2024-08-16  7:43 ` [PATCH 8/8] nilfs2: fix missing initial short descriptions of kernel-doc comments Ryusuke Konishi

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=20240816074319.3253-2-konishi.ryusuke@gmail.com \
    --to=konishi.ryusuke@gmail.com \
    --cc=akpm@linux-foundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-nilfs@vger.kernel.org \
    /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