From: Jonathan Corbet <corbet@lwn.net>
To: Pragat Pandya <pragat.pandya@gmail.com>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-kernel-mentees@lists.linuxfoundation.org,
skhan@linuxfoundation.org
Subject: Re: [PATCH 1/2] Documentation: Add a new .rst file under Documentation
Date: Mon, 2 Mar 2020 10:45:01 -0700 [thread overview]
Message-ID: <20200302104501.0f9987bb@lwn.net> (raw)
In-Reply-To: <20200302173920.24626-2-pragat.pandya@gmail.com>
On Mon, 2 Mar 2020 23:09:19 +0530
Pragat Pandya <pragat.pandya@gmail.com> wrote:
Thanks for working to make the documentation better. A few comments,
though... To begin with, please give a more descriptive subject line; any
time you have multiple patches with the same subject line you should be
seeing an indicator that you're not giving enough information there.
> Add io_mapping.rst under Documentation and reference it in TOCTree of
> index.rst to include it in html documentation.
You're not adding a file, you're renaming an existing file; say that.
>
> Signed-off-by: Pragat Pandya <pragat.pandya@gmail.com>
> ---
> Documentation/index.rst | 1 +
> .../{io-mapping.txt => io_mapping.rst} | 0
> doc_make.log | 372 ++++++++++++++++++
This doc_make.log file certainly doesn't belong here; please look
carefully at your patches before sending them.
> 3 files changed, 373 insertions(+)
> rename Documentation/{io-mapping.txt => io_mapping.rst} (100%)
> create mode 100644 doc_make.log
>
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index e99d0bd2589d..14670f2eaa33 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -141,6 +141,7 @@ Architecture-agnostic documentation
> :maxdepth: 2
>
> asm-annotations
> + io_mapping
Is there a reason you changed the name (io-mapping to io_mapping)? If so,
you should explain it.
Finally, this document really doesn't belong in the top level. Please
move it into the driver-api manual.
Thanks,
jon
next prev parent reply other threads:[~2020-03-02 17:45 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-02 17:39 [PATCH 0/2] Documentation: Add two new rst files Pragat Pandya
2020-03-02 17:39 ` [PATCH 1/2] Documentation: Add a new .rst file under Documentation Pragat Pandya
2020-03-02 17:45 ` Jonathan Corbet [this message]
2020-03-02 18:31 ` [PATCH v2 0/2] Documentation: Add files to driver-api manual Pragat Pandya
2020-03-02 18:31 ` [PATCH v2 1/2] Documentation: Add io-mapping.rst " Pragat Pandya
2020-03-02 18:31 ` [PATCH v2 2/2] Documentation: Add io_ordering.rst " Pragat Pandya
2020-03-02 18:43 ` [PATCH v2 0/2] Documentation: Add files " Jonathan Corbet
2020-03-03 5:02 ` [PATCH v3 0/2] Documentation: Rename two txt files to rst Pragat Pandya
2020-03-03 5:03 ` [PATCH v3 1/2] Documentation: Add io-mapping.rst to driver-api manual Pragat Pandya
2020-03-03 5:03 ` [PATCH v3 2/2] Documentation: Add io_ordering.rst " Pragat Pandya
2020-03-10 17:34 ` [PATCH v3 0/2] Documentation: Rename two txt files to rst Jonathan Corbet
2020-03-02 17:39 ` [PATCH 2/2] Documentation: Add a new .rst file under Documentation Pragat Pandya
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=20200302104501.0f9987bb@lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linuxfoundation.org \
--cc=linux-kernel@vger.kernel.org \
--cc=pragat.pandya@gmail.com \
--cc=skhan@linuxfoundation.org \
/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).