Difference between revisions of "Developer documentation"

From The Open Source Backup Wiki (Amanda, MySQL Backup, BackupPC)
Jump to navigationJump to search
(add link to code.v.igoro.us)
 
(6 intermediate revisions by one other user not shown)
Line 39: Line 39:
 
</td><td width="55%" valign="top"> <!-- SECOND COLUMN -->
 
</td><td width="55%" valign="top"> <!-- SECOND COLUMN -->
 
<div style="left: 0px; right: 0px;  border: 1px solid gray; padding-left:1em; padding-right: 0.5em; font-size: 95%; margin-bottom: 5px;">
 
<div style="left: 0px; right: 0px;  border: 1px solid gray; padding-left:1em; padding-right: 0.5em; font-size: 95%; margin-bottom: 5px;">
== API Documentation ==
+
== Documentation ==
 
* Perl Module Documentation for [http://wiki.zmanda.com/pod/ HEAD] ([http://wiki.zmanda.com/pod/2.6.0 2.6.0], [http://wiki.zmanda.com/pod/2.6.1 2.6.1], [http://wiki.zmanda.com/pod/3.1 3.1])
 
* Perl Module Documentation for [http://wiki.zmanda.com/pod/ HEAD] ([http://wiki.zmanda.com/pod/2.6.0 2.6.0], [http://wiki.zmanda.com/pod/2.6.1 2.6.1], [http://wiki.zmanda.com/pod/3.1 3.1])
 +
=== Overviews ===
 +
* [[Taper Process Overview]] (bug Dustin to finish this!)
 +
* [[Recovery Process Overview]]
 +
=== APIs ===
 
* [[Changer API]]
 
* [[Changer API]]
 
* [[Transfer Architecture]] (XFA)
 
* [[Transfer Architecture]] (XFA)
Line 48: Line 52:
 
* [[Configuration API]]
 
* [[Configuration API]]
 
* [[Security API]]
 
* [[Security API]]
== Protocols, Formats, etc. ==
+
=== Protocols, Formats, etc. ===
 
* [[Driver-Taper protocol]]
 
* [[Driver-Taper protocol]]
 +
* [[Driver-Chunker protocol]]
 +
* [[Amanda Protocol]] - protocol for invoking services via amandad
 
* [[Amandad Service Protocol]] - how amandad communicates with services
 
* [[Amandad Service Protocol]] - how amandad communicates with services
 
* [[amindexd protocol]]
 
* [[amindexd protocol]]
 
* [[amidxtaped protocol]]
 
* [[amidxtaped protocol]]
 +
* [[amdumpd protocol]]
 
* [[DirectTCP]]
 
* [[DirectTCP]]
 
* [[Log Files]]
 
* [[Log Files]]
Line 59: Line 66:
 
** [[Amanda log files/Amdump Logs|Amdump Logs]]
 
** [[Amanda log files/Amdump Logs|Amdump Logs]]
 
* [[Tapespec]]
 
* [[Tapespec]]
== Notes ==
+
=== Notes ===
 
These are notes from development conversations in the past; they can help figure out why things are the way they are, but they are not designed as documentation.
 
These are notes from development conversations in the past; they can help figure out why things are the way they are, but they are not designed as documentation.
 
* [[REQ packet format update]]
 
* [[REQ packet format update]]
 
* [[Planner Notes]]
 
* [[Planner Notes]]
 
* [[Tape Driver Semantics]]
 
* [[Tape Driver Semantics]]
 +
* [[GNU Tar Include and Exclude Behavior]]
 +
* [[Splitting Configuration Parameters and Behavior]]
 
</div>
 
</div>
 
</td></tr>
 
</td></tr>
 
</table>
 
</table>

Latest revision as of 13:47, 22 January 2011

Introduction

Developer Resources

Community

Tools

Presentations

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. The Amanda hackers are thankful to these companies for making these tools available and in general, helping to improve quality of open source projects.

  • In collaboration with Stanford University, Coverity is establishing a new baseline for software quality and security in open source. Under a contract with the Department of Homeland Security, Coverity applies the latest innovations in automated defect detection to uncover some of the most critical types of bugs found in software.
  • Amanda has been analyzed with Klocwork source code analysis, the most accurate and comprehensive tool for finding critical programming errors and security vulnerabilities.

Documentation

Overviews

APIs

Protocols, Formats, etc.

Notes

These are notes from development conversations in the past; they can help figure out why things are the way they are, but they are not designed as documentation.