On 17/11/2021 11.25, Kashyap Chamarthy wrote:
...
+QEMU follows the usual standard for git commit messages: the first line
+(which becomes the email subject line) is "subsystem: single line
+summary of change". Whether the "single line summary of change" starts
+with a capital is a matter of taste, but we prefer that the summary does
+not end in ".".
That ".". looks a little bit weird in the output ... maybe we should replace
it with "does not end with a dot." ?
Re-looking the output, yes it does look odd. And yes, your amendment
is good.
I haven't updated that one while picking up the patch - so we might want to
fix it with an additional patch on top.
+The body of the commit message is a good place to document why your
+change is important. Don't include comments like "This is a suggestion
+for fixing this bug" (they can go below the "---" line in the email so
That --- gets translated into a — character ... I'll replace the "---" with
``---`` to fix it.
Ah, when I locally ran `rst2html5 submitting-a-patch.rst
submitting-a-patch.html` it retained the "---", but when I built QEMU
(`configure --target-list=x86_64-softmmu --enable-docs`), Sphinx does
turn it into an em-dash (—), and missed to notice it.
Thanks for the careful review and submitting the PR. I'm assuming I
don't need to respin a v4.
Right, patches have been merged now.
Something I just noticed afterwards, after looking at the pages online:
https://www.qemu.org/docs/master/devel/submitting-a-pull-request.html uses
"Submit" in the heading, while
https://www.qemu.org/docs/master/devel/submitting-a-patch.html uses
"Submitting" ... looks a little bit inconsequent ... should we change it to
use one form only? The Wiki used "submit", not "submitting", so maybe use
that one?
Thomas
