Re: [PATCH V2] docs: process/4.Coding.rst: Fix a couple of document refs

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Em Thu, 20 Apr 2017 16:33:29 +0300
Jani Nikula <jani.nikula@xxxxxxxxxxxxxxx> escreveu:

> On Thu, 20 Apr 2017, Andrew Clayton <andrew@xxxxxxxxxxxxxxxxxx> wrote:
> > In Documentation/process/4.Coding.rst there were a couple of paragraphs
> > that spilled over the 80 character line length. This was likely caused
> > when the document was converted to reStructuredText. Re-flow the
> > paragraphs and make the document references proper reStructuredText
> > :ref: links.
> >
> > This also adds the appropriate reStructuredText file heading to
> > kernel-parameters.rst as referenced by the kernel-parameters link in
> > this patch.
> >
> > Signed-off-by: Andrew Clayton <andrew@xxxxxxxxxxxxxxxxxx>
> > ---
> >  V2 - Convert the document references into :ref: links  
> 
> Thanks, this seems like a much better change to me.
> 
> Reviewed-by: Jani Nikula <jani.nikula@xxxxxxxxx>
> 
> Jon, Mauro, am I right in that the only place that actually leads to the
> development process documentation that starts at 1.Intro.rst is in fact
> submitting-patches.rst? It's not referenced in any indexes is it?

Documents 1. to 9. used to belong to a separate book covering the
"concepts" of submitting patches. They describe the Kernel development
cycle and other aspects like licensing, why submit patches, etc.

The submitting-patches.rst actually came first. It is a
practical "how to submit a patch in 16 steps" guide.

There is a third document (submit-checklist.rst) with serves to the
purpose of reminding people about things to observe before sending
a patch.

I guess those three guides complement each other, the first one with a
comprehensive explanation; the second one with a quick list of
tasks to submit a patch and the third one with a list of things to
verify when submitting a patch.

As they were written on different times, and by different people,
the writing style is different. Perhaps it would make sense to
improve cohesion between those three documents.

Thanks,
Mauro
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux