docs: Fix botched rST conversion of 'submitting-a-patch.rst'
authorKashyap Chamarthy <kchamart@redhat.com>
Fri, 19 Nov 2021 19:31:17 +0000 (20:31 +0100)
committerThomas Huth <thuth@redhat.com>
Mon, 22 Nov 2021 14:02:38 +0000 (15:02 +0100)
commitcd6b1674d61120a77823b99516d27486c4f4f883
tree0896b95fc90437a81091283839ade3a2fba9739f
parentc5fbdd60cf1fb52f01bdfe342b6fa65d5343e1b1
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>
docs/devel/stable-process.rst
docs/devel/style.rst
docs/devel/submitting-a-patch.rst
docs/devel/submitting-a-pull-request.rst
docs/devel/trivial-patches.rst