blob: 7e773393d4aa5ce721dfc428f1ab62a63ed7210d [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>op-build stable tree rules and releases &#8212; OpenPOWER Firmware v2.6-257-g5b5624c2
documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Supported Boot Devices" href="../boot-devices.html" />
<link rel="prev" title="Building with ci scripts" href="building-with-ci.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="op-build-stable-tree-rules-and-releases">
<span id="stable-rules"></span><h1>op-build stable tree rules and releases<a class="headerlink" href="#op-build-stable-tree-rules-and-releases" title="Permalink to this headline"></a></h1>
<p>Our stable tree process follows processes similar to other open source projects
such as the Linux Kernel and Buildroot, as do several OpenPOWER Firmware
components such as Skiboot and Petitboot.</p>
<p>The purpose of a -stable tree is to give vendors a stable base to create
firmware releases from and to incorporate into service packs. New stable
releases contain critical fixes only.</p>
<p>As a general rule, only the most recent op-build release gets a maintained
-stable tree. If you wish to maintain an older tree, speak up! For example,
with my IBMer hat on, we’ll maintain branches that we ship in products.</p>
<div class="section" id="what-patches-are-accepted">
<h2>What patches are accepted?<a class="headerlink" href="#what-patches-are-accepted" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Patches must be obviously correct and tested<ul>
<li>A Tested-by signoff is <em>important</em></li>
</ul>
</li>
<li>A patch must fix a real bug</li>
<li>No trivial patches, such fixups belong in main branch</li>
<li>Not fix a purely theoretical problem unless you can prove how
it’s exploitable</li>
<li>The patch, or an equivalent one, must already be in master<ul>
<li>Submitting to both at the same time is okay, but back-porting is better</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="howto-submit-to-stable">
<h2>HOWTO submit to stable<a class="headerlink" href="#howto-submit-to-stable" title="Permalink to this headline"></a></h2>
<ol class="arabic">
<li><p class="first">Make a pull request with “[stable op-build-N.N.y]” in subject (where N.N.y
is the stable branch to which you are targeting)</p>
<ul>
<li><p class="first">This targets the patch <em>ONLY</em> to the stable branch.</p>
<ul class="simple">
<li>Such commits will <em>NOT</em> be merged into master.</li>
</ul>
</li>
<li><p class="first">Use this when:</p>
<ol class="loweralpha simple">
<li>cherry-picking a fix from master</li>
<li>fixing something that is only broken in stable</li>
<li>fix in stable needs to be completely different than in master</li>
</ol>
<p>If b or c: explain why.</p>
</li>
<li><p class="first">If cherry-picking, include the following at the top of your
commit message (or use the -x option to git-cherry-pick):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">commit</span> <span class="o">&lt;</span><span class="n">sha1</span><span class="o">&gt;</span> <span class="n">upstream</span><span class="o">.</span>
</pre></div>
</div>
</li>
<li><p class="first">If the patch has been modified, explain why in description.</p>
</li>
</ul>
</li>
<li><p class="first">Add a comment on the PR indicating that a PR should also go to a stable
branch when making a Pull request to master</p>
<ul class="simple">
<li>This targets the patch to master and stable.</li>
<li>You can target a patch to a specific stable tree by putting that in the
comment</li>
<li>You can ask for prerequisites to be cherry-picked.</li>
</ul>
</li>
</ol>
</div>
<div class="section" id="trees">
<h2>Trees<a class="headerlink" href="#trees" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><a class="reference external" href="https://github.com/open-power/op-build/">https://github.com/open-power/op-build/</a> (or via ssh at <code class="docutils literal notranslate"><span class="pre">git&#64;github.com:open-power/op-build.git</span></code> )<ul>
<li>(branches are op-build-X.Y.y - e.g. op-build-2.0.y)</li>
</ul>
</li>
<li>Some stable versions may last longer than others<ul>
<li>So there may be op-build-2.0.y and op-build-2.4.y actively maintained
and op-build-2.0.y could possibly outlast op-build-2.4.y.</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">OpenPOWER Firmware</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction to OpenPOWER Firmware</a></li>
<li class="toctree-l1"><a class="reference internal" href="../testing.html">Testing op-build</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Development Process</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="CONTRIBUTING.html">Contributing to op-build</a></li>
<li class="toctree-l2"><a class="reference internal" href="KernelTree.html">op-build Linux Kernel</a></li>
<li class="toctree-l2"><a class="reference internal" href="building-with-ci.html">Building with ci scripts</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">op-build stable tree rules and releases</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../boot-devices.html">Supported Boot Devices</a></li>
<li class="toctree-l1"><a class="reference internal" href="../versioning.html">Version Scheme</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release-notes/index.html">op-build Release Notes</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">Development Process</a><ul>
<li>Previous: <a href="building-with-ci.html" title="previous chapter">Building with ci scripts</a></li>
<li>Next: <a href="../boot-devices.html" title="next chapter">Supported Boot Devices</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017, OpenPOWER Foundation System Software Work Group.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.9</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="../_sources/process/stable-rules.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>