Skip to contentSkip to conversation

Documentation: Add two new rst files

PATCH In review Pragat Pandya 2 participants 12 messages Mar 2, 2020 – Mar 10, 2020 Documentation

lore
Share & tools
lore
#0 lore raw

cover Documentation: Add two new rst files

This patchset adds following two rst files to the Documentation and references the newly added rst files into TOCTree of index.rst
-io_mapping.rst
-io_ordering.rst

Pragat Pandya (2):
Documentation: Add a new .rst file under Documentation
Documentation: Add a new .rst file under Documentation

 Documentation/index.rst                       |  1 +
 .../{io-mapping.txt => io_mapping.rst}        |  0
 .../{io_ordering.txt => io_ordering.rst}      |  0
 doc_make.log                                  | 35 +++++++++++++++++++
 4 files changed, 36 insertions(+)
 rename Documentation/{io-mapping.txt => io_mapping.rst} (100%)
 rename Documentation/{io_ordering.txt => io_ordering.rst} (100%)
 create mode 100644 doc_make.log
Signature · 1 line
2.17.1
#1 lore raw

PATCH 1/2 Documentation: Add a new .rst file under Documentation

Add io_mapping.rst under Documentation and reference it in TOCTree of index.rst to include it in html documentation.

---
 Documentation/index.rst                       |   1 +
 .../{io-mapping.txt => io_mapping.rst}        |   0
 doc_make.log                                  | 372 ++++++++++++++++++
 3 files changed, 373 insertions(+)
 rename Documentation/{io-mapping.txt => io_mapping.rst} (100%)
 create mode 100644 doc_make.log
Documentation/index.rst +1 -0
index e99d0bd2589d..14670f2eaa33 100644
@@ -141,6 +141,7 @@ Architecture-agnostic documentation
    :maxdepth: 2
 
    asm-annotations
+   io_mapping
 
 Architecture-specific documentation
 -----------------------------------
Documentation/io_mapping.rst renamed from Documentation/io-mapping.txt +0 -0
similarity index 100%
rename from Documentation/io-mapping.txt
rename to Documentation/io_mapping.rst
doc_make.log new file +372 -0

372 lines not on this page · raw message

Signature · 1 line
2.17.1
maintainer
#2 lore raw

Re: [PATCH 1/2] Documentation: Add a new .rst file under Documentation

On Mon, 2 Mar 2020 23:09:19 +0530
Pragat Pandya <[email protected]> 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.

Quoted 2 lines

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.

Quoted 6 lines
---
 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.

Documentation/index.rst Architecture-agnostic documentation · line 144

Quoted 13 lines
 3 files changed, 373 insertions(+)
 rename Documentation/{io-mapping.txt => io_mapping.rst} (100%)
 create mode 100644 doc_make.log
Documentation/index.rst +1 -0
index e99d0bd2589d..14670f2eaa33 100644
@@ -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

#3 lore raw

v2 cover Documentation: Add files to driver-api manual

This patchset adds following two rst files under Documentation/driver-api and references these both in Sphinx TOC Tree in Documentation/driver-api/index.rst
-io-mapping.rst
-io_ordering.rst

v2:
-Provide more descriptive subject lines
-The document did not belong to top level so moved it to driver-api
manual

Pragat Pandya (2):
Documentation: Add io-mapping.rst to driver-api manual
Documentation: Add io_ordering.rst to driver-api manual

 Documentation/driver-api/index.rst       |  2 +
 Documentation/driver-api/io-mapping.rst  | 97 ++++++++++++++++++++++++
 Documentation/driver-api/io_ordering.rst | 51 +++++++++++++
 3 files changed, 150 insertions(+)
 create mode 100644 Documentation/driver-api/io-mapping.rst
 create mode 100644 Documentation/driver-api/io_ordering.rst
Signature · 1 line
2.17.1
#4 lore raw

PATCH v2 1/2 Documentation: Add io-mapping.rst to driver-api manual

Add io-mapping.rst under Documentation/driver-api and reference it from Sphinx TOC Tree present in Documentation/driver-api/index.rst

