add doc build files
[pti/rtp.git] / docs / _build / html / release-notes.html
1 <!DOCTYPE html>
2
3 <html xmlns="http://www.w3.org/1999/xhtml">
4   <head>
5     <meta charset="utf-8" />
6     <title>Release-Notes &#8212; pti-rtp master documentation</title>
7     <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
8     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
9     <link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
10     <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
11     <script type="text/javascript" src="_static/jquery.js"></script>
12     <script type="text/javascript" src="_static/underscore.js"></script>
13     <script type="text/javascript" src="_static/doctools.js"></script>
14     <script type="text/javascript" src="_static/language_data.js"></script>
15     <link rel="shortcut icon" href="_static/favicon.ico"/>
16     <link rel="index" title="Index" href="genindex.html" />
17     <link rel="search" title="Search" href="search.html" />
18     <link rel="prev" title="Developer-Guide" href="developer-guide.html" />
19 <meta charset='utf-8'>
20 <meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
21 <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
22 <meta name="apple-mobile-web-app-capable" content="yes">
23 <script type="text/javascript" src="_static/js/jquery-1.11.0.min.js "></script>
24 <script type="text/javascript" src="_static/js/jquery-fix.js "></script>
25 <script type="text/javascript" src="_static/bootstrap-3.3.7/js/bootstrap.min.js "></script>
26 <script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>
27
28   </head><body>
29
30   <div id="navbar" class="navbar navbar-default navbar-fixed-top">
31     <div class="container">
32       <div class="navbar-header">
33         <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
34         <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
35           <span class="icon-bar"></span>
36           <span class="icon-bar"></span>
37           <span class="icon-bar"></span>
38         </button>
39         <a class="navbar-brand" href="index.html"><span><img src="_static/logo.png"></span>
40           pti-rtp</a>
41         <span class="navbar-text navbar-version pull-left"><b>master</b></span>
42       </div>
43
44         <div class="collapse navbar-collapse nav-collapse">
45           <ul class="nav navbar-nav">
46             
47             
48               <li class="dropdown globaltoc-container">
49   <a role="button"
50      id="dLabelGlobalToc"
51      data-toggle="dropdown"
52      data-target="#"
53      href="index.html">Site <b class="caret"></b></a>
54   <ul class="dropdown-menu globaltoc"
55       role="menu"
56       aria-labelledby="dLabelGlobalToc"><p class="caption"><span class="caption-text">Contents:</span></p>
57 <ul class="current">
58 <li class="toctree-l1"><a class="reference internal" href="overview.html">RTP Overview</a></li>
59 <li class="toctree-l1"><a class="reference internal" href="developer-guide.html">Developer-Guide</a></li>
60 <li class="toctree-l1 current"><a class="current reference internal" href="#">Release-Notes</a></li>
61 </ul>
62 </ul>
63 </li>
64               
65                 <li class="dropdown">
66   <a role="button"
67      id="dLabelLocalToc"
68      data-toggle="dropdown"
69      data-target="#"
70      href="#">Page <b class="caret"></b></a>
71   <ul class="dropdown-menu localtoc"
72       role="menu"
73       aria-labelledby="dLabelLocalToc"><ul>
74 <li><a class="reference internal" href="#">Release-Notes</a><ul>
75 <li><a class="reference internal" href="#version-history">Version history</a></li>
76 <li><a class="reference internal" href="#summary">Summary</a></li>
77 <li><a class="reference internal" href="#release-data">Release Data</a><ul>
78 <li><a class="reference internal" href="#feature-additions">Feature Additions</a></li>
79 <li><a class="reference internal" href="#bug-corrections">Bug Corrections</a></li>
80 <li><a class="reference internal" href="#deliverables">Deliverables</a><ul>
81 <li><a class="reference internal" href="#software-deliverables">Software Deliverables</a></li>
82 <li><a class="reference internal" href="#documentation-deliverables">Documentation Deliverables</a></li>
83 </ul>
84 </li>
85 </ul>
86 </li>
87 <li><a class="reference internal" href="#known-limitations-issues-and-workarounds">Known Limitations, Issues and Workarounds</a><ul>
88 <li><a class="reference internal" href="#system-limitations">System Limitations</a></li>
89 <li><a class="reference internal" href="#known-issues">Known Issues</a></li>
90 <li><a class="reference internal" href="#workarounds">Workarounds</a></li>
91 </ul>
92 </li>
93 <li><a class="reference internal" href="#references">References</a></li>
94 </ul>
95 </li>
96 </ul>
97 </ul>
98 </li>
99               
100             
101             
102             
103             
104             
105           </ul>
106
107           
108             
109 <form class="navbar-form navbar-right" action="search.html" method="get">
110  <div class="form-group">
111   <input type="text" name="q" class="form-control" placeholder="Search" />
112  </div>
113   <input type="hidden" name="check_keywords" value="yes" />
114   <input type="hidden" name="area" value="default" />
115 </form>
116           
117         </div>
118     </div>
119   </div>
120
121 <div class="container">
122   <div class="row">
123       <div class="col-md-3">
124         <div id="sidebar" class="bs-sidenav" role="complementary"><ul>
125 <li><a class="reference internal" href="#">Release-Notes</a><ul>
126 <li><a class="reference internal" href="#version-history">Version history</a></li>
127 <li><a class="reference internal" href="#summary">Summary</a></li>
128 <li><a class="reference internal" href="#release-data">Release Data</a><ul>
129 <li><a class="reference internal" href="#feature-additions">Feature Additions</a></li>
130 <li><a class="reference internal" href="#bug-corrections">Bug Corrections</a></li>
131 <li><a class="reference internal" href="#deliverables">Deliverables</a><ul>
132 <li><a class="reference internal" href="#software-deliverables">Software Deliverables</a></li>
133 <li><a class="reference internal" href="#documentation-deliverables">Documentation Deliverables</a></li>
134 </ul>
135 </li>
136 </ul>
137 </li>
138 <li><a class="reference internal" href="#known-limitations-issues-and-workarounds">Known Limitations, Issues and Workarounds</a><ul>
139 <li><a class="reference internal" href="#system-limitations">System Limitations</a></li>
140 <li><a class="reference internal" href="#known-issues">Known Issues</a></li>
141 <li><a class="reference internal" href="#workarounds">Workarounds</a></li>
142 </ul>
143 </li>
144 <li><a class="reference internal" href="#references">References</a></li>
145 </ul>
146 </li>
147 </ul>
148
149   <li>
150     <a href="developer-guide.html" title="Previous Chapter: Developer-Guide"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">&laquo; Developer-Guide</span>
151     </a>
152   </li>
153         </div>
154       </div>
155     <div class="body col-md-9 content" role="main">
156       
157   <div class="section" id="release-notes">
158 <h1>Release-Notes<a class="headerlink" href="#release-notes" title="Permalink to this headline">¶</a></h1>
159 <p>This document provides the release notes for &lt;RELEASE&gt; of &lt;COMPONENT&gt;.</p>
160 <div class="contents local topic" id="contents">
161 <ul class="simple">
162 <li><p><a class="reference internal" href="#version-history" id="id1">Version history</a></p></li>
163 <li><p><a class="reference internal" href="#summary" id="id2">Summary</a></p></li>
164 <li><p><a class="reference internal" href="#release-data" id="id3">Release Data</a></p>
165 <ul>
166 <li><p><a class="reference internal" href="#feature-additions" id="id4">Feature Additions</a></p></li>
167 <li><p><a class="reference internal" href="#bug-corrections" id="id5">Bug Corrections</a></p></li>
168 <li><p><a class="reference internal" href="#deliverables" id="id6">Deliverables</a></p>
169 <ul>
170 <li><p><a class="reference internal" href="#software-deliverables" id="id7">Software Deliverables</a></p></li>
171 <li><p><a class="reference internal" href="#documentation-deliverables" id="id8">Documentation Deliverables</a></p></li>
172 </ul>
173 </li>
174 </ul>
175 </li>
176 <li><p><a class="reference internal" href="#known-limitations-issues-and-workarounds" id="id9">Known Limitations, Issues and Workarounds</a></p>
177 <ul>
178 <li><p><a class="reference internal" href="#system-limitations" id="id10">System Limitations</a></p></li>
179 <li><p><a class="reference internal" href="#known-issues" id="id11">Known Issues</a></p></li>
180 <li><p><a class="reference internal" href="#workarounds" id="id12">Workarounds</a></p></li>
181 </ul>
182 </li>
183 <li><p><a class="reference internal" href="#references" id="id13">References</a></p></li>
184 </ul>
185 </div>
186 <div class="section" id="version-history">
187 <h2><a class="toc-backref" href="#id1">Version history</a><a class="headerlink" href="#version-history" title="Permalink to this headline">¶</a></h2>
188 <table class="docutils align-default">
189 <colgroup>
190 <col style="width: 25%" />
191 <col style="width: 25%" />
192 <col style="width: 25%" />
193 <col style="width: 25%" />
194 </colgroup>
195 <tbody>
196 <tr class="row-odd"><td><p><strong>Date</strong></p></td>
197 <td><p><strong>Ver.</strong></p></td>
198 <td><p><strong>Author</strong></p></td>
199 <td><p><strong>Comment</strong></p></td>
200 </tr>
201 <tr class="row-even"><td><p>20XX-XX-XX</p></td>
202 <td><p>0.1.0</p></td>
203 <td></td>
204 <td><p>First draft</p></td>
205 </tr>
206 <tr class="row-odd"><td></td>
207 <td><p>0.1.1</p></td>
208 <td></td>
209 <td></td>
210 </tr>
211 <tr class="row-even"><td></td>
212 <td><p>1.0</p></td>
213 <td></td>
214 <td></td>
215 </tr>
216 </tbody>
217 </table>
218 </div>
219 <div class="section" id="summary">
220 <h2><a class="toc-backref" href="#id2">Summary</a><a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
221 <p>&lt;SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES&gt;</p>
222 </div>
223 <div class="section" id="release-data">
224 <h2><a class="toc-backref" href="#id3">Release Data</a><a class="headerlink" href="#release-data" title="Permalink to this headline">¶</a></h2>
225 <p>&lt;STATE RELEVANT RELEASE DATA/RECORDS&gt;</p>
226 <p>&lt;EXAMPLE&gt;:</p>
227 <table class="docutils align-default">
228 <colgroup>
229 <col style="width: 50%" />
230 <col style="width: 50%" />
231 </colgroup>
232 <tbody>
233 <tr class="row-odd"><td><p><strong>Project</strong></p></td>
234 <td><p>E.g. project</p></td>
235 </tr>
236 <tr class="row-even"><td><p><strong>Repo/commit-ID</strong></p></td>
237 <td><p>E.g. genesis/adf634a0d4…..</p></td>
238 </tr>
239 <tr class="row-odd"><td><p><strong>Release designation</strong></p></td>
240 <td><p>E.g. Arno RC2</p></td>
241 </tr>
242 <tr class="row-even"><td><p><strong>Release date</strong></p></td>
243 <td><p>E.g. 2015-04-16</p></td>
244 </tr>
245 <tr class="row-odd"><td><p><strong>Purpose of the delivery</strong></p></td>
246 <td></td>
247 </tr>
248 </tbody>
249 </table>
250 <div class="section" id="feature-additions">
251 <h3><a class="toc-backref" href="#id4">Feature Additions</a><a class="headerlink" href="#feature-additions" title="Permalink to this headline">¶</a></h3>
252 <p>&lt;STATE ADDED FEATURES BY REFERENCE TO JIRA&gt;</p>
253 <p>&lt;EXAMPLE&gt;:</p>
254 <p><strong>JIRA BACK-LOG:</strong></p>
255 <table class="docutils align-default">
256 <colgroup>
257 <col style="width: 50%" />
258 <col style="width: 50%" />
259 </colgroup>
260 <tbody>
261 <tr class="row-odd"><td><p><strong>JIRA REFERENCE</strong></p></td>
262 <td><p><strong>SLOGAN</strong></p></td>
263 </tr>
264 <tr class="row-even"><td></td>
265 <td></td>
266 </tr>
267 <tr class="row-odd"><td></td>
268 <td></td>
269 </tr>
270 </tbody>
271 </table>
272 </div>
273 <div class="section" id="bug-corrections">
274 <h3><a class="toc-backref" href="#id5">Bug Corrections</a><a class="headerlink" href="#bug-corrections" title="Permalink to this headline">¶</a></h3>
275 <p><strong>JIRA TICKETS:</strong></p>
276 <table class="docutils align-default">
277 <colgroup>
278 <col style="width: 50%" />
279 <col style="width: 50%" />
280 </colgroup>
281 <tbody>
282 <tr class="row-odd"><td><p><strong>JIRA REFERENCE</strong></p></td>
283 <td><p><strong>SLOGAN</strong></p></td>
284 </tr>
285 <tr class="row-even"><td></td>
286 <td></td>
287 </tr>
288 <tr class="row-odd"><td></td>
289 <td></td>
290 </tr>
291 </tbody>
292 </table>
293 </div>
294 <div class="section" id="deliverables">
295 <h3><a class="toc-backref" href="#id6">Deliverables</a><a class="headerlink" href="#deliverables" title="Permalink to this headline">¶</a></h3>
296 <div class="section" id="software-deliverables">
297 <h4><a class="toc-backref" href="#id7">Software Deliverables</a><a class="headerlink" href="#software-deliverables" title="Permalink to this headline">¶</a></h4>
298 <p>&lt;STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED&gt;</p>
299 </div>
300 <div class="section" id="documentation-deliverables">
301 <h4><a class="toc-backref" href="#id8">Documentation Deliverables</a><a class="headerlink" href="#documentation-deliverables" title="Permalink to this headline">¶</a></h4>
302 <p>&lt;STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED&gt;</p>
303 </div>
304 </div>
305 </div>
306 <div class="section" id="known-limitations-issues-and-workarounds">
307 <h2><a class="toc-backref" href="#id9">Known Limitations, Issues and Workarounds</a><a class="headerlink" href="#known-limitations-issues-and-workarounds" title="Permalink to this headline">¶</a></h2>
308 <div class="section" id="system-limitations">
309 <h3><a class="toc-backref" href="#id10">System Limitations</a><a class="headerlink" href="#system-limitations" title="Permalink to this headline">¶</a></h3>
310 <p>&lt;STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY&gt;</p>
311 </div>
312 <div class="section" id="known-issues">
313 <h3><a class="toc-backref" href="#id11">Known Issues</a><a class="headerlink" href="#known-issues" title="Permalink to this headline">¶</a></h3>
314 <p>&lt;STATE ALL KNOWN ISSUES WITH JIRA REFERENCE&gt;</p>
315 <p>&lt;EXAMPLE&gt;:</p>
316 <p><strong>JIRA TICKETS:</strong></p>
317 <table class="docutils align-default">
318 <colgroup>
319 <col style="width: 50%" />
320 <col style="width: 50%" />
321 </colgroup>
322 <tbody>
323 <tr class="row-odd"><td><p><strong>JIRA REFERENCE</strong></p></td>
324 <td><p><strong>SLOGAN</strong></p></td>
325 </tr>
326 <tr class="row-even"><td></td>
327 <td></td>
328 </tr>
329 <tr class="row-odd"><td></td>
330 <td></td>
331 </tr>
332 </tbody>
333 </table>
334 </div>
335 <div class="section" id="workarounds">
336 <h3><a class="toc-backref" href="#id12">Workarounds</a><a class="headerlink" href="#workarounds" title="Permalink to this headline">¶</a></h3>
337 <p>&lt;STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY&gt;</p>
338 </div>
339 </div>
340 <div class="section" id="references">
341 <h2><a class="toc-backref" href="#id13">References</a><a class="headerlink" href="#references" title="Permalink to this headline">¶</a></h2>
342 <p>&lt;STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION&gt;</p>
343 </div>
344 </div>
345
346
347     </div>
348       
349   </div>
350 </div>
351 <footer class="footer">
352   <div class="container">
353     <p class="pull-right">
354       <a href="#">Back to top</a>
355       
356         <br/>
357         
358 <div id="sourcelink">
359   <a href="_sources/release-notes.rst.txt"
360      rel="nofollow">Source</a>
361 </div>
362       
363     </p>
364     <p>
365         &copy; Copyright 2019, O-RAN Project.<br/>
366       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.1.<br/>
367     </p>
368   </div>
369 </footer>
370   </body>
371 </html>