public inbox for linux-btrfs@vger.kernel.org
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org
Cc: Matthew Wilcox <willy@infradead.org>,
	Bagas Sanjaya <bagasdotme@gmail.com>, Chris Mason <clm@fb.com>,
	Josef Bacik <josef@toxicpanda.com>,
	David Sterba <dsterba@suse.com>, Nick Terrell <terrelln@fb.com>,
	Schspa Shi <schspa@gmail.com>,
	linux-btrfs@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH] btrfs: zstd: remove extraneous asterix at the head of zstd_reclaim_timer_fn() comment
Date: Mon, 18 Apr 2022 19:59:35 +0700	[thread overview]
Message-ID: <20220418125934.566647-1-bagasdotme@gmail.com> (raw)

kernel test robot reports kernel-doc warning:

>> fs/btrfs/zstd.c:98: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

The comment is for zstd_reclaim_timer_fn(). Since the function is
static, the comment isn't meant for kernel-doc consumption.

Remove the extraneous (second) asterix at the head of function comment.

Link: https://lore.kernel.org/linux-doc/202204151934.CkKcnvuJ-lkp@intel.com/
Fixes: b672526e2ee935 ("btrfs: use non-bh spin_lock in zstd timer callback")
Cc: Chris Mason <clm@fb.com>
Cc: Josef Bacik <josef@toxicpanda.com>
Cc: David Sterba <dsterba@suse.com>
Cc: Nick Terrell <terrelln@fb.com>
Cc: Schspa Shi <schspa@gmail.com>
Cc: linux-btrfs@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 In the previous fix attempt [1], Matthew Wilcox suggested to remove the
 second asterix instead since the function is static and it shouldn't
 have kernel-doc comments.

 [1]: https://lore.kernel.org/linux-doc/YluGmERvtQY9ju7Y@casper.infradead.org/

 This patch is based on btrfs-devel/misc-next tree [2].

 [2]: https://github.com/kdave/btrfs-devel.git

 fs/btrfs/zstd.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/fs/btrfs/zstd.c b/fs/btrfs/zstd.c
index 0fe31a6f6e68f0..ca2102a46faefd 100644
--- a/fs/btrfs/zstd.c
+++ b/fs/btrfs/zstd.c
@@ -94,7 +94,7 @@ static inline struct workspace *list_to_workspace(struct list_head *list)
 void zstd_free_workspace(struct list_head *ws);
 struct list_head *zstd_alloc_workspace(unsigned int level);
 
-/**
+/*
  * Timer callback to free unused workspaces.
  *
  * @t: timer

base-commit: 550a34e972578538fd0826916ae4fc407b62bb68
-- 
An old man doll... just what I always wanted! - Clara


             reply	other threads:[~2022-04-18 13:46 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-04-18 12:59 Bagas Sanjaya [this message]
2022-04-18 15:29 ` [PATCH] btrfs: zstd: remove extraneous asterix at the head of zstd_reclaim_timer_fn() comment Josef Bacik
2022-04-19  5:19   ` Bagas Sanjaya
2022-04-19 13:06     ` David Sterba

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=20220418125934.566647-1-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=clm@fb.com \
    --cc=dsterba@suse.com \
    --cc=josef@toxicpanda.com \
    --cc=linux-btrfs@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=schspa@gmail.com \
    --cc=terrelln@fb.com \
    --cc=willy@infradead.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