platform-api-guide/release.html - lng/odp-dpdk - Linaro Git Browser

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.9.1"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>API Reference Manual for linux-dpdk: Release Management</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
 <link href="navtree.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="resize.js"></script>
 <script type="text/javascript" src="navtreedata.js"></script>
 <script type="text/javascript" src="navtree.js"></script>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="search/searchdata.js"></script>
 <script type="text/javascript" src="search/search.js"></script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 <link href="odpdoxygen.css" rel="stylesheet" type="text/css"/>
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 <div id="titlearea">
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr style="height: 56px;">
   <td id="projectlogo"><img alt="Logo" src="ODP-Logo-HQ.svg"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">API Reference Manual for linux-dpdk
    &#160;<span id="projectnumber">1.47.0</span>
    </div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.9.1 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
 var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
 /* @license-end */
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
 $(function() {
   initMenu('',true,false,'search.php','Search');
   $(document).ready(function() { init_search(); });
 });
 /* @license-end */</script>
 <div id="main-nav"></div>
 </div><!-- top -->
 <div id="side-nav" class="ui-resizable side-nav-resizable">
   <div id="nav-tree">
     <div id="nav-tree-contents">
       <div id="nav-sync" class="sync"></div>
     </div>
   </div>
   <div id="splitbar" style="-moz-user-select:none;"
        class="ui-resizable-handle">
   </div>
 </div>
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
 $(document).ready(function(){initNavTree('release.html',''); initResizable(); });
 /* @license-end */
 </script>
 <div id="doc-content">
 <!-- window showing the filter options -->
 <div id="MSearchSelectWindow"
      onmouseover="return searchBox.OnSearchSelectShow()"
      onmouseout="return searchBox.OnSearchSelectHide()"
      onkeydown="return searchBox.OnSearchSelectKey(event)">
 </div>

 <!-- iframe showing the search results (closed by default) -->
 <div id="MSearchResultsWindow">
 <iframe src="javascript:void(0)" frameborder="0"
         name="MSearchResults" id="MSearchResults">
 </iframe>
 </div>

 <div class="PageDoc"><div class="header">
   <div class="headertitle">
 <div class="title">Release Management </div>  </div>
 </div><!--header-->
 <div class="contents">
 <div class="toc"><h3>Table of Contents</h3>
 <ul><li class="level1"><a href="#api_numbering">API Numbering</a><ul><li class="level2"><a href="#generation">Generation</a></li>
 <li class="level2"><a href="#major">Major</a></li>
 <li class="level2"><a href="#minor">Minor</a></li>
 </ul>
 </li>
 <li class="level1"><a href="#implementation_string">Implementation String</a></li>
 </ul>
 </div>
 <div class="textblock"><h1><a class="anchor" id="api_numbering"></a>
 API Numbering</h1>
 <p>The API uses a three digit release number, for ODP this number refers to</p><ul>
 <li>The API header definitions</li>
 <li>The documentation</li>
 </ul>
 <p>ODP API releases follow a standard three-level naming designation. Changes to the API are reflected in the <a class="el" href="group__odp__version.html#ga388acb1d724d9d5a9de0f495a2d3c816" title="ODP API generation version.">ODP_VERSION_API_GENERATION</a> and <a class="el" href="group__odp__version.html#ga7218febf8005dff559283122371e5a08" title="ODP API major version.">ODP_VERSION_API_MAJOR</a> numbers. A change to the <a class="el" href="group__odp__version.html#ga01f42918779e5e8fec94370cbcbecec7" title="ODP API minor version.">ODP_VERSION_API_MINOR</a> number is used only for updates not breaking the API compatibility but which do touch the API source files in the include directory.</p>
 <p>The header file odp_version.h contains helper macros for dealing with ODP versions in application code.</p>
 <dl class="section note"><dt>Note</dt><dd>The version refers to API source compatibility and not binary compatibility. Every change in API version will require a recompilation, relinking will not be sufficient.</dd></dl>
 <p>The ODP API generation &amp; major version will only change at well-defined release points. A release will be tagged</p><div class="fragment"><div class="line">v-&lt;generation&gt;.&lt;major&gt; </div>
 </div><!-- fragment --><p> and bug fix releases will be tagged</p><div class="fragment"><div class="line">v-&lt;generation&gt;.&lt;major&gt;.&lt;minor&gt; </div>
 </div><!-- fragment --><p> The first bug fix release minor = 1.</p>
 <p>The API <a class="el" href="group__odp__version.html#ga36ea138f559454eee62c343107947cb6" title="ODP API version string.">odp_version_api_str()</a> returns this string.</p>
 <h2><a class="anchor" id="generation"></a>
 Generation</h2>
 <p>The digit is the ODP API generation. A change to this digit indicates a break in backwards compatibility. </p><dl class="section note"><dt>Note</dt><dd>The incompatibility covers the whole ODP API, however the change may be a tiny change to an esoteric function that is not used by a given application.</dd></dl>
 <ul>
 <li>Altering API signature</li>
 <li>Altering a structure other than adding optional items at the end</li>
 <li>Changing the required calling sequence for APIs</li>
 <li>Changes to the installed structure i.e. the output from "make install" moves a file in a way that breaks compilation</li>
 <li>New element to an enum that is an output from ODP</li>
 </ul>
 <h2><a class="anchor" id="major"></a>
 Major</h2>
 <p>The digit is for changes that are likely backwards incompatible. For example changes such as the addition of a new API. Existing application code shall not have to change if the new API is not used.</p><ul>
 <li>Adding a new struct</li>
 <li>Adding a new function</li>
 <li>Adding an additional alternate API to an existing one</li>
 <li>New element to an enum that is an input to ODP</li>
 </ul>
 <h2><a class="anchor" id="minor"></a>
 Minor</h2>
 <p>The digit is used for backward compatible changes. Any existing app should work as before.</p><ul>
 <li>Documentation updates</li>
 </ul>
 <h1><a class="anchor" id="implementation_string"></a>
 Implementation String</h1>
 <p>The API <a class="el" href="group__odp__version.html#gab6931e3029d875bfef5012d076468849" title="Implementation version string.">odp_version_impl_str()</a> returns a platform specific version string defined by the vendor. The intent of this string is to provide a unique identifier of the service level or build number of the implementation. Implementations should change this for each change they make (e.g., bug fix, performance improvement, etc.). It is recommended that this be in a format suitable for logging for serviceability tracking.</p>
 <p>This affects</p><ul>
 <li>The implementation</li>
 <li>In the case of linux-generic it also covers the test &amp; validation suite. </li>
 </ul>
 </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
   </ul>
 </div>
 </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml">
	<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.1"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>API Reference Manual for linux-dpdk: Release Management</title>
	<link href="tabs.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="resize.js"></script>
	<script type="text/javascript" src="navtreedata.js"></script>
	<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="search/searchdata.js"></script>
	<script type="text/javascript" src="search/search.js"></script>
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="odpdoxygen.css" rel="stylesheet" type="text/css"/>
	</head>
	<body>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
	<div id="titlearea">
	<table cellspacing="0" cellpadding="0">
	<tbody>
	<tr style="height: 56px;">
	<td id="projectlogo"><img alt="Logo" src="ODP-Logo-HQ.svg"/></td>
	<td id="projectalign" style="padding-left: 0.5em;">
	<div id="projectname">API Reference Manual for linux-dpdk
	<span id="projectnumber">1.47.0</span>
	</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.9.1 -->
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
	var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
	/* @license-end */
	</script>
	<script type="text/javascript" src="menudata.js"></script>
	<script type="text/javascript" src="menu.js"></script>
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
	$(function() {
	initMenu('',true,false,'search.php','Search');
	$(document).ready(function() { init_search(); });
	});
	/* @license-end */</script>
	<div id="main-nav"></div>
	</div><!-- top -->
	<div id="side-nav" class="ui-resizable side-nav-resizable">
	<div id="nav-tree">
	<div id="nav-tree-contents">
	<div id="nav-sync" class="sync"></div>
	</div>
	</div>
	<div id="splitbar" style="-moz-user-select:none;"
	class="ui-resizable-handle">
	</div>
	</div>
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
	$(document).ready(function(){initNavTree('release.html',''); initResizable(); });
	/* @license-end */
	</script>
	<div id="doc-content">
	<!-- window showing the filter options -->
	<div id="MSearchSelectWindow"
	onmouseover="return searchBox.OnSearchSelectShow()"
	onmouseout="return searchBox.OnSearchSelectHide()"
	onkeydown="return searchBox.OnSearchSelectKey(event)">
	</div>

	<!-- iframe showing the search results (closed by default) -->
	<div id="MSearchResultsWindow">
	<iframe src="javascript:void(0)" frameborder="0"
	name="MSearchResults" id="MSearchResults">
	</iframe>
	</div>

	<div class="PageDoc"><div class="header">
	<div class="headertitle">
	<div class="title">Release Management </div> </div>
	</div><!--header-->
	<div class="contents">
	<div class="toc"><h3>Table of Contents</h3>
	<ul><li class="level1"><a href="#api_numbering">API Numbering</a><ul><li class="level2"><a href="#generation">Generation</a></li>
	<li class="level2"><a href="#major">Major</a></li>
	<li class="level2"><a href="#minor">Minor</a></li>
	</ul>
	</li>
	<li class="level1"><a href="#implementation_string">Implementation String</a></li>
	</ul>
	</div>
	<div class="textblock"><h1><a class="anchor" id="api_numbering"></a>
	API Numbering</h1>
	<p>The API uses a three digit release number, for ODP this number refers to</p><ul>
	<li>The API header definitions</li>
	<li>The documentation</li>
	</ul>
	<p>ODP API releases follow a standard three-level naming designation. Changes to the API are reflected in the <a class="el" href="group__odp__version.html#ga388acb1d724d9d5a9de0f495a2d3c816" title="ODP API generation version.">ODP_VERSION_API_GENERATION</a> and <a class="el" href="group__odp__version.html#ga7218febf8005dff559283122371e5a08" title="ODP API major version.">ODP_VERSION_API_MAJOR</a> numbers. A change to the <a class="el" href="group__odp__version.html#ga01f42918779e5e8fec94370cbcbecec7" title="ODP API minor version.">ODP_VERSION_API_MINOR</a> number is used only for updates not breaking the API compatibility but which do touch the API source files in the include directory.</p>
	<p>The header file odp_version.h contains helper macros for dealing with ODP versions in application code.</p>
	<dl class="section note"><dt>Note</dt><dd>The version refers to API source compatibility and not binary compatibility. Every change in API version will require a recompilation, relinking will not be sufficient.</dd></dl>
	<p>The ODP API generation & major version will only change at well-defined release points. A release will be tagged</p><div class="fragment"><div class="line">v-<generation>.<major> </div>
	</div><!-- fragment --><p> and bug fix releases will be tagged</p><div class="fragment"><div class="line">v-<generation>.<major>.<minor> </div>
	</div><!-- fragment --><p> The first bug fix release minor = 1.</p>
	<p>The API <a class="el" href="group__odp__version.html#ga36ea138f559454eee62c343107947cb6" title="ODP API version string.">odp_version_api_str()</a> returns this string.</p>
	<h2><a class="anchor" id="generation"></a>
	Generation</h2>
	<p>The digit is the ODP API generation. A change to this digit indicates a break in backwards compatibility. </p><dl class="section note"><dt>Note</dt><dd>The incompatibility covers the whole ODP API, however the change may be a tiny change to an esoteric function that is not used by a given application.</dd></dl>
	<ul>
	<li>Altering API signature</li>
	<li>Altering a structure other than adding optional items at the end</li>
	<li>Changing the required calling sequence for APIs</li>
	<li>Changes to the installed structure i.e. the output from "make install" moves a file in a way that breaks compilation</li>
	<li>New element to an enum that is an output from ODP</li>
	</ul>
	<h2><a class="anchor" id="major"></a>
	Major</h2>
	<p>The digit is for changes that are likely backwards incompatible. For example changes such as the addition of a new API. Existing application code shall not have to change if the new API is not used.</p><ul>
	<li>Adding a new struct</li>
	<li>Adding a new function</li>
	<li>Adding an additional alternate API to an existing one</li>
	<li>New element to an enum that is an input to ODP</li>
	</ul>
	<h2><a class="anchor" id="minor"></a>
	Minor</h2>
	<p>The digit is used for backward compatible changes. Any existing app should work as before.</p><ul>
	<li>Documentation updates</li>
	</ul>
	<h1><a class="anchor" id="implementation_string"></a>
	Implementation String</h1>
	<p>The API <a class="el" href="group__odp__version.html#gab6931e3029d875bfef5012d076468849" title="Implementation version string.">odp_version_impl_str()</a> returns a platform specific version string defined by the vendor. The intent of this string is to provide a unique identifier of the service level or build number of the implementation. Implementations should change this for each change they make (e.g., bug fix, performance improvement, etc.). It is recommended that this be in a format suitable for logging for serviceability tracking.</p>
	<p>This affects</p><ul>
	<li>The implementation</li>
	<li>In the case of linux-generic it also covers the test & validation suite. </li>
	</ul>
	</div></div><!-- contents -->
	</div><!-- PageDoc -->
	</div><!-- doc-content -->
	<!-- start footer part -->
	<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<ul>
	<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
	</ul>
	</div>
	</body>
	</html>