[Qemu-commits] [qemu/qemu] cd6b16: docs: Fix botched rST conversion of 'submitting-a-...

[Richard Henderson]

  Branch: refs/heads/staging
  Home:   https://github.com/qemu/qemu
  Commit: cd6b1674d61120a77823b99516d27486c4f4f883
      
https://github.com/qemu/qemu/commit/cd6b1674d61120a77823b99516d27486c4f4f883
  Author: Kashyap Chamarthy <kchamart@redhat.com>
  Date:   2021-11-22 (Mon, 22 Nov 2021)

  Changed paths:
    M docs/devel/stable-process.rst
    M docs/devel/style.rst
    M docs/devel/submitting-a-patch.rst
    M docs/devel/submitting-a-pull-request.rst
    M docs/devel/trivial-patches.rst

  Log Message:
  -----------
  docs: Fix botched rST conversion of 'submitting-a-patch.rst'

I completely botched up the merged[0] rST conversion of this document by
accidentally dropping entire hunks (!) of text. :-(  I made it very hard
for reviewers to spot it, as the omitted text was buried deep in the
document.  To fix my hatchet job, I reconverted the "SubmitAPatch"
wiki[1] page from scratch and replaced the existing rST with it, while
making sure I incorporated previous feedback.

In summary, in this reconverted edition:

- I did a careful (to the extent my eyes allowed) para-by-para
  comparison of the wiki and the rST to make sure I didn't omit
  anything accidentally.

- I made sure to work in the cosmetic feedback[2] that Thomas Huth
  pointed out in the merged (and botched) edition:

   - fix the hyperlinks in "Split up long patches"

   - replace ".". with "does not end with a dot" (in "Write a meaningful
     commit message" section)

   - replace "---" with ``---`` so that it doesn't render as an em-dash
     (there were two other occurrences; I fixed those too)

- Use "QEMU" spelling consistently in prose usage

- Add a consistent "refer to git-config" link where appropriate

Thanks to Thomas Huth and Alex Bennée for noticing it on IRC.  And sorry
for my sloppiness.

Fixes: 9f73de8df033 ("docs: rSTify the "SubmitAPatch" wiki")

[0] https://gitlab.com/qemu-project/qemu/-/commit/9f73de8df033
[1] https://wiki.qemu.org/index.php?title=Contribute/SubmitAPatch&oldid=10387
[2] https://lists.nongnu.org/archive/html/qemu-devel/2021-11/msg03600.html

Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
Message-Id: <20211119193118.949698-2-kchamart@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
[thuth: Some more cosmetical changes, fixed links from external to internal]
Signed-off-by: Thomas Huth <thuth@redhat.com>


  Commit: 93e86b1664951f02fceed9ac312576f60232d503
      
https://github.com/qemu/qemu/commit/93e86b1664951f02fceed9ac312576f60232d503
  Author: Kashyap Chamarthy <kchamart@redhat.com>
  Date:   2021-11-22 (Mon, 22 Nov 2021)

  Changed paths:
    M docs/devel/submitting-a-patch.rst

  Log Message:
  -----------
  docs: List more commit-message tags in "submitting-a-patch"

Add some more examples of commonly used commit-message tags.

(Thanks: Alex Bennée)

Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
Message-Id: <20211119193118.949698-3-kchamart@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>


  Commit: b980c1aec63908074040e5cab135728e3b5db117
      
https://github.com/qemu/qemu/commit/b980c1aec63908074040e5cab135728e3b5db117
  Author: Stefan Weil <sw@weilnetz.de>
  Date:   2021-11-22 (Mon, 22 Nov 2021)

  Changed paths:
    M docs/devel/multi-process.rst
    M docs/devel/qgraph.rst
    M docs/devel/writing-monitor-commands.rst
    M docs/hyperv.txt
    M docs/system/cpu-models-x86.rst.inc
    M docs/system/devices/nvme.rst
    M docs/system/gdb.rst
    M docs/system/ppc/ppce500.rst
    M docs/system/riscv/shakti-c.rst

  Log Message:
  -----------
  Fix some typos in documentation (found by codespell)

Signed-off-by: Stefan Weil <sw@weilnetz.de>
Message-Id: <20211117210702.1393570-1-sw@weilnetz.de>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
[thuth: "what's" --> "what is" as suggested by philmd]
Signed-off-by: Thomas Huth <thuth@redhat.com>


  Commit: 8f75cae2dda8a55eb3a6c712bd22b18a90c0a5ac
      
https://github.com/qemu/qemu/commit/8f75cae2dda8a55eb3a6c712bd22b18a90c0a5ac
  Author: Rao, Lei <lei.rao@intel.com>
  Date:   2021-11-22 (Mon, 22 Nov 2021)

  Changed paths:
    M docs/COLO-FT.txt
    M docs/system/authz.rst
    M docs/throttle.txt
    M docs/tools/qemu-nbd.rst

  Log Message:
  -----------
  docs: Drop deprecated 'props' from object-add

In commit 5024340745 "qapi/qom: Drop deprecated 'props' from
object-add" (v6.0.0), we also should update documents.

Signed-off-by: Lei Rao <lei.rao@intel.com>
Message-Id: <1637567387-28250-1-git-send-email-lei.rao@intel.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>


  Commit: eff708a876b40fe71bedb792d084972d7a52166a
      
https://github.com/qemu/qemu/commit/eff708a876b40fe71bedb792d084972d7a52166a
  Author: Rao, Lei <lei.rao@intel.com>
  Date:   2021-11-22 (Mon, 22 Nov 2021)

  Changed paths:
    M docs/COLO-FT.txt
    M docs/block-replication.txt

  Log Message:
  -----------
  docs: Use double quotes instead of single quotes for COLO

Signed-off-by: Lei Rao <lei.rao@intel.com>
Message-Id: <1637567387-28250-2-git-send-email-lei.rao@intel.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>


  Commit: c5ba62195427d65a44472901cff3dddffc14b3b3
      
https://github.com/qemu/qemu/commit/c5ba62195427d65a44472901cff3dddffc14b3b3
  Author: Philippe Mathieu-Daudé <philmd@redhat.com>
  Date:   2021-11-22 (Mon, 22 Nov 2021)

  Changed paths:
    M docs/about/removed-features.rst
    M docs/devel/build-system.rst
    M docs/devel/multi-process.rst
    M docs/devel/testing.rst
    M docs/image-fuzzer.txt
    M docs/system/arm/orangepi.rst
    M docs/system/images.rst
    M docs/system/qemu-block-drivers.rst.inc
    M docs/system/tls.rst
    M docs/tools/qemu-img.rst
    M docs/tools/qemu-nbd.rst
    M docs/tools/qemu-storage-daemon.rst
    M docs/tools/virtiofsd.rst

  Log Message:
  -----------
  docs: Render binary names as monospaced text

Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-Id: <20211118192744.64325-1-philmd@redhat.com>
Reviewed-by: Darren Kenny <darren.kenny@oracle.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>


  Commit: 3c87012e3887e8a904a3494283c4acfa7ef777dc
      
https://github.com/qemu/qemu/commit/3c87012e3887e8a904a3494283c4acfa7ef777dc
  Author: Richard Henderson <richard.henderson@linaro.org>
  Date:   2021-11-22 (Mon, 22 Nov 2021)

  Changed paths:
    M docs/COLO-FT.txt
    M docs/about/removed-features.rst
    M docs/block-replication.txt
    M docs/devel/build-system.rst
    M docs/devel/multi-process.rst
    M docs/devel/qgraph.rst
    M docs/devel/stable-process.rst
    M docs/devel/style.rst
    M docs/devel/submitting-a-patch.rst
    M docs/devel/submitting-a-pull-request.rst
    M docs/devel/testing.rst
    M docs/devel/trivial-patches.rst
    M docs/devel/writing-monitor-commands.rst
    M docs/hyperv.txt
    M docs/image-fuzzer.txt
    M docs/system/arm/orangepi.rst
    M docs/system/authz.rst
    M docs/system/cpu-models-x86.rst.inc
    M docs/system/devices/nvme.rst
    M docs/system/gdb.rst
    M docs/system/images.rst
    M docs/system/ppc/ppce500.rst
    M docs/system/qemu-block-drivers.rst.inc
    M docs/system/riscv/shakti-c.rst
    M docs/system/tls.rst
    M docs/throttle.txt
    M docs/tools/qemu-img.rst
    M docs/tools/qemu-nbd.rst
    M docs/tools/qemu-storage-daemon.rst
    M docs/tools/virtiofsd.rst

  Log Message:
  -----------
  Merge tag 'pull-request-2021-11-22' of https://gitlab.com/thuth/qemu into 
staging

* Documentation updates

# gpg: Signature made Mon 22 Nov 2021 03:05:39 PM CET
# gpg:                using RSA key 27B88847EEE0250118F3EAB92ED9D774FE702DB5
# gpg:                issuer "thuth@redhat.com"
# gpg: Good signature from "Thomas Huth <th.huth@gmx.de>" [full]
# gpg:                 aka "Thomas Huth <thuth@redhat.com>" [full]
# gpg:                 aka "Thomas Huth <th.huth@posteo.de>" [unknown]
# gpg:                 aka "Thomas Huth <huth@tuxfamily.org>" [full]

* tag 'pull-request-2021-11-22' of https://gitlab.com/thuth/qemu:
  docs: Render binary names as monospaced text
  docs: Use double quotes instead of single quotes for COLO
  docs: Drop deprecated 'props' from object-add
  Fix some typos in documentation (found by codespell)
  docs: List more commit-message tags in "submitting-a-patch"
  docs: Fix botched rST conversion of 'submitting-a-patch.rst'

Signed-off-by: Richard Henderson <richard.henderson@linaro.org>


Compare: https://github.com/qemu/qemu/compare/d8a6311dabe6...3c87012e3887