From: Matthew Wilcox <willy@infradead.org>
To: Grzegorz Zdanowski <grzegorz129@gmail.com>
Cc: linux-doc@vger.kernel.org
Subject: Re: Are documentation-only patches welcomed?
Date: Sat, 12 Jun 2021 20:33:31 +0100 [thread overview]
Message-ID: <YMUMC7CTLNJeuOP8@casper.infradead.org> (raw)
In-Reply-To: <CAAoDVDDCWKw9_uh6i70zW6uCH_bvuBWyQV7u=TW_ne9CaWA0rQ@mail.gmail.com>
On Sat, Jun 12, 2021 at 12:26:06PM -0500, Grzegorz Zdanowski wrote:
> Hi!
>
> While dipping my toes in Linux kernel programming I discovered that a
> lot of functions, even exported ones, lack any comment blocks or
> references to documentation. Most of the time I have to resort to the
> original commit message + LKML threads associated with a given
> function.
>
> Is this intentional, or is it simply a by-product of the lack of
> developer's time? If it's the latter, are documentation-only patches
> welcomed?
Absolutely welcome.
I would suggest that you focus on a particular subsystem so that you
get really deeply knowledgable about it and the bits of the kernel it
interacts with. Also that you work with/through the maintainer and
mailing list for that part of the kernel rather than with linux-doc.
You can always cc linux-doc, of course, for getting review from people
who have expertise in documentation writing, but domain-specific expertise
is also needed.
prev parent reply other threads:[~2021-06-12 19:33 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-12 17:26 Are documentation-only patches welcomed? Grzegorz Zdanowski
2021-06-12 19:33 ` Matthew Wilcox [this message]
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=YMUMC7CTLNJeuOP8@casper.infradead.org \
--to=willy@infradead.org \
--cc=grzegorz129@gmail.com \
--cc=linux-doc@vger.kernel.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.