* Are documentation-only patches welcomed?
@ 2021-06-12 17:26 Grzegorz Zdanowski
2021-06-12 19:33 ` Matthew Wilcox
0 siblings, 1 reply; 2+ messages in thread
From: Grzegorz Zdanowski @ 2021-06-12 17:26 UTC (permalink / raw)
To: linux-doc
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?
Regards,
Greg.
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: Are documentation-only patches welcomed?
2021-06-12 17:26 Are documentation-only patches welcomed? Grzegorz Zdanowski
@ 2021-06-12 19:33 ` Matthew Wilcox
0 siblings, 0 replies; 2+ messages in thread
From: Matthew Wilcox @ 2021-06-12 19:33 UTC (permalink / raw)
To: Grzegorz Zdanowski; +Cc: linux-doc
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.
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-06-12 19:33 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-06-12 17:26 Are documentation-only patches welcomed? Grzegorz Zdanowski
2021-06-12 19:33 ` Matthew Wilcox
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.