Gitiles
Code Review Sign In
gerrit.openbmc.org / premsjha / op-build / refs/heads/gh-pages / . / process / stable-rules.html
blob: 7e773393d4aa5ce721dfc428f1ab62a63ed7210d [file] [log] [blame]
Deployment Bot (from Travis CI)6d7e6e92021-06-14 19:18:41 +0000[diff] [blame]1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9 <title>op-build stable tree rules and releases &#8212; OpenPOWER Firmware v2.6-257-g5b5624c2
10 documentation</title>
11 <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
12 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13 <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
14 <script type="text/javascript" src="../_static/jquery.js"></script>
15 <script type="text/javascript" src="../_static/underscore.js"></script>
16 <script type="text/javascript" src="../_static/doctools.js"></script>
17 <link rel="index" title="Index" href="../genindex.html" />
18 <link rel="search" title="Search" href="../search.html" />
19 <link rel="next" title="Supported Boot Devices" href="../boot-devices.html" />
20 <link rel="prev" title="Building with ci scripts" href="building-with-ci.html" />
21
22 <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
23
24
25 <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
26
27 </head><body>
28
29
30 <div class="document">
31 <div class="documentwrapper">
32 <div class="bodywrapper">
33
34
35 <div class="body" role="main">
36
37 <div class="section" id="op-build-stable-tree-rules-and-releases">
38<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>
39<p>Our stable tree process follows processes similar to other open source projects
40such as the Linux Kernel and Buildroot, as do several OpenPOWER Firmware
41components such as Skiboot and Petitboot.</p>
42<p>The purpose of a -stable tree is to give vendors a stable base to create
43firmware releases from and to incorporate into service packs. New stable
44releases contain critical fixes only.</p>
45<p>As a general rule, only the most recent op-build release gets a maintained
46-stable tree. If you wish to maintain an older tree, speak up! For example,
47with my IBMer hat on, we’ll maintain branches that we ship in products.</p>
48<div class="section" id="what-patches-are-accepted">
49<h2>What patches are accepted?<a class="headerlink" href="#what-patches-are-accepted" title="Permalink to this headline"></a></h2>
50<ul class="simple">
51<li>Patches must be obviously correct and tested<ul>
52<li>A Tested-by signoff is <em>important</em></li>
53</ul>
54</li>
55<li>A patch must fix a real bug</li>
56<li>No trivial patches, such fixups belong in main branch</li>
57<li>Not fix a purely theoretical problem unless you can prove how
58it’s exploitable</li>
59<li>The patch, or an equivalent one, must already be in master<ul>
60<li>Submitting to both at the same time is okay, but back-porting is better</li>
61</ul>
62</li>
63</ul>
64</div>
65<div class="section" id="howto-submit-to-stable">
66<h2>HOWTO submit to stable<a class="headerlink" href="#howto-submit-to-stable" title="Permalink to this headline"></a></h2>
67<ol class="arabic">
68<li><p class="first">Make a pull request with “[stable op-build-N.N.y]” in subject (where N.N.y
69is the stable branch to which you are targeting)</p>
70<ul>
71<li><p class="first">This targets the patch <em>ONLY</em> to the stable branch.</p>
72<ul class="simple">
73<li>Such commits will <em>NOT</em> be merged into master.</li>
74</ul>
75</li>
76<li><p class="first">Use this when:</p>
77<ol class="loweralpha simple">
78<li>cherry-picking a fix from master</li>
79<li>fixing something that is only broken in stable</li>
80<li>fix in stable needs to be completely different than in master</li>
81</ol>
82<p>If b or c: explain why.</p>
83</li>
84<li><p class="first">If cherry-picking, include the following at the top of your
85commit message (or use the -x option to git-cherry-pick):</p>
86<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>
87</pre></div>
88</div>
89</li>
90<li><p class="first">If the patch has been modified, explain why in description.</p>
91</li>
92</ul>
93</li>
94<li><p class="first">Add a comment on the PR indicating that a PR should also go to a stable
95branch when making a Pull request to master</p>
96<ul class="simple">
97<li>This targets the patch to master and stable.</li>
98<li>You can target a patch to a specific stable tree by putting that in the
99comment</li>
100<li>You can ask for prerequisites to be cherry-picked.</li>
101</ul>
102</li>
103</ol>
104</div>
105<div class="section" id="trees">
106<h2>Trees<a class="headerlink" href="#trees" title="Permalink to this headline"></a></h2>
107<ul class="simple">
108<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>
109<li>(branches are op-build-X.Y.y - e.g. op-build-2.0.y)</li>
110</ul>
111</li>
112<li>Some stable versions may last longer than others<ul>
113<li>So there may be op-build-2.0.y and op-build-2.4.y actively maintained
114and op-build-2.0.y could possibly outlast op-build-2.4.y.</li>
115</ul>
116</li>
117</ul>
118</div>
119</div>
120
121
122 </div>
123
124 </div>
125 </div>
126 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
127 <div class="sphinxsidebarwrapper">
128<h1 class="logo"><a href="../index.html">OpenPOWER Firmware</a></h1>
129
130
131
132
133
134
135
136
137<h3>Navigation</h3>
138<p class="caption"><span class="caption-text">Contents:</span></p>
139<ul class="current">
140<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction to OpenPOWER Firmware</a></li>
141<li class="toctree-l1"><a class="reference internal" href="../testing.html">Testing op-build</a></li>
142<li class="toctree-l1 current"><a class="reference internal" href="index.html">Development Process</a><ul class="current">
143<li class="toctree-l2"><a class="reference internal" href="CONTRIBUTING.html">Contributing to op-build</a></li>
144<li class="toctree-l2"><a class="reference internal" href="KernelTree.html">op-build Linux Kernel</a></li>
145<li class="toctree-l2"><a class="reference internal" href="building-with-ci.html">Building with ci scripts</a></li>
146<li class="toctree-l2 current"><a class="current reference internal" href="#">op-build stable tree rules and releases</a></li>
147</ul>
148</li>
149<li class="toctree-l1"><a class="reference internal" href="../boot-devices.html">Supported Boot Devices</a></li>
150<li class="toctree-l1"><a class="reference internal" href="../versioning.html">Version Scheme</a></li>
151<li class="toctree-l1"><a class="reference internal" href="../release-notes/index.html">op-build Release Notes</a></li>
152</ul>
153
154<div class="relations">
155<h3>Related Topics</h3>
156<ul>
157 <li><a href="../index.html">Documentation overview</a><ul>
158 <li><a href="index.html">Development Process</a><ul>
159 <li>Previous: <a href="building-with-ci.html" title="previous chapter">Building with ci scripts</a></li>
160 <li>Next: <a href="../boot-devices.html" title="next chapter">Supported Boot Devices</a></li>
161 </ul></li>
162 </ul></li>
163</ul>
164</div>
165<div id="searchbox" style="display: none" role="search">
166 <h3>Quick search</h3>
167 <div class="searchformwrapper">
168 <form class="search" action="../search.html" method="get">
169 <input type="text" name="q" />
170 <input type="submit" value="Go" />
171 <input type="hidden" name="check_keywords" value="yes" />
172 <input type="hidden" name="area" value="default" />
173 </form>
174 </div>
175</div>
176<script type="text/javascript">$('#searchbox').show(0);</script>
177
178
179
180
181
182
183
184
185 </div>
186 </div>
187 <div class="clearer"></div>
188 </div>
189 <div class="footer">
190 &copy;2017, OpenPOWER Foundation System Software Work Group.
191
192 |
193 Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.9</a>
194 &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
195
196 |
197 <a href="../_sources/process/stable-rules.rst.txt"
198 rel="nofollow">Page source</a>
199 </div>
200
201
202
203
204 </body>
205</html>