RCU Archive on lore.kernel.org
 help / color / Atom feed
* kerneldoc warnings since commit 538fc2ee870a3 ("rcu: Introduce kfree_rcu() single-argument macro")
@ 2021-01-05  7:32 Lukas Bulwahn
  2021-01-05 13:14 ` Uladzislau Rezki
  0 siblings, 1 reply; 7+ messages in thread
From: Lukas Bulwahn @ 2021-01-05  7:32 UTC (permalink / raw)
  To: Uladzislau Rezki, Paul E. McKenney, Josh Triplett, rcu
  Cc: linux-doc, Linux Kernel Mailing List, Steven Rostedt,
	Mathieu Desnoyers, Lai Jiangshan, Joel Fernandes

Dear Uladzislau,

in commit 538fc2ee870a3 ("rcu: Introduce kfree_rcu() single-argument
macro"), you have refactored the kfree_rcu macro.

Since then, make htmldocs warns:

./include/linux/rcupdate.h:882: warning: Excess function parameter
'ptr' description in 'kfree_rcu'
./include/linux/rcupdate.h:882: warning: Excess function parameter
'rhf' description in 'kfree_rcu'

As you deleted the two arguments in the macro definition, kerneldoc
cannot resolve the argument names in the macro's kerneldoc
documentation anymore and warns about that.

Probably, it is best to just turn the formal kerneldoc references to
the two arguments, which are not used in the macro definition anymore,
simply into two informal references in the documentation.

Best regards,

Lukas

^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, back to index

Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-01-05  7:32 kerneldoc warnings since commit 538fc2ee870a3 ("rcu: Introduce kfree_rcu() single-argument macro") Lukas Bulwahn
2021-01-05 13:14 ` Uladzislau Rezki
2021-01-05 14:03   ` Lukas Bulwahn
2021-01-05 14:56   ` Paul E. McKenney
2021-01-05 16:29     ` Uladzislau Rezki
2021-01-07  7:28       ` Lukas Bulwahn
2021-01-07 13:00         ` Uladzislau Rezki

RCU Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/rcu/0 rcu/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 rcu rcu/ https://lore.kernel.org/rcu \
		rcu@vger.kernel.org
	public-inbox-index rcu

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.rcu


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git