linux-nilfs.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ryusuke Konishi <konishi.ryusuke@gmail.com>
To: Yang Li <yang.lee@linux.alibaba.com>
Cc: linux-nilfs@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH -next 2/3 v2] fs: Add kernel-doc comments to nilfs_btree_convert_and_insert()
Date: Mon, 25 Mar 2024 17:19:31 +0900	[thread overview]
Message-ID: <CAKFNMon5w_AfJmdey-XY+wWK+yCqj9PuHVeJf4qa2TMNv_iPsg@mail.gmail.com> (raw)
In-Reply-To: <20240325024628.101296-1-yang.lee@linux.alibaba.com>

On Mon, Mar 25, 2024 at 11:46 AM Yang Li wrote:
>
> This commit adds kernel-doc style comments with complete parameter
> descriptions for the function nilfs_btree_convert_and_insert.
>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
>  fs/nilfs2/btree.c | 22 +++++++++++++++-------
>  1 file changed, 15 insertions(+), 7 deletions(-)
>
> diff --git a/fs/nilfs2/btree.c b/fs/nilfs2/btree.c
> index 65659fa0372e..de38012fd87c 100644
> --- a/fs/nilfs2/btree.c
> +++ b/fs/nilfs2/btree.c
> @@ -1857,13 +1857,21 @@ nilfs_btree_commit_convert_and_insert(struct nilfs_bmap *btree,
>  }
>
>  /**
> - * nilfs_btree_convert_and_insert -
> - * @bmap:
> - * @key:
> - * @ptr:
> - * @keys:
> - * @ptrs:
> - * @n:
> + * nilfs_btree_convert_and_insert - Convert and insert entries into a B-tree
> + * @btree: NILFS B-tree structure
> + * @key: Key of the new entry to be inserted
> + * @ptr: Pointer (block number) associated with the key to be inserted
> + * @keys: Array of keys to be inserted in addition to @key
> + * @ptrs: Array of pointers associated with @keys
> + * @n: Number of keys and pointers in @keys and @ptrs
> + *
> + * This function is used to insert a new entry specified by @key and @ptr, along
> + * with additional entries specified by @keys and @ptrs arrays, into a NILFS B-tree.
> + * It prepares the necessary changes by allocating the required blocks and any
> + * necessary intermediate nodes. It converts configurations from other forms of block
> + * mapping (the one that currently exists is direct mapping) to a B-tree.
> + *
> + * Return: 0 on success or a negative error code on failure.
>   */
>  int nilfs_btree_convert_and_insert(struct nilfs_bmap *btree,
>                                    __u64 key, __u64 ptr,
> --
> 2.20.1.7.g153144c
>

Thank you for the revised version.  I'll take this one.

Ryusuke Konishi

      reply	other threads:[~2024-03-25  8:19 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-25  2:46 [PATCH -next 2/3 v2] fs: Add kernel-doc comments to nilfs_btree_convert_and_insert() Yang Li
2024-03-25  8:19 ` Ryusuke Konishi [this message]

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=CAKFNMon5w_AfJmdey-XY+wWK+yCqj9PuHVeJf4qa2TMNv_iPsg@mail.gmail.com \
    --to=konishi.ryusuke@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-nilfs@vger.kernel.org \
    --cc=yang.lee@linux.alibaba.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 read-only IMAP folder(s) and NNTP newsgroup(s).