[howto?] linux/kernel.h: enum system_states

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxxxxx/

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





[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux