<div class="gmail_quote">On Sat, Oct 27, 2012 at 10:09 AM, Robert P. J. Day <span dir="ltr"><<a href="mailto:rpjday@crashcourse.ca" target="_blank">rpjday@crashcourse.ca</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div class="im">On Fri, 26 Oct 2012, Greg Freemyer wrote:<br>
<br>
> fyi: Robert Day just asked for help cleaning up the Doc Book stuff.<br>
><br>
> Doc Book pull comments out of the .c files and creates documentation.<br>
> To clean it up, patches to the source files will be required. These<br>
> are more likely to be accepted.<br>
><br>
> So you could to a doc book series like:<br>
><br>
> 0/2 a patch series to correct the documentation for xyz subsystem<br>
> 1/2 checkpatch cleanup of the 2 files with doc updates<br>
> 2/2 doc updates<br>
<br>
</div> if you want to get started making fixes and submitting patches, i<br>
suggest doc fixes as an easy way to jump in for the simple reason that<br>
just making changes to documentation shouldn't break anything. :-)<br>
there is a separate list just for kernel documentation:<br>
<br>
<a href="http://vger.kernel.org/vger-lists.html#linux-doc" target="_blank">http://vger.kernel.org/vger-lists.html#linux-doc</a><br>
<br>
so you know you'll be on-topic there chatting about documentation.<br>
from the perspective of someone who has no *official* connection with<br>
the kernel but who's submitted lots of pedantic patches over the<br>
years, let me make a couple suggestions.<br>
<br>
first, a *lot* of what's under the Documentation/ directory is<br>
absurdly old and worthless, and should probably be just deleted.<br>
ignore that stuff. other stuff under there is perfectly up-to-date,<br>
and should be left alone.<br>
<br>
the middle ground is the stuff that can be updated to reflect the<br>
current kernel, so pick a single file under there that reflects<br>
something you're interested in, start going through it, make<br>
corrections, and submit the final patch to the linux-doc list. try to<br>
work with a single file or topic at a time, it's easier to get your<br>
patches accepted.<br>
<br>
post on the kernel-doc stuff coming shortly, for the interested.<br>
<br>
rday<br>
<span class="HOEnZb"><font color="#888888"><br>
--<br>
<br>
========================================================================<br>
Robert P. J. Day Ottawa, Ontario, CANADA<br>
<a href="http://crashcourse.ca" target="_blank">http://crashcourse.ca</a><br>
<br>
Twitter: <a href="http://twitter.com/rpjday" target="_blank">http://twitter.com/rpjday</a><br>
LinkedIn: <a href="http://ca.linkedin.com/in/rpjday" target="_blank">http://ca.linkedin.com/in/rpjday</a><br>
========================================================================<br>
</font></span></blockquote></div><br><div><br></div><div>Thanks I'll be following the documentation mailing list.</div>