docs/devel/submitting-a-patch.rst

9 help make our task of contribution review easier and your change is
21    * - Patches contain Signed-off-by: Your Name <author@email>
35 to allow your address.
37 The larger your contribution is, or if you plan on becoming a long-term
47 Writing your Patches
78 line ``Based-on: $MESSAGE_ID`` to your cover letter to make the series
139 same patch as your bug fix.
159 description of the patch, another blank and your Signed-off-by: line.
160 Please do not use lines that are longer than 76 characters in your
164 The body of the commit message is a good place to document why your
173 If your patch fixes a commit that is already in the repository, please
175 ("Fixed commit subject")" below the patch description / before your
178 If your patch fixes a bug in the gitlab bug tracker, please add a line
181 merged into the master branch of the project. And if your patch addresses
197 Test your patches
202 have already tested that your patch compiles and works. Because QEMU
206 running of tests; but it is still wise to also check that your patches
207 work with a full build before submitting a series, especially if your
213 your patches - either to ensure that future changes won't regress your
215 your series fixes. Keeping separate commits for the test and the fix
222 Submitting your Patches
249     $ # work on new commits, add your 'Signed-off-by' lines to each
269 emails. You can use `sourcehut <https://sourcehut.org/>`__ to send your
272 #. Register or sign in to your account
273 #. Add your SSH public key in `meta \|
275 #. Publish your git branch using **git push git@git.sr.ht:~USERNAME/qemu
277 #. Send your patches to the QEMU mailing list using the web-based
345 Your patches **must** include a Signed-off-by: line. This is a hard
364 When reviewers don't know your goal at the start of their review, they
371 Make sure your cover letter includes a diffstat of changes made over the
373 in, and they need an easy way determine if your series touches them.
384 intend for your patchset to be applied to master, but would like some
405 Consider whether your patch is applicable for stable
408 If your patch fixes a severe issue or a regression, it may be applicable
410 to your patch to notify the stable maintainers.
420 If you want to apply an existing series on top of your tree, you can simply use
438 read replies to your messages and be willing to act on them.
444 your current approach.
457 respond to these, and then send a second version of your patches with
458 the issues fixed. This takes a little time and effort on your part, but
459 if you don't do it then your changes will never get into QEMU.
461 Remember that a maintainer is under no obligation to take your
462 patches. If someone has spent the time reviewing your code and
466 merge and then fix up your code after the fact.
468 When replying to comments on your patches **reply to all and not just
479 Someone took their time to review your work, and it pays to respect that
481 from the previous round tends to alienate reviewers and stall your
483 argue that your code was correct in the first place instead of blindly
485 pointed out a potential issue during review, then even if your code
487 your commit message and/or comments in the code explaining why the code
557 version, to make it easier to focus a reviewer's attention to your
562 If your patch seems to have been ignored
565 If your patchset has received no replies you should "ping" it after a
570 double-checking for reasons why your patch might have been ignored
573 areas of QEMU patches do just slip through the cracks. If your ping is
575 are the person with the most motivation to get your patch applied, so
587 send you an automated mail if it detected a problem with your patch.
589 Once your patch has had enough review on list, the maintainer for that
591 your patch in a particular staging branch. Periodically, the maintainer
596 may further modify your commit, by resolving simple merge conflicts or
601 resolve the problems. It may take a couple of weeks between when your
614 base as well as a maintainer; it's perfectly fine to admit when your