doc/doxygen/output/html/contrib.html - third_party/github/STMicroelectronics/stm32_mw_lwip - Git at Google

 <!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" lang="en-US">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
 <meta name="generator" content="Doxygen 1.12.0"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>lwIP: How to contribute to lwIP</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>
 <script type="text/javascript" src="clipboard.js"></script>
 <link href="navtree.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="navtreedata.js"></script>
 <script type="text/javascript" src="navtree.js"></script>
 <script type="text/javascript" src="resize.js"></script>
 <script type="text/javascript" src="cookie.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" />
 </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 id="projectrow">
   <td id="projectalign">
    <div id="projectname">lwIP<span id="projectnumber">&#160;2.1.3</span>
    </div>
    <div id="projectbrief">Lightweight IP stack</div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.12.0 -->
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 var searchBox = new SearchBox("searchBox", "search/",'.html');
 /* @license-end */
 </script>
 <script type="text/javascript">
 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 $(function() { codefold.init(0); });
 /* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 $(function() {
   initMenu('',true,false,'search.php','Search',true);
   $(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 $(function(){initNavTree('contrib.html',''); initResizable(true); });
 /* @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">
 <div id="MSearchResults">
 <div class="SRPage">
 <div id="SRIndex">
 <div id="SRResults"></div>
 <div class="SRStatus" id="Loading">Loading...</div>
 <div class="SRStatus" id="Searching">Searching...</div>
 <div class="SRStatus" id="NoMatches">No Matches</div>
 </div>
 </div>
 </div>
 </div>

 <div><div class="header">
   <div class="headertitle"><div class="title">How to contribute to lwIP</div></div>
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><pre class="fragment">1 Introduction

 This document describes some guidelines for people participating
 in lwIP development.

 2 How to contribute to lwIP

 Here is a short list of suggestions to anybody working with lwIP and
 trying to contribute bug reports, fixes, enhancements, platform ports etc.
 First of all as you may already know lwIP is a volunteer project so feedback
 to fixes or questions might often come late. Hopefully the bug and patch tracking
 features of Savannah help us not lose users' input.

 2.1 Source code style:

 1. do not use tabs.
 2. indentation is two spaces per level (i.e. per tab).
 3. end debug messages with a trailing newline (\n).
 4. one space between keyword and opening bracket.
 5. no space between function and opening bracket.
 6. one space and no newline before opening curly braces of a block.
 7. closing curly brace on a single line.
 8. spaces surrounding assignment and comparisons.
 9. don't initialize static and/or global variables to zero, the compiler takes care of that.
 10. use current source code style as further reference.

 2.2 Source code documentation style:

 1. JavaDoc compliant and Doxygen compatible.
 2. Function documentation above functions in .c files, not .h files.
    (This forces you to synchronize documentation and implementation.)
 3. Use current documentation style as further reference.

 2.3 Bug reports and patches:

 1. Make sure you are reporting bugs or send patches against the latest
    sources. (From the latest release and/or the current Git sources.)
 2. If you think you found a bug make sure it's not already filed in the
    bugtracker at Savannah.
 3. If you have a fix put the patch on Savannah. If it is a patch that affects
    both core and arch specific stuff please separate them so that the core can
    be applied separately while leaving the other patch 'open'. The preferred way
    is to NOT touch archs you can't test and let maintainers take care of them.
    This is a good way to see if they are used at all - the same goes for unix
    netifs except tapif.
 4. Do not file a bug and post a fix to it to the patch area. Either a bug report
    or a patch will be enough.
    If you correct an existing bug then attach the patch to the bug rather than creating a new entry in the patch area.
 5. Patches should be specific to a single change or to related changes. Do not mix bugfixes with spelling and other
    trivial fixes unless the bugfix is trivial too. Do not reorganize code and rename identifiers in the same patch you
    change behaviour if not necessary. A patch is easier to read and understand if it's to the point and short than
    if it's not to the point and long :) so the chances for it to be applied are greater.

 2.4 Platform porters:

 1. If you have ported lwIP to a platform (an OS, a uC/processor or a combination of these) and
    you think it could benefit others[1] you might want discuss this on the mailing list. You
    can also ask for Git access to submit and maintain your port in the contrib Git module.
 </pre> </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.12.0 </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" lang="en-US">
	<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=11"/>
	<meta name="generator" content="Doxygen 1.12.0"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>lwIP: How to contribute to lwIP</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>
	<script type="text/javascript" src="clipboard.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="navtreedata.js"></script>
	<script type="text/javascript" src="navtree.js"></script>
	<script type="text/javascript" src="resize.js"></script>
	<script type="text/javascript" src="cookie.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" />
	</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 id="projectrow">
	<td id="projectalign">
	<div id="projectname">lwIP<span id="projectnumber"> 2.1.3</span>
	</div>
	<div id="projectbrief">Lightweight IP stack</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.12.0 -->
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	var searchBox = new SearchBox("searchBox", "search/",'.html');
	/* @license-end */
	</script>
	<script type="text/javascript">
	/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	$(function() { codefold.init(0); });
	/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	$(function() {
	initMenu('',true,false,'search.php','Search',true);
	$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
	$(function(){initNavTree('contrib.html',''); initResizable(true); });
	/* @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">
	<div id="MSearchResults">
	<div class="SRPage">
	<div id="SRIndex">
	<div id="SRResults"></div>
	<div class="SRStatus" id="Loading">Loading...</div>
	<div class="SRStatus" id="Searching">Searching...</div>
	<div class="SRStatus" id="NoMatches">No Matches</div>
	</div>
	</div>
	</div>
	</div>

	<div><div class="header">
	<div class="headertitle"><div class="title">How to contribute to lwIP</div></div>
	</div><!--header-->
	<div class="contents">
	<div class="textblock"><pre class="fragment">1 Introduction

	This document describes some guidelines for people participating
	in lwIP development.

	2 How to contribute to lwIP

	Here is a short list of suggestions to anybody working with lwIP and
	trying to contribute bug reports, fixes, enhancements, platform ports etc.
	First of all as you may already know lwIP is a volunteer project so feedback
	to fixes or questions might often come late. Hopefully the bug and patch tracking
	features of Savannah help us not lose users' input.

	2.1 Source code style:

	1. do not use tabs.
	2. indentation is two spaces per level (i.e. per tab).
	3. end debug messages with a trailing newline (\n).
	4. one space between keyword and opening bracket.
	5. no space between function and opening bracket.
	6. one space and no newline before opening curly braces of a block.
	7. closing curly brace on a single line.
	8. spaces surrounding assignment and comparisons.
	9. don't initialize static and/or global variables to zero, the compiler takes care of that.
	10. use current source code style as further reference.

	2.2 Source code documentation style:

	1. JavaDoc compliant and Doxygen compatible.
	2. Function documentation above functions in .c files, not .h files.
	(This forces you to synchronize documentation and implementation.)
	3. Use current documentation style as further reference.

	2.3 Bug reports and patches:

	1. Make sure you are reporting bugs or send patches against the latest
	sources. (From the latest release and/or the current Git sources.)
	2. If you think you found a bug make sure it's not already filed in the
	bugtracker at Savannah.
	3. If you have a fix put the patch on Savannah. If it is a patch that affects
	both core and arch specific stuff please separate them so that the core can
	be applied separately while leaving the other patch 'open'. The preferred way
	is to NOT touch archs you can't test and let maintainers take care of them.
	This is a good way to see if they are used at all - the same goes for unix
	netifs except tapif.
	4. Do not file a bug and post a fix to it to the patch area. Either a bug report
	or a patch will be enough.
	If you correct an existing bug then attach the patch to the bug rather than creating a new entry in the patch area.
	5. Patches should be specific to a single change or to related changes. Do not mix bugfixes with spelling and other
	trivial fixes unless the bugfix is trivial too. Do not reorganize code and rename identifiers in the same patch you
	change behaviour if not necessary. A patch is easier to read and understand if it's to the point and short than
	if it's not to the point and long :) so the chances for it to be applied are greater.

	2.4 Platform porters:

	1. If you have ported lwIP to a platform (an OS, a uC/processor or a combination of these) and
	you think it could benefit others[1] you might want discuss this on the mailing list. You
	can also ask for Git access to submit and maintain your port in the contrib Git module.
	</pre> </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.12.0 </li>
	</ul>
	</div>
	</body>
	</html>