Thread (8 messages) 8 messages, 4 authors, 2020-01-23

Re: [PATCH] Add a document on how to contribute to the documentation

From: Jonathan Corbet <corbet@lwn.net>
Date: 2020-01-23 00:23:25

On Wed, 22 Jan 2020 15:53:02 -0800
Matthew Wilcox [off-list ref] wrote:
One thing which I feel should be mentioned
is the hard work put in by hundreds of kernel maintainers who have
written kernel-doc and nobody has done the trivial work to actually
include those source files in an rst file, so all that documentation
is being ignored.  A great task that's a step up from "fixing typos" is
"find documentation that's not currently in a kernel book and add it".
Even if it's just dumped into a "misc" section, having (eg) kvmalloc()
documentation in a kernel book is a benefit.
Yeah, I'd thought about putting that in, then kind of forgot about it.
I'll add a paragraph.
Do you want to preemptively mention the Oxford comma here?
It's true, there is only One True Way Of Comma Placement, so we want to be
sure people get it right...:)

Thanks,

jon
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help