[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v3 3/3] docs: rSTify the "SubmitAPatch" wiki

From: Thomas Huth
Subject: Re: [PATCH v3 3/3] docs: rSTify the "SubmitAPatch" wiki
Date: Wed, 17 Nov 2021 15:43:56 +0100
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.3.0

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?


reply via email to

[Prev in Thread] Current Thread [Next in Thread]