---
 Documentation/driver-api/index.rst      |  1 +
 Documentation/driver-api/io-mapping.rst | 97 +++++++++++++++++++++++++
 2 files changed, 98 insertions(+)
 create mode 100644 Documentation/driver-api/io-mapping.rst
Documentation/driver-api/index.rst +1 -0
index 0ebe205efd0c..e9da95004632 100644
@@ -79,6 +79,7 @@ available subsections can be seen below.
    ipmb
    isa
    isapnp
+   io-mapping
    generic-counter
    lightnvm-pblk
    memory-devices/index
Documentation/driver-api/io-mapping.rst new file +97 -0

97 lines not on this page · raw message

Signature · 1 line
2.17.1
#5 lore raw

PATCH v2 2/2 Documentation: Add io_ordering.rst to driver-api manual

In reply to Pragat Pandya

Add io_ordering.rst under Documentation/driver-api and reference it from Sphinx TOC Tree present in Documentation/driver-api/index.rst

---
 Documentation/driver-api/index.rst       |  1 +
 Documentation/driver-api/io_ordering.rst | 51 ++++++++++++++++++++++++
 2 files changed, 52 insertions(+)
 create mode 100644 Documentation/driver-api/io_ordering.rst
Documentation/driver-api/index.rst +1 -0
index e9da95004632..9335412e3832 100644
@@ -80,6 +80,7 @@ available subsections can be seen below.
    isa
    isapnp
    io-mapping
+   io_ordering
    generic-counter
    lightnvm-pblk
    memory-devices/index
Documentation/driver-api/io_ordering.rst new file +51 -0

51 lines not on this page · raw message

Signature · 1 line
2.17.1
maintainer
#6 lore raw

Re: [PATCH v2 0/2] Documentation: Add files to driver-api manual

In reply to Pragat Pandya
Quoted 15 lines · On Tue, 3 Mar 2020 00:01:03 +0530 Pragat Pandya <[email protected]>…

This patchset adds following two rst files under Documentation/driver-api and references these both in Sphinx TOC Tree in Documentation/driver-api/index.rst
-io-mapping.rst
-io_ordering.rst

v2:
-Provide more descriptive subject lines
-The document did not belong to top level so moved it to driver-api
manual

Pragat Pandya (2):
Documentation: Add io-mapping.rst to driver-api manual
Documentation: Add io_ordering.rst to driver-api manual

Quoted 6 lines
 Documentation/driver-api/index.rst       |  2 +
 Documentation/driver-api/io-mapping.rst  | 97 ++++++++++++++++++++++++
 Documentation/driver-api/io_ordering.rst | 51 +++++++++++++
 3 files changed, 150 insertions(+)
 create mode 100644 Documentation/driver-api/io-mapping.rst
 create mode 100644 Documentation/driver-api/io_ordering.rst

OK, we're getting closer. This series, though, leaves the old files in place. You should rename them over, rather than simply creating new files.

Thanks,

jon

#7 lore raw

v3 cover Documentation: Rename two txt files to rst

This patchset renames following two txt files to rst files and moves them to driver-api manual from top level.
-io-mapping.txt (Documentation/) -> io-mapping.rst(Documentation/driver-api/) -io_ordering.txt(Documentation/) -> io_ordering.rst(Documentation/driver-api/)

v2:
-Provide more descriptive subject lines.
-Move newly generated(rather renamed) rst files to driver-api manual
from top level documentation.
v3:
-In v2, the old files were left in place creating new rst files. -Rename the target files rather than simply creating new files.

Pragat Pandya (2):
Documentation: Add io-mapping.rst to driver-api manual
Documentation: Add io_ordering.rst to driver-api manual

 Documentation/driver-api/index.rst                            | 2 ++
 Documentation/{io-mapping.txt => driver-api/io-mapping.rst}   | 0
 Documentation/{io_ordering.txt => driver-api/io_ordering.rst} | 0
 3 files changed, 2 insertions(+)
 rename Documentation/{io-mapping.txt => driver-api/io-mapping.rst} (100%)
 rename Documentation/{io_ordering.txt => driver-api/io_ordering.rst} (100%)
