On Wed, Nov 17, 2021 at 10:08:52AM +0100, Thomas Huth wrote: > On 10/11/2021 15.49, Kashyap Chamarthy wrote:
[...] > > writing-qmp-commands > > trivial-patches > > submitting-a-pull-request > > + submitting-a-patch > > I'd suggest to insert this before the pull-request entry, in case anybody > reads the manual sequentially, it might be better to learn about the patch > submission process first before reading about pull requests. I did notice it when looking at the rendered output, and still missed to fix it; bad me. > (I can fix this up when picking up the patch, no need to resend) Thank you. [...] > > +Split up longer patches into a patch series of logical code changes. > > +Each change should compile and execute successfully. For instance, don't > > +add a file to the makefile in patch one and then add the file itself in > > +patch two. (This rule is here so that people can later use tools like > > +```git bisect`` <http://git-scm.com/docs/git-bisect>`__ without hitting > > That hyperlink showed up in the rendered output. I'll fix it up by removing > the "``" quotes. Oops, good catch. [...] > > +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. [...] > > +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. -- /kashyap
