Developer documentation: Difference between revisions

Revision as of 18:43, 22 May 2007

Code documentation

Software architecture - How Amanda fits together

APIs

Developer Resources

Community

Tools

Static source code analysis

Coverity and Klocwork have been running their static analysis tools on the latest Amanda source code and making the results available for the Amanda developers to analyse and fix the defects. Currently (July 7, 2006), we have zero defects found by these tools. We are thankful to these companies for making these tools available and in general, helping to improve quality of open source projects.

@@ Line 5: / Line 5: @@
 === Code documentation ===
 * [[Software architecture]] - How Amanda fits together
-*
 === APIs ===
 * [[Virtual tape API]]
@@ Line 21: / Line 20: @@
 <td valign="top" style="width: 45%; border: thin solid gray; padding-left:1em; font-size: 90%">
 == Developer Resources ==
+=== Community ===
 * [http://www.amanda.org/support/mailinglists.php amanda-hackers mailing list]
-* Lint : ''lint'' makefile target is available for Amanda source tree. Run "make lint" to do static analysis of Amanda source code.
+* [http://sourceforge.net/projects/amanda sourceforge project page]
-* Valgrind: Memory allocation/free checker. See [[Using Valgrind]] for details on how to use it with Amanda.
+=== Tools ===
-: Valgrind is especially useful in debugging glibc errors. Errors beginning with <tt>*** glibc detected ***</tt> are errors in Amanda memory allocation detected by glibc. Please report all such problems to the [http://www.amanda.org/support/mailinglists.php amanda-hackers mailing list] or the [http://forums.zmanda.com Amanda forums].
+* [[Lint]]
-: You can disable glibc error detection by setting <tt>$MALLOC_CHECK</tt> to 1. Please note that this might cause Amanda to fail later.
+* [[Valgrind]]
 </td>
 </tr><tr>
@@ Line 31: / Line 31: @@
 == Static source code analysis ==
-Coverity and Klocwork have been running their static analysis tools on the latest Amanda source code and making the results available for the Amanda developers to analyse and fix the defects.  Currently (July 7, 2006), we have
+Coverity and Klocwork have been running their static analysis tools on the latest Amanda source code and making the results available for the Amanda developers to analyse and fix the defects.  Currently (July 7, 2006), we have zero defects found by these tools. We are thankful to these companies for making these tools available and in general, helping to improve quality of open source projects.
-zero defects found by these tools. We are thankful to these companies for making these tools available and in general, helping to improve quality of open source projects.
 * [http://scan.coverity.com Coverity scan results]