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 6/8] nilfs2: describe the members of nilfs_bmap_operations structure
Date: Fri, 16 Aug 2024 16:43:17 +0900	[thread overview]
Message-ID: <20240816074319.3253-7-konishi.ryusuke@gmail.com> (raw)
In-Reply-To: <20240816074319.3253-1-konishi.ryusuke@gmail.com>

Add missing member variable descriptions in the kernel-doc comments
for the nilfs_bmap_operations structure, hiding the internal
operations with the "private:" tag.  This eliminates the following
warnings output by the kernel-doc script:

 fs/nilfs2/bmap.h:74: warning: Function parameter or struct member
  'bop_lookup' not described in 'nilfs_bmap_operations'
 fs/nilfs2/bmap.h:74: warning: Function parameter or struct member
  'bop_lookup_contig' not described in 'nilfs_bmap_operations'
 ...
 fs/nilfs2/bmap.h:74: warning: Function parameter or struct member
  'bop_gather_data' not described in 'nilfs_bmap_operations'

Signed-off-by: Ryusuke Konishi <konishi.ryusuke@gmail.com>
---
 fs/nilfs2/bmap.h | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/fs/nilfs2/bmap.h b/fs/nilfs2/bmap.h
index 608168a5cb88..5f8c8c552620 100644
--- a/fs/nilfs2/bmap.h
+++ b/fs/nilfs2/bmap.h
@@ -44,6 +44,19 @@ struct nilfs_bmap_stats {
 
 /**
  * struct nilfs_bmap_operations - bmap operation table
+ * @bop_lookup:               single block search operation
+ * @bop_lookup_contig:        consecutive block search operation
+ * @bop_insert:               block insertion operation
+ * @bop_delete:               block delete operation
+ * @bop_clear:                block mapping resource release operation
+ * @bop_propagate:            operation to propagate dirty state towards the
+ *                            mapping root
+ * @bop_lookup_dirty_buffers: operation to collect dirty block buffers
+ * @bop_assign:               disk block address assignment operation
+ * @bop_mark:                 operation to mark in-use blocks as dirty for
+ *                            relocation by GC
+ * @bop_seek_key:             find valid block key operation
+ * @bop_last_key:             find last valid block key operation
  */
 struct nilfs_bmap_operations {
 	int (*bop_lookup)(const struct nilfs_bmap *, __u64, int, __u64 *);
@@ -66,7 +79,7 @@ struct nilfs_bmap_operations {
 	int (*bop_seek_key)(const struct nilfs_bmap *, __u64, __u64 *);
 	int (*bop_last_key)(const struct nilfs_bmap *, __u64 *);
 
-	/* The following functions are internal use only. */
+	/* private: internal use only */
 	int (*bop_check_insert)(const struct nilfs_bmap *, __u64);
 	int (*bop_check_delete)(struct nilfs_bmap *, __u64);
 	int (*bop_gather_data)(struct nilfs_bmap *, __u64 *, __u64 *, int);
-- 
2.34.1


  parent 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 ` [PATCH 1/8] nilfs2: add missing argument description for __nilfs_error() Ryusuke Konishi
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 ` Ryusuke Konishi [this message]
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-7-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