One Hat Cyber Team

Edit File: submitting-a-pull-request.html

<!DOCTYPE html>

 <html class="no-js" lang="en" > 
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Submitting a Pull Request &mdash; QEMU qemu-kvm-6.2.0-53.module+el8.10.0+2055+8eb7870b.4 documentation</title>

</head>

<a href="../index.html" class="icon icon-home"> QEMU

</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../about/index.html">About QEMU</a></li>
<li class="toctree-l1"><a class="reference internal" href="../system/index.html">System Emulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../user/index.html">User Mode Emulation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../interop/index.html">System Emulation Management and Interoperability</a></li>
<li class="toctree-l1"><a class="reference internal" href="../specs/index.html">System Emulation Guest Hardware Specifications</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer Information</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="code-of-conduct.html">Code of Conduct</a></li>
<li class="toctree-l2"><a class="reference internal" href="conflict-resolution.html">Conflict Resolution Policy</a></li>
<li class="toctree-l2"><a class="reference internal" href="build-system.html">The QEMU build system architecture</a></li>
<li class="toctree-l2"><a class="reference internal" href="style.html">QEMU Coding Style</a></li>
<li class="toctree-l2"><a class="reference internal" href="kconfig.html">QEMU and Kconfig</a></li>
<li class="toctree-l2"><a class="reference internal" href="testing.html">Testing in QEMU</a></li>
<li class="toctree-l2"><a class="reference internal" href="fuzzing.html">Fuzzing</a></li>
<li class="toctree-l2"><a class="reference internal" href="control-flow-integrity.html">Control-Flow Integrity (CFI)</a></li>
<li class="toctree-l2"><a class="reference internal" href="loads-stores.html">Load and Store APIs</a></li>
<li class="toctree-l2"><a class="reference internal" href="memory.html">The memory API</a></li>
<li class="toctree-l2"><a class="reference internal" href="migration.html">Migration</a></li>
<li class="toctree-l2"><a class="reference internal" href="atomics.html">Atomic operations in QEMU</a></li>
<li class="toctree-l2"><a class="reference internal" href="stable-process.html">QEMU and the stable process</a></li>
<li class="toctree-l2"><a class="reference internal" href="ci.html">CI</a></li>
<li class="toctree-l2"><a class="reference internal" href="qtest.html">QTest Device Emulation Testing Framework</a></li>
<li class="toctree-l2"><a class="reference internal" href="decodetree.html">Decodetree Specification</a></li>
<li class="toctree-l2"><a class="reference internal" href="secure-coding-practices.html">Secure Coding Practices</a></li>
<li class="toctree-l2"><a class="reference internal" href="tcg.html">Translator Internals</a></li>
<li class="toctree-l2"><a class="reference internal" href="tcg-icount.html">TCG Instruction Counting</a></li>
<li class="toctree-l2"><a class="reference internal" href="tracing.html">Tracing</a></li>
<li class="toctree-l2"><a class="reference internal" href="multi-thread-tcg.html">Multi-threaded TCG</a></li>
<li class="toctree-l2"><a class="reference internal" href="tcg-plugins.html">QEMU TCG Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="bitops.html">Bitwise operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="ui.html">QEMU UI subsystem</a></li>
<li class="toctree-l2"><a class="reference internal" href="reset.html">Reset in QEMU: the Resettable interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="s390-dasd-ipl.html">Booting from real channel-attached devices on s390x</a></li>
<li class="toctree-l2"><a class="reference internal" href="clocks.html">Modelling a clock tree in QEMU</a></li>
<li class="toctree-l2"><a class="reference internal" href="qom.html">The QEMU Object Model (QOM)</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules.html">QEMU modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="block-coroutine-wrapper.html">block-coroutine-wrapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="multi-process.html">Multi-process QEMU</a></li>
<li class="toctree-l2"><a class="reference internal" href="ebpf_rss.html">eBPF RSS virtio-net support</a></li>
<li class="toctree-l2"><a class="reference internal" href="vfio-migration.html">VFIO device Migration</a></li>
<li class="toctree-l2"><a class="reference internal" href="qapi-code-gen.html">How to use the QAPI code generator</a></li>
<li class="toctree-l2"><a class="reference internal" href="writing-monitor-commands.html">How to write monitor commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="trivial-patches.html">Trivial Patches</a></li>
<li class="toctree-l2"><a class="reference internal" href="submitting-a-patch.html">Submitting a Patch</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Submitting a Pull Request</a></li>
</ul>
</li>
</ul>

</div>
      </div>
    </nav>

<ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="index.html">Developer Information</a> &raquo;</li>
        
      <li>Submitting a Pull Request</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            
              <a href="https://gitlab.com/qemu-project/qemu/blob/master/docs/devel/submitting-a-pull-request.rst" class="fa fa-gitlab"> Edit on GitLab</a>
            
          
        
      </li>
    
  </ul>

<hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="submitting-a-pull-request">
<span id="id1"></span><h1>Submitting a Pull Request<a class="headerlink" href="#submitting-a-pull-request" title="Permalink to this headline">¶</a></h1>
<p>QEMU welcomes contributions of code, but we generally expect these to be
sent as simple patch emails to the mailing list (see our page on
<a class="reference internal" href="submitting-a-patch.html#submitting-a-patch"><span class="std std-ref">Submitting a Patch</span></a>
for more details).  Generally only existing submaintainers of a tree
will need to submit pull requests, although occasionally for a large
patch series we might ask a submitter to send a pull request. This page
documents our recommendations on pull requests for those people.</p>
<p>A good rule of thumb is not to send a pull request unless somebody asks
you to.</p>
<p><strong>Resend the patches with the pull request</strong> as emails which are
threaded as follow-ups to the pull request itself. The simplest way to
do this is to use <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">format-patch</span> <span class="pre">--cover-letter</span></code> to create the
emails, and then edit the cover letter to include the pull request
details that <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">request-pull</span></code> outputs.</p>
<p><strong>Use PULL as the subject line tag</strong> in both the cover letter and the
retransmitted patch mails (for example, by using
<code class="docutils literal notranslate"><span class="pre">--subject-prefix=PULL</span></code> in your <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">format-patch</span></code> command). This
helps people to filter in or out the resulting emails (especially useful
if they are only CC’d on one email out of the set).</p>
<p><strong>Each patch must have your own Signed-off-by: line</strong> as well as that of
the original author if the patch was not written by you. This is because
with a pull request you’re now indicating that the patch has passed via
you rather than directly from the original author.</p>
<p><strong>Don’t forget to add Reviewed-by: and Acked-by: lines</strong>. When other
people have reviewed the patches you’re putting in the pull request,
make sure you’ve copied their signoffs across. (If you use the <a class="reference external" href="https://github.com/stefanha/patches">patches
tool</a> to add patches from email
directly to your git repo it will include the tags automatically; if
you’re updating patches manually or in some other way you’ll need to
edit the commit messages by hand.)</p>
<p><strong>Don’t send pull requests for code that hasn’t passed review</strong>. A pull
request says these patches are ready to go into QEMU now, so they must
have passed the standard code review processes. In particular if you’ve
corrected issues in one round of code review, you need to send your
fixed patch series as normal to the list; you can’t put it in a pull
request until it’s gone through. (Extremely trivial fixes may be OK to
just fix in passing, but if in doubt err on the side of not.)</p>
<p><strong>Test before sending</strong>. This is an obvious thing to say, but make sure
everything builds (including that it compiles at each step of the patch
series) and that “make check” passes before sending out the pull
request. As a submaintainer you’re one of QEMU’s lines of defense
against bad code, so double check the details.</p>
<p><strong>All pull requests must be signed</strong>. If your key is not already signed
by members of the QEMU community, you should make arrangements to attend
a <a class="reference external" href="https://wiki.qemu.org/KeySigningParty">KeySigningParty</a> (for
example at KVM Forum) or make alternative arrangements to have your key
signed by an attendee.  Key signing requires meeting another community
member *in person* so please make appropriate arrangements.  By
“signed” here we mean that the pullreq email should quote a tag which is
a GPG-signed tag (as created with ‘gpg tag -s …’).</p>
<p><strong>Pull requests not for master should say “not for master” and have
“PULL SUBSYSTEM whatever” in the subject tag</strong>. If your pull request is
targeting a stable branch or some submaintainer tree, please include the
string “not for master” in the cover letter email, and make sure the
subject tag is “PULL SUBSYSTEM s390/block/whatever” rather than just
“PULL”. This allows it to be automatically filtered out of the set of
pull requests that should be applied to master.</p>
<p>You might be interested in the <a class="reference external" href="https://git.linaro.org/people/peter.maydell/misc-scripts.git/tree/make-pullreq">make-pullreq</a>
script which automates some of this process for you and includes a few
sanity checks. Note that you must edit it to configure it suitably for
your local situation!</p>
</div>

</div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
      
        <a href="submitting-a-patch.html" class="btn btn-neutral" title="Submitting a Patch" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>

<hr/>

<div role="contentinfo">
    <p>
        &copy; Copyright 2021, The QEMU Project Developers.

</p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

<p></p>

<p>This documentation is for QEMU version 6.2.0.</p>

<p><a href="../about/license.html">QEMU and this manual are released under the
GNU General Public License, version 2.</a></p>

</footer>

</div>
      </div>

</section>

</div>

</body>
</html>