Developers Guide

Source Code

The CVS repository insructions are here, at the bottom of the page.

Web

The Development web site is at developer.osdl.org. It is maintained in the regular source repository. Just edit it, check it in, then run the script 'brt-web/deploy_web.sh' to deploy it. Before yu run the script set CVSROOT properly (to :ext:your_name@cvs.osdl.org:/var/cvs/repos ). Also you must be able to ssh to and have write access on developer. Or get someone who has these things to do it.

Documentation

The documentation is in the repository under doc/html_user_guide and is done only in html. It currently gets pushed out to the web-site by running the script 'brt-web/deploy_web.sh'. There is only the active version for the documentation.

Perl Coding

• Make sure 'use strict' is used.
• Use perl flags '-w', '-T' where appropriate.
• Do not use globally scoped variables if at all possible. If you do please name them very descriptively, matching the contents.
• Minimize system calls; use perl calls if possible.

Perl Style

• Indents are 4 spaces.
• Add a space between data and the parentheses, like "function( argument );"

SQL

We are using a rather old version of MySQL currently. No transactions, triggers etc. We hope to be updating that soon. Please, keep to the convention of reserved words in ALL CAPS.