Messages in this thread | | | Date | Mon, 2 Mar 2020 10:45:01 -0700 | From | Jonathan Corbet <> | Subject | Re: [PATCH 1/2] Documentation: Add a new .rst file under Documentation |
| |
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
| |