[tip: locking/core] locking/seqlock: Tweak DEFINE_SEQLOCK() kernel doc

From: tip-bot2 for Sebastian Andrzej Siewior
Date: Wed Oct 07 2020 - 12:20:46 EST


The following commit has been merged into the locking/core branch of tip:

Commit-ID: 24a1877286822293684ef3f7bada4ea48a6e129e
Gitweb: https://git.kernel.org/tip/24a1877286822293684ef3f7bada4ea48a6e129e
Author: Sebastian Andrzej Siewior <bigeasy@xxxxxxxxxxxxx>
AuthorDate: Thu, 24 Sep 2020 17:48:51 +02:00
Committer: Peter Zijlstra <peterz@xxxxxxxxxxxxx>
CommitterDate: Wed, 07 Oct 2020 18:14:14 +02:00

locking/seqlock: Tweak DEFINE_SEQLOCK() kernel doc

ctags creates a warning:
|ctags: Warning: include/linux/seqlock.h:738: null expansion of name pattern "\2"

The DEFINE_SEQLOCK() macro is passed to ctags and being told to expect
an argument.

Add a dummy argument to keep ctags quiet.

Signed-off-by: Sebastian Andrzej Siewior <bigeasy@xxxxxxxxxxxxx>
Signed-off-by: Peter Zijlstra (Intel) <peterz@xxxxxxxxxxxxx>
Acked-by: Will Deacon <will@xxxxxxxxxx>
Link: https://lkml.kernel.org/r/20200924154851.skmswuyj322yuz4g@xxxxxxxxxxxxx
---
include/linux/seqlock.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/seqlock.h b/include/linux/seqlock.h
index 76e44e6..ac5b07f 100644
--- a/include/linux/seqlock.h
+++ b/include/linux/seqlock.h
@@ -821,7 +821,7 @@ typedef struct {
} while (0)

/**
- * DEFINE_SEQLOCK() - Define a statically allocated seqlock_t
+ * DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
* @sl: Name of the seqlock_t instance
*/
#define DEFINE_SEQLOCK(sl) \