(file) Return to CodeReviewNotes.txt CVS log (file) (dir) Up to [Pegasus] / pegasus / doc / Attic

Diff for /pegasus/doc/Attic/CodeReviewNotes.txt between version 1.13 and 1.14

version 1.13, 2001/12/28 23:08:02 version 1.14, 2001/12/31 13:13:57
Line 1 
Line 1 
  
   
     1.  Indent four spaces (not three and not tabs).     1.  Indent four spaces (not three and not tabs).
  
     2.  Literals used (other than 0 or 1).     2.  Literals used (other than 0 or 1).
Line 27 
Line 26 
  
             "+++++ passed all tests"             "+++++ passed all tests"
  
   SOME TESTS TAKE A LONG TIME TO RUN AND NEED TO PRINT IMTERMEDIATE OUTPUT SO THE
   DEVELOPER DOES NOT THINK THE TEST IS HANGED.
   
         Extraneous output should be removed.         Extraneous output should be removed.
  
     7.  All defined constants must begin with "PEGASUS_".     7.  All defined constants must begin with "PEGASUS_".
Line 34 
Line 36 
     8.  All method must use the form myMethodName(). Many places     8.  All method must use the form myMethodName(). Many places
         have my_method_name() (with underscores).         have my_method_name() (with underscores).
  
     9.  Avoid use of (void). Use () instead.      9.  Avoid use of (void). Use () instead. WHY?
  
     10. Either get rid of throw() declarations or use them     10. Either get rid of throw() declarations or use them
         everywhere (perhaps they are not supported by some compilers).         everywhere (perhaps they are not supported by some compilers).
  
     11. Avoid indenting "private:", "public:" and "protected". Use this     11. Avoid indenting "private:", "public:" and "protected". Use this
         style:          style: WHY?
  
             class X             class X
             {             {
Line 49 
Line 51 
             public:             public:
             };             };
  
     12. Use "Type* x" rather than "Type *x".      12. Use "Type* x" rather than "Type *x". WHY?
  
     13. Use "if (" rather than "if(".      13. Use "if (" rather than "if(". WHY?
  
     14. Avoid use of spaces around the condition:      14. Avoid use of spaces around the condition: WHY?
  
             if( cond )             if( cond )
  
     15. Keep all lines within 80 columns.     15. Keep all lines within 80 columns.
  
     16. Build fails on many Linux system (threading support problems).      16. Build fails on many Linux system (threading support problems). WHICH ONES ?
  
     17. SSL is the default on Linux (is this okay?).     17. SSL is the default on Linux (is this okay?).
  
Line 67 
Line 69 
  
     21. Get rid of CIMIndication class.     21. Get rid of CIMIndication class.
  
     22. Revise licensing headers on all files.      22. Revise licensing headers on all files. BE CAREFUL NOT TO CHANGE LICENSE AGREEMENT
  
     23. Add Log CVS directives.     23. Add Log CVS directives.
  
Line 84 
Line 86 
     29. Get rid of directories containing .old extensions.     29. Get rid of directories containing .old extensions.
  
     30. Use constant global queue ids as described in MessagQueue.h     30. Use constant global queue ids as described in MessagQueue.h
         docs.          docs. USE META DISPATCHER TO FIND QUEUES. CONSTANT IDS LIMIT QUEUES
           TO ONE OF EACH PREDEFINED TYPE.
  
     31. Is the Facade class necessary.     31. Is the Facade class necessary.
  
     32. Response handler need not have to action methods (for single     32. Response handler need not have to action methods (for single
         and multiple objects).          and multiple objects). WHY CREATE AN ARRAY OBJECT THAT WILL ONLY HOLD ONE CIM OBJECT?
           TOO MUCH OVERHEAD. HAVING A DUAL INTERFACE IS AN IMPORTANT OPTIMIZATION.
  
     33. Clean up warnings on NT.     33. Clean up warnings on NT.
  
     34. Use Linkage.h files everywhere.     34. Use Linkage.h files everywhere.
  
     35. Need to add notifiers (using message queue observer scheme).      35. Need to add notifiers (using message queue observer scheme). USE META DISPATCHER INSTEAD
  
     36. Need to define services's interface to CIMOM.     36. Need to define services's interface to CIMOM.
  


Legend:
Removed from v.1.13  
changed lines
  Added in v.1.14

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2