From: "Tobin C. Harding" <tobin@kernel.org>
To: "Tobin C. Harding" <tobin@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>, Corey Minyard <minyard@acm.org>,
Thomas Hellstrom <thellstrom@vmware.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs: Move kref.txt to core-api/kref.rst
Date: Fri, 10 May 2019 10:41:04 +1000 [thread overview]
Message-ID: <20190510004104.GA12809@eros.localdomain> (raw)
In-Reply-To: <20190510001747.8767-1-tobin@kernel.org>
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@kernel.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.
next prev parent reply other threads:[~2019-05-10 0:41 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-10 0:17 [PATCH] docs: Move kref.txt to core-api/kref.rst Tobin C. Harding
2019-05-10 0:41 ` Tobin C. Harding [this message]
2019-05-10 14:17 ` Jonathan Corbet
2019-05-10 10:50 ` Thomas Hellstrom
2019-05-10 20:45 ` Tobin C. Harding
2019-05-15 16:56 ` [TRIVIA] " Jonathan Corbet
2019-05-16 23:19 ` Tobin C. Harding
2019-05-20 18:23 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190510004104.GA12809@eros.localdomain \
--to=tobin@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=minyard@acm.org \
--cc=thellstrom@vmware.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).