Messages in this thread | | | Date | Thu, 14 Feb 2019 13:46:27 +0100 | From | Petr Mladek <> | Subject | Re: [RFC PATCH v1 03/25] printk-rb: define ring buffer struct and initializer |
| |
On Tue 2019-02-12 15:46:40, Greg Kroah-Hartman wrote: > On Tue, Feb 12, 2019 at 03:29:41PM +0100, John Ogness wrote: > > See Documentation/printk-ringbuffer.txt for details about the > > initializer arguments. > > You can put that documentation here in the .h file and have it pulled > out automatically into the documentation files when they are created. > That way you always keep everything in sync properly.
Yes, please, move the documentation into the sources.
It is so easy to get the info via editor+cscope support than via an external text file that many people do not know about ;-)
For example, see include/linux/livepatch.h for inspiration.
Best Regards, Petr
| |