Signature · 1 line
2.17.1
#8 lore raw

PATCH v3 1/2 Documentation: Add io-mapping.rst to driver-api manual

Add io-mapping.rst under Documentation/driver-api and reference it from Sphinx TOC Tree present in Documentation/driver-api/index.rst

---
 Documentation/driver-api/index.rst                          | 1 +
 Documentation/{io-mapping.txt => driver-api/io-mapping.rst} | 0
 2 files changed, 1 insertion(+)
 rename Documentation/{io-mapping.txt => driver-api/io-mapping.rst} (100%)
Documentation/driver-api/index.rst +1 -0
index 0ebe205efd0c..e9da95004632 100644
@@ -79,6 +79,7 @@ available subsections can be seen below.
    ipmb
    isa
    isapnp
+   io-mapping
    generic-counter
    lightnvm-pblk
    memory-devices/index
Documentation/driver-api/io-mapping.rst renamed from Documentation/io-mapping.txt +0 -0
similarity index 100%
rename from Documentation/io-mapping.txt
rename to Documentation/driver-api/io-mapping.rst
Signature · 1 line
2.17.1
#9 lore raw

PATCH v3 2/2 Documentation: Add io_ordering.rst to driver-api manual

In reply to Pragat Pandya

Add io_ordering.rst under Documentation/driver-api and reference it from the Sphinx TOC Tree present in Documentation/driver-api/index.rst

---
 Documentation/driver-api/index.rst                            | 1 +
 Documentation/{io_ordering.txt => driver-api/io_ordering.rst} | 0
 2 files changed, 1 insertion(+)
 rename Documentation/{io_ordering.txt => driver-api/io_ordering.rst} (100%)
Documentation/driver-api/index.rst +1 -0
index e9da95004632..9335412e3832 100644
@@ -80,6 +80,7 @@ available subsections can be seen below.
    isa
    isapnp
    io-mapping
+   io_ordering
    generic-counter
    lightnvm-pblk
    memory-devices/index
Documentation/driver-api/io_ordering.rst renamed from Documentation/io_ordering.txt +0 -0
similarity index 100%
rename from Documentation/io_ordering.txt
rename to Documentation/driver-api/io_ordering.rst
Signature · 1 line
2.17.1
maintainer
#10 lore raw

Re: [PATCH v3 0/2] Documentation: Rename two txt files to rst

In reply to Pragat Pandya
Quoted 5 lines · On Tue, 3 Mar 2020 10:32:59 +0530 Pragat Pandya <[email protected]>…

This patchset renames following two txt files to rst files and moves them to driver-api manual from top level.
-io-mapping.txt (Documentation/) -> io-mapping.rst(Documentation/driver-api/) -io_ordering.txt(Documentation/) -> io_ordering.rst(Documentation/driver-api/)

Quoted 8 lines

v2:
-Provide more descriptive subject lines.
-Move newly generated(rather renamed) rst files to driver-api manual
from top level documentation.
v3:
-In v2, the old files were left in place creating new rst files. -Rename the target files rather than simply creating new files.

Both patches applied, thanks.

jon

#11 lore raw

PATCH 2/2 Documentation: Add a new .rst file under Documentation

In reply to Pragat Pandya

Add io_ordering.rst under Documentation and reference it in TOCTree of index.rst to include it in html documentation.

---
 .../{io_ordering.txt => io_ordering.rst}      |   0
 doc_make.log                                  | 369 +-----------------
 2 files changed, 16 insertions(+), 353 deletions(-)
 rename Documentation/{io_ordering.txt => io_ordering.rst} (100%)
Documentation/io_ordering.rst renamed from Documentation/io_ordering.txt +0 -0
similarity index 100%
rename from Documentation/io_ordering.txt
rename to Documentation/io_ordering.rst
doc_make.log +16 -353

388 lines not on this page · raw message

Signature · 1 line
2.17.1