Re: [PATCH] docs: Move kref.txt to core-api/kref.rst

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

 



On Fri, May 10, 2019 at 10:17:47AM +1000, Tobin C. Harding wrote:
> kref.txt is already written using correct ReStructuredText format.  This
> can be verified as follows
> 
> 	make cleandocs
> 	make htmldocs 2> pre.stderr
> 	mv Documentation/kref.txt Documentation/core-api/kref.rst
> 	// Add 'kref' to core-api/index.rst
> 	make cleandocs
> 	make htmldocs 2> post.stderr
> 	diff pre.stderr post.stderr
> 
> While doing the file move, fix the column width to be 72 characters wide
> as it is throughout the document.  This is whitespace only.  kref.txt is
> so cleanly written its a shame to have these few extra wide paragraphs.
> 
> Signed-off-by: Tobin C. Harding <tobin@xxxxxxxxxx>
> ---
> 
> I'm always hesitant to do docs patches that seem obvious - is there
> some reason that this was not done previously?
> 
> I did this one in preparation for converting kobject.txt, my intent is
> to put kboject.rst in core-api/ also?

Oh, I should have started on kobject.rst before sending this.  It builds
without errors also.  The 'conversion' is no more than renaming the
file.

If this patch is acceptable I can re-spin it as part of a series that
does kobject as well so you don't get merge conflicts in core-api/index

thanks,
Tobin.



[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