Difference between revisions of "Coding Guidelines"

From The Open Source Backup Wiki (Amanda, MySQL Backup, BackupPC)
Jump to navigationJump to search
m
(add Perl Pitfalls)
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
''Editors: please link articles from this page, rather than adding content here, to allow links from other articles. Article titles should begin with <tt>Coding:</tt>, to avoid collisions with other documentation.''
+
This article summarizes the "things every developer should know".  This will never be an exhaustive list, but it provides a convenient, common place to share the many guidelines and suggestions that each developer has in his or her head.
* [[Coding:Debugging Functions]]
+
 
* [[Coding:String Functions]]
+
See also DEVELOPING in the top-level source directory.
* [[Coding:Memory Allocation]]
+
 
* [[Coding:File Descriptor Manipulation]]
+
* [[/Coding Style]]
* [[Coding:Safely Executing Other Processes]]
+
* [[/Asynchronous Programming]] (event-based programming)
* [[Coding:Internationalization]]
+
* [[/Command-line Processing]]
* [[Coding:Localization]]
+
* [[/Compiler Features]]
 +
* [[/Configuration]]
 +
* [[/Debugging Functions]]
 +
* [[/Error Handling]]
 +
* [[/File Locking]]
 +
* [[/Filesystem Manipulation]]
 +
* [[/Glib Utilities]]
 +
* [[/GValue Handling]]
 +
* [[/Internationalization]]
 +
* [[/IPv6 Support]]
 +
* [[/Memory Allocation]]
 +
* [[/Parsing Functions]]
 +
* [[/Perl Pitfalls]]
 +
* [[/Quoting]]
 +
* [[/Safely Executing Other Processes]]
 +
* [[/String Functions]]
 +
* [[/SWIG Gotchas]]
 +
 
 +
Also see:
 +
* [[Perl Interface]] for an overview of Amanda's perl modules
 +
* [[Testing]] to see how Amanda's testing architecture can help you
 +
 
 +
''Editors: please link articles from this page, rather than adding content here, to allow links from other articles.  Article titles should begin with <tt>/</tt> (to make a [http://meta.wikimedia.org/wiki/Subpages MediaWiki subpage]), to avoid collisions with other documentation.''

Revision as of 01:25, 23 April 2010

This article summarizes the "things every developer should know". This will never be an exhaustive list, but it provides a convenient, common place to share the many guidelines and suggestions that each developer has in his or her head.

See also DEVELOPING in the top-level source directory.

Also see:

  • Perl Interface for an overview of Amanda's perl modules
  • Testing to see how Amanda's testing architecture can help you

Editors: please link articles from this page, rather than adding content here, to allow links from other articles. Article titles should begin with / (to make a MediaWiki subpage), to avoid collisions with other documentation.