<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2176/18/9/_/styles/combined.css?spaceKey=AST&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/AST/Janitor+Projects">Janitor Projects</a></h2>
<h4>Page <b>edited</b> by <a href="https://wiki.asterisk.org/wiki/display/~lathama">Andrew Latham</a>
</h4>
<br/>
<h4>Changes (1)</h4>
<div id="page-diffs">
<table class="diff" cellpadding="0" cellspacing="0">
<tr><td class="diff-snipped" >...<br></td></tr>
<tr><td class="diff-unchanged" >* There is a convenient set of macros defined in include/asterisk/linkedlists.h for handling linked lists. However, there are some open-coded lists throughout the code. Converting linked lists to use these macros will make list handling more consistent and reduce the possibility of coding errors. <br> <br></td></tr>
<tr><td class="diff-changed-lines" >* Clean up and add <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">Doxygen Documentation.</span> <span class="diff-added-words"style="background-color: #dfd;">[Doxygen Documentation|http://www.asterisk.org/doxygen/trunk/index.html].</span> When generating the documentation with make progdocs, a lot of warnings are generated. All of these need to be fixed. There is also plenty of code that still needs to be documented. All public API functions should be documented. That is pretty much anything in include/asterisk/*.h. [https://issues.asterisk.org/jira/browse/ASTERISK-20259] <br></td></tr>
<tr><td class="diff-unchanged" > <br>* Check all ast_copy_string() usage to ensure that buffers are not being unnecessarily zeroed before or after calling it. <br></td></tr>
<tr><td class="diff-snipped" >...<br></td></tr>
</table>
</div> <h4>Full Content</h4>
<div class="notificationGreySide">
<h1><a name="JanitorProjects-Whatisthispage%3F"></a>What is this page?</h1>
<p>This page contains janitor (small, cleanup) projects for Asterisk that are waiting for a kind developer to take them on and bring them to completion.</p>
<hr />
<ul>
<li>Audit uses of usleep() to ensure that the argument is never greater than 1 million. On some systems, that is considered an error. In any such cases, convert the usage ver to use nanosleep(), instead.</li>
</ul>
<ul>
<li>Convert all existing uses of astobj.h to astobj2.h. chan_sip already in progress in a branch</li>
</ul>
<ul>
<li>There are many places where large character buffers are allocated in structures. There is a new system for string handling that uses dynamically allocatted memory pools which is documented in include/asterisk/stringfields.h. Examples of where they are currently used are the ast_channel structure defined in include/asterisk/channel.h, some structures in chan_sip.c, and chan_dahdi.c.</li>
</ul>
<ul>
<li>There is a convenient set of macros defined in include/asterisk/linkedlists.h for handling linked lists. However, there are some open-coded lists throughout the code. Converting linked lists to use these macros will make list handling more consistent and reduce the possibility of coding errors.</li>
</ul>
<ul>
<li>Clean up and add <a href="http://www.asterisk.org/doxygen/trunk/index.html" class="external-link" rel="nofollow">Doxygen Documentation</a>. When generating the documentation with make progdocs, a lot of warnings are generated. All of these need to be fixed. There is also plenty of code that still needs to be documented. All public API functions should be documented. That is pretty much anything in include/asterisk/*.h. <a href="https://issues.asterisk.org/jira/browse/ASTERISK-20259" class="external-link" rel="nofollow">https://issues.asterisk.org/jira/browse/ASTERISK-20259</a></li>
</ul>
<ul>
<li>Check all ast_copy_string() usage to ensure that buffers are not being unnecessarily zeroed before or after calling it.</li>
</ul>
<ul>
<li>Find any remaining open-coded struct timeval manipulation and convert to use new time library functions.</li>
</ul>
<ul>
<li>Use the ast_str API in strings.h to replace multiple calls to strncat(), snprintf() with funky math, etc.</li>
</ul>
<ul>
<li>Audit all channel/res/app/etc. modules to ensure that they do not register any entrypoints with the Asterisk core until after they are ready to service requests; all config file reading/processing, structure allocation, etc. must be completed before Asterisk is made aware of any services the module offers.</li>
</ul>
<ul>
<li>Ensure that Realtime-enabled modules do not depend on the order of columns returned by the database lookup (example: outboundproxy and host settings in chan_sip).</li>
</ul>
<ul>
<li>Convert all usage of the signal(2) system API to the more portable sigaction(2) system API.</li>
</ul>
<ul>
<li>Find options and arguments in Asterisk which specify a time period in seconds or milliseconds and convert them to use the new ast_app_parse_timelen() function.</li>
</ul>
<ul>
<li>Find applications and functions in Asterisk that would benefit from being able to encode control characters and extended ASCII and embed calls to ast_get_encoded_char, ast_get_encoded_str, and ast_str_get_encoded_str.</li>
</ul>
<ul>
<li>There are a number of function, applications, etc. in Asterisk that are not properly source-documented. Someone needs to document them as defined in the <a href="/wiki/display/AST/Coding+Guidelines" title="Coding Guidelines">Coding Guidelines</a>. The items needing documentation include:
<ul>
<li>func_curl</li>
<li>func_logic</li>
<li>func_module</li>
<li>func_speex</li>
<li>func_strings</li>
<li>func_uri</li>
<li>app_cdr</li>
<li>app_directed_pickup</li>
<li>app_fax</li>
<li>app_image</li>
<li>app_talkdetect</li>
<li>app_url</li>
</ul>
</li>
</ul>
<ul>
<li>In Asterisk 11, documentation for AMI events has been added. While a subset of the events in Asterisk have received documentation, not all applications/functions/resource modules/channel drivers have been updated. All of the extended support modules should receive AMI event documentation.</li>
</ul>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/AST/Janitor+Projects">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/pages/diffpagesbyversion.action?pageId=4260010&revisedVersion=6&originalVersion=5">View Changes</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Janitor+Projects?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>