From: Jonathan Corbet <corbet@lwn.net>
To: Matthew Wilcox <willy@infradead.org>
Cc: linux-doc@vger.kernel.org
Subject: Re: [PATCH] Add a document on how to contribute to the documentation
Date: Wed, 22 Jan 2020 17:23:23 -0700 [thread overview]
Message-ID: <20200122172323.5147ea8b@lwn.net> (raw)
In-Reply-To: <20200122235302.GD4675@bombadil.infradead.org>
On Wed, 22 Jan 2020 15:53:02 -0800
Matthew Wilcox <willy@infradead.org> 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
next prev parent reply other threads:[~2020-01-23 0:23 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-22 23:20 [PATCH] Add a document on how to contribute to the documentation Jonathan Corbet
2020-01-22 23:46 ` Randy Dunlap
2020-01-22 23:53 ` Matthew Wilcox
2020-01-22 23:54 ` Randy Dunlap
2020-01-22 23:58 ` Matthew Wilcox
2020-01-22 23:59 ` Randy Dunlap
2020-01-23 0:23 ` Jonathan Corbet [this message]
2020-01-23 10:03 ` Jani Nikula
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200122172323.5147ea8b@lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=willy@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.