Re: Are .txt -> .rst patches welcome

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

 



On Tue, Nov 28, 2017 at 11:03:56AM -0700, Jonathan Corbet wrote:
> On Fri, 24 Nov 2017 10:30:56 +1100
> "Tobin C. Harding" <me@xxxxxxxx> wrote:
> 
> > What's the status of the move from .txt to .rst files within the
> > kernel?
> > 
> > The point of the question; are patches converting .txt files in
> > Documentation/ to .rst files welcome?
> 
> As a general rule, yes, they are.  That said, I'm much happier when these
> patches also involve a look at the documentation to ensure that it's still
> current and worth keeping and also include some thought as to where the
> converted documentation should go in a more rational hierarchy.
> 
> A different way of putting it would be: Documentation/ now is a mess.
> Simply converting .txt files to RST does not, on its own, reduce the mess
> factor much.  But it can be a part of the bigger effort to turn the
> kernel's documentation into some sort of coherent whole.

Cool, thanks for the reply. I was hoping to do the odd conversion for
the purely selfish reason that updating the doc makes me read (and
understand) them thoroughly. I'll keep your points in mind.

thanks,
Tobin.
--
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