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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20190510004104.GA12809@eros.localdomain>
Date:   Fri, 10 May 2019 10:41:04 +1000
From:   "Tobin C. Harding" <tobin@...nel.org>
To:     "Tobin C. Harding" <tobin@...nel.org>
Cc:     Jonathan Corbet <corbet@....net>, Corey Minyard <minyard@....org>,
        Thomas Hellstrom <thellstrom@...are.com>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] docs: Move kref.txt to core-api/kref.rst

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@...nel.org>
> ---
> 
> 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.