* [howto?] linux/kernel.h: enum system_states
@ 2025-08-29 23:07 Randy Dunlap
0 siblings, 0 replies; only message in thread
From: Randy Dunlap @ 2025-08-29 23:07 UTC (permalink / raw)
To: open list:DOCUMENTATION
Hi,
Looking for advice/suggestions (for kernel-doc).
I sent a patch for adding kernel-doc notation for enum system_states
in <linux/kernel.h>.
See https://lore.kernel.org/all/20250818042123.1786468-1-rdunlap@infradead.org/
Then I recently tried to add that to the kernel docbooks. Oops.
There is one little word that is making this difficult: extern.
kernel-doc does not support documenting (/**) something that is
"extern". I can't remove the "extern" and with it present, kernel-doc
just ignores this comment.
It seems that I am left with using DOC: to document this enum, which I have
working -- it just feels suboptimal.
(Or I could move the kernel-doc block to init/main.c, where the variable 'system_state'
is defined. But that's not the right place for the kernel-doc block IMO).
Any other bright ideas/suggestions for me?
Thanks.
--
~Randy
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2025-08-29 23:07 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-08-29 23:07 [howto?] linux/kernel.h: enum system_states Randy Dunlap
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 NNTP newsgroup(s).