pegasus/doc/WorkPapers/PegasusProgrammingGuidelines.htm - diff

Return to PegasusProgrammingGuidelines.htm CVS log

Up to [Pegasus] / pegasus / doc / WorkPapers

Diff for /pegasus/doc/WorkPapers/PegasusProgrammingGuidelines.htm between version 1.1.2.1 and 1.1.2.2

version 1.1.2.1, 2001/07/25 16:33:15

version 1.1.2.2, 2001/07/26 20:38:41

Line 15

AUTHORS: M. Brasher, K. Schopmeyer

Last Update <!--webbot bot="Timestamp"

S-Type="EDITED" S-Format="%A, %B %d, %Y %I:%M %p" startspan -->Tuesday, July 24, 2001 08:48 PM

S-Type="EDITED" S-Format="%A, %B %d, %Y %I:%M %p" startspan -->Thursday, July 26, 2001 06:10 PM

Revision Status

Line 38

</tr>

<tr>

<td width="25%">K. Schopmeyer</td>

<td width="25%">Add documentation on licensing.</td>

</tr>

<tr>

Line 58

NOTE: This is a draft copy for comment.

RULES and Suggestions - A number of the guidelines below are absolute rules

RULES and GUIDELINES - A number of the guidelines below are absolute rules

that we must follow in the Pegasus project.  These are the things that will

help insure portability and effective interoperability of the components.

Other area are "suggestions" that we strongly suggest be followed

Other area are "guidelines" that we strongly suggest be followed

so that 1) the code will be readable and usable, 2) we develop a single look to

our source code, etc.  In some cases, there may be reasons to bypass some

of these suggestiions but we strongly encourage everybody to follow them. 

of these guidelines but we strongly encourage everybody to follow them. 

In fact, if there is a real reason we will change to what the group wants and

suggestions.

Line 177

platform.

Always write a regression test for everything.

No warnings should be committed.

No files with warnings should be committed to CVS.

Test big changes on at least Windows and Unix (or Linux)

Line 204

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

produced, partly because ACE was not available on all of the platforms.

All code submitted to the Pegasus core source libraries is to be made available

under the standard license used by Pegasus.  If any code is to be taken

from other open source projects, we expect that the code recognize both the

requirements of the Pegasus standard license and the other license (ex. if we

were to share code with the Caldera OpenWBEM) project, we would have to show

both their license and our licenses.

All code input to the Pegasus project must include the license statement.

If there is a case of code that we want to use on the Pegasus project but

that is licensed outside of the above rules, it can be included only with the

specific permission of the Pegasus project management.  We will be very

hesitant to do this since it could mean weakening the whole open source nature

of the project and would greatly complicate our license arrangements.

<h2>Using Make</h2>

Line 229

Line 244

<h2>Portability Issues</h2>

TBD

<OL>

<LI>In .h files the following identifiers must be surrounded by the PEGASUS_STD() macro (which

pretends std:: to the argument).

ostream

istream

cout

cerr

Do not use this macro in .cpp files. Instead put the following

at the beginning of the file:

PEGASUS_USING_STD;

<LI>The following does not compile with some compilers.

class X

{

public:

static const Uint32 COLOR = 225;

};

Use this instead:

class X

{

public:

static const Uint32 COLOR;

};

And place this in the .cpp file:

const Uint32 X::COLOR = 255;

Or use enumerated types:

class X

{

public:

enum { COLOR = 225 };

};

</OL>

<h2>The Source Tree Structure</h2>

Legend:

Removed from v.1.1.2.1
changed lines
	Added in v.1.1.2.2

No CVS admin address has been configured