Last Update Thursday, July 05, 2001 05:15 PM
Revision Status
Revision | Date | Author(s) | Reason |
0.1 | 5 July 2001 | M. brasher, K. Schopmeyer | first Draft |
This document defines the basic set of guides and rules for programmers contributing to the Pegasus Project
NOTE: This is a draft copy for comment.
void MyClass::myMethod( const char* someReallyLongName, const char* someOtherReallyLongName);
for(...) { .... }Not this:
for (...) { .... }
class X { public: void f(); void g(); };
Avoid this:
int x; float y;
int f() { .... }
Effective testing is essential to allowing a group to work together in a common code environment. We have created a structure where unit and even system level tests can be created and committed to the source tree as part of all development. Each major directory section includes a tests subdirectory with individual directories for tests. Please create and commit tests as part of the normal environment wherever it is possible. All core code should include tests created in this manner as well
If you change code to extend it or make corrections, please review the corresponding tests code to 1) add tests to cover the problem corrected 2) extend tests to cover the new code added.
Be mindful that the tests must run on all supported platforms and that a commit may break another platform.
Tests must clean up the effect they have on the repository.
Changes must work on all platforms. Commits must not break any platform. Always write a regression test for everything.No warnings should be committed. Test big changes on at least Windows and Unix (or Linux)
Don't commit anything that breaks the build (try a clean slate checkout and build). Remember that if the build is broken for you, it is also broken for everybody that gets the new code.
Always build and run all regression tests before committing.
No binaries may be committed to repository.
There are a few exceptions to this rule but binary files cause problems
This is an opensource project. All code that is contributed to this project must be open source and must be made available under the standard license used by the Pegasus project. Do not use any outside libraries that do not meet this criteria. Further, every reference to outside code make it more complex for others to build and work with the project and introduces potential portability problems. At the same time, there may be real reasons to use outside code and libraries at times. Thus, for example, the initial project used the ACE_wrappers libraries extensively but with the objective of eventually providing a replacement. That replacement has been produced, partly because ACE was not available on all of the platforms
The Pegasus project has developed a consistent and portable make system that allows bot localized and global builds on a wide variety of systems from Windows to Unix to the tandem platforms today. This is based on 1) using the GNU Make tool as the core of the make system, 2) minimining the use of other tools.
<<EXPLAIN THE MAKE SYSTEM OR REFERENCE DOC>>>
All code must be reachable (built) from master makefile. Otherwise it will not be reached when doing mass substitutions, testings of builds, and license changes.
<<<THIS SECTION NEED TO BE COMPLETED>>>
We work from a single source tree in CVS. We have a fixed structure for this structure.
<<<THIS SECTION IS TBD>>>
---END OF DOCUMENT--