[Opal-commits] web change_process.html,1.1,1.2
Status: Inactive
Brought to you by:
tylerstreeter
Menu
▾
▴
[Opal-commits] web change_process.html,1.1,1.2
|
From: tylerstreeter <tyl...@us...> - 2005-06-18 18:04:31
|
Update of /cvsroot/opal/web In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27957 Modified Files: change_process.html Log Message: added more details to patch submission process Index: change_process.html =================================================================== RCS file: /cvsroot/opal/web/change_process.html,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** change_process.html 18 Jun 2005 17:19:37 -0000 1.1 --- change_process.html 18 Jun 2005 18:04:22 -0000 1.2 *************** *** 9,14 **** <meta name=Generator content="Microsoft Word 10"> <meta name=Originator content="Microsoft Word 10"> ! <link rel=File-List href="submissions_files/filelist.xml"> ! <link rel=Edit-Time-Data href="submissions_files/editdata.mso"> <!--[if !mso]> <style> --- 9,14 ---- <meta name=Generator content="Microsoft Word 10"> <meta name=Originator content="Microsoft Word 10"> ! <link rel=File-List href="change_process_files/filelist.xml"> ! <link rel=Edit-Time-Data href="change_process_files/editdata.mso"> <!--[if !mso]> <style> *************** *** 23,27 **** <w:WordDocument> <w:Zoom>90</w:Zoom> - <w:SpellingState>Clean</w:SpellingState> <w:GrammarState>Clean</w:GrammarState> <w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel> --- 23,26 ---- *************** *** 32,35 **** --- 31,49 ---- /* Font Definitions */ @font-face + {font-family:Helvetica; + panose-1:2 11 6 4 2 2 2 2 2 4; + mso-font-charset:0; + mso-generic-font-family:swiss; + mso-font-pitch:variable; + mso-font-signature:536902279 -2147483648 8 0 511 0;} + @font-face + {font-family:Courier; + panose-1:2 7 4 9 2 2 5 2 4 4; + mso-font-charset:0; + mso-generic-font-family:modern; + mso-font-format:other; + mso-font-pitch:fixed; + mso-font-signature:3 0 0 0 1 0;} + @font-face {font-family:"Book Antiqua"; panose-1:2 4 6 2 5 3 5 3 3 4; *************** *** 56,62 **** text-decoration:underline; text-underline:single;} ! span.SpellE ! {mso-style-name:""; ! mso-spl-e:yes;} span.GramE {mso-style-name:""; --- 70,80 ---- text-decoration:underline; text-underline:single;} ! pre ! {margin:0in; ! margin-bottom:.0001pt; ! mso-pagination:widow-orphan; ! font-size:10.0pt; ! font-family:"Courier New"; ! mso-fareast-font-family:"Times New Roman";} span.GramE {mso-style-name:""; *************** *** 89,93 **** </style> <![endif]--><!--[if gte mso 9]><xml> ! <o:shapedefaults v:ext="edit" spidmax="5122"/> </xml><![endif]--><!--[if gte mso 9]><xml> <o:shapelayout v:ext="edit"> --- 107,111 ---- </style> <![endif]--><!--[if gte mso 9]><xml> ! <o:shapedefaults v:ext="edit" spidmax="7170"/> </xml><![endif]--><!--[if gte mso 9]><xml> <o:shapelayout v:ext="edit"> *************** *** 125,143 **** is a reference for those people wanting to submit bug reports, feature requests, or patches submissions to the OPAL source code.<span ! style='mso-spacerun:yes'> </span>Most of these processes are handled via <span ! class=SpellE>SourceForge</span> trackers (see Document E03 of the <span ! class=SpellE>SourceForge</span> Site Docs for more information on tracker ! system, or click <a href="http://sourceforge.net/docman/display_doc.php?docid=24202&group_id=1">here</a> for the current link to this document).<span style='mso-spacerun:yes'> ! </span>This page also describes <span class=SpellE>OPALs</span> design ! philosophy and coding conventions for people writing source code patches.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'> <o:p></o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span style='font-size:16.0pt;font-family:"Book Antiqua";color:black'>Bug Reports<o:p></o:p></span></b></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>To ! submit a bug report, visit the Bugs link on the <span class=SpellE>SourceForge</span> ! project page.<span style='mso-spacerun:yes'> </span>Submit a detailed ! description of the problem.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span --- 143,160 ---- is a reference for those people wanting to submit bug reports, feature requests, or patches submissions to the OPAL source code.<span ! style='mso-spacerun:yes'> </span>Most of these processes are handled via ! SourceForge trackers (see Document E03 of the SourceForge Site Docs for more ! information on tracker system, or click <a href="http://sourceforge.net/docman/display_doc.php?docid=24202&group_id=1">here</a> for the current link to this document).<span style='mso-spacerun:yes'> ! </span>This page also describes OPALs design philosophy and coding ! conventions for people writing source code patches.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'> <o:p></o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span style='font-size:16.0pt;font-family:"Book Antiqua";color:black'>Bug Reports<o:p></o:p></span></b></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>To ! submit a bug report, visit the Bugs link on the SourceForge project ! page.<span style='mso-spacerun:yes'> </span>Submit a detailed description of ! the problem.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span *************** *** 145,152 **** Requests<o:p></o:p></span></b></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>To ! submit a bug report, visit the RFE (request for enhancement) link on the <span ! class=SpellE>SourceForge</span> project page.<span style='mso-spacerun:yes'> ! </span>Submit a detailed description of the feature you wish to be added and ! your reasoning for why this feature has mass appeal.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span --- 162,169 ---- Requests<o:p></o:p></span></b></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>To ! submit a bug report, visit the RFE (request for enhancement) link on the ! SourceForge project page.<span style='mso-spacerun:yes'> </span>Submit a ! detailed description of the feature you wish to be added and your reasoning ! for why this feature has mass appeal.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span *************** *** 169,184 **** <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span style='font-family:"Book Antiqua";color:black'>2.</span></b><span ! style='font-family:"Book Antiqua";color:black'> Implement the patch ! (following the OPAL design philosophy and coding conventions described below) ! and test it thoroughly.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span style='font-family:"Book Antiqua";color:black'>3.</span></b><span ! style='font-family:"Book Antiqua";color:black'> Submit the patch via the ! Patches link on the <span class=SpellE>SourceForge</span> project ! page.<span style='mso-spacerun:yes'> </span><TODO: what format?<span ! style='mso-spacerun:yes'> </span><span class=GramE>all</span> changed/new ! files, or just a CVS diff?><o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span style='font-size:16.0pt;font-family:"Book Antiqua";color:black'>Design --- 186,269 ---- <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span style='font-family:"Book Antiqua";color:black'>2.</span></b><span ! style='font-family:"Book Antiqua";color:black'> Implement your ! changes/additional code (following the OPAL design philosophy and coding ! conventions described below) and test it thoroughly.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span style='font-family:"Book Antiqua";color:black'>3.</span></b><span ! style='font-family:"Book Antiqua";color:black'> Create a CVS .diff or .patch ! file containing all of your changes.<span style='mso-spacerun:yes'> ! </span>If you are using UNIX and have simply changed some existing OPAL ! files, do the following: <o:p></o:p></span></p> ! <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> ! <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0 align=left ! style='background:silver;border-collapse:collapse;border:none;mso-border-alt: ! solid windowtext .25pt;mso-table-lspace:9.0pt;margin-left:.1in;mso-table-rspace: ! 9.0pt;margin-right:.1in;mso-table-anchor-vertical:paragraph;mso-table-anchor-horizontal: ! page;mso-table-left:7.35pt;mso-table-top:12.7pt;mso-padding-alt:0in 5.4pt 0in 5.4pt'> ! <tr style='mso-yfti-irow:0;mso-yfti-lastrow:yes;height:22.95pt'> ! <td width=974 valign=top style='width:584.6pt;border:solid windowtext 1.0pt; ! mso-border-alt:solid windowtext .25pt;padding:0in 5.4pt 0in 5.4pt; ! height:22.95pt'> ! <p class=MsoNormal><span style='font-family:Courier;color:black'><o:p> </o:p></span></p> ! <pre><span style='font-size:12.0pt;font-family:Courier'>cd /path/to/opal_directory<o:p></o:p></span></pre><pre><span ! style='font-size:12.0pt;font-family:Courier'>cvs diff -u -b > </span><span ! style='font-size:12.0pt;font-family:Courier;mso-bidi-font-family:Helvetica; ! mso-bidi-font-style:italic'>patch_name</span><span style='font-size:12.0pt; ! font-family:Courier'>.patch<o:p></o:p></span></pre> ! <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> ! </td> ! </tr> ! </table> ! <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> ! <p class=MsoNormal><span style='font-family:Courier;color:black'><o:p> </o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>If you + are using UNIX and have added new files, do the following: <o:p></o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + <table class=MsoNormalTable border=1 cellspacing=0 cellpadding=0 align=left + style='background:silver;border-collapse:collapse;border:none;mso-border-alt: + solid windowtext .25pt;mso-table-lspace:9.0pt;margin-left:.1in;mso-table-rspace: + 9.0pt;margin-right:.1in;mso-table-anchor-vertical:paragraph;mso-table-anchor-horizontal: + page;mso-table-left:7.35pt;mso-table-top:12.7pt;mso-padding-alt:0in 5.4pt 0in 5.4pt'> + <tr style='mso-yfti-irow:0;mso-yfti-lastrow:yes;height:22.95pt'> + <td width=974 valign=top style='width:584.6pt;border:solid windowtext 1.0pt; + mso-border-alt:solid windowtext .25pt;padding:0in 5.4pt 0in 5.4pt; + height:22.95pt'> + <p class=MsoNormal><span style='font-family:Courier;color:black'><o:p> </o:p></span></p> + <pre><span style='font-size:12.0pt;font-family:Courier'>cd /path/to/<span + style='mso-bidi-font-style:italic'>opal_directory<o:p></o:p></span></span></pre><pre><span + style='font-size:12.0pt;font-family:Courier'>cvs diff -u -r -b -N -a --binary --exclude=CVS --exclude=build \ <o:p></o:p></span></pre><pre><span + style='font-size:12.0pt;font-family:Courier'><span style='mso-spacerun:yes'> </span><span style='mso-spacerun:yes'> </span>/path/to/opal_directory . > <span + style='mso-bidi-font-style:italic'>patch_name</span>.patch<o:p></o:p></span></pre> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + </td> + </tr> + </table> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + <p class=MsoNormal><span style='font-family:Courier;color:black'><o:p> </o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>If + you are using TortoiseCVS in Windows, simply right-click on the project + folder and go to CVS -> Make Patch...<o:p></o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><span + style='mso-spacerun:yes'> </span><o:p></o:p></span></p> + <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span + style='font-family:"Book Antiqua";color:black'>4.</span></b><span + style='font-family:"Book Antiqua";color:black'> Submit the patch file via the + Patches link on the SourceForge project page.<o:p></o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>Note: + If SourceForge adds Subversion support (which they are currently testing), + OPAL will probably switch over to that rather than CVS.<span + style='mso-spacerun:yes'> </span>The general patch submission process will + be mostly unchanged, however.<o:p></o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><span + style='mso-spacerun:yes'> </span><o:p></o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span style='font-size:16.0pt;font-family:"Book Antiqua";color:black'>Design *************** *** 208,213 **** object needed to restore the state of the simulation should be added to that object's Data class.<span style='mso-spacerun:yes'> </span>All variables in ! an object's Data class should be handled by the <span class=SpellE>BlueprintManager</span> ! when loading/saving XML files.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span --- 293,298 ---- object needed to restore the state of the simulation should be added to that object's Data class.<span style='mso-spacerun:yes'> </span>All variables in ! an object's Data class should be handled by the BlueprintManager when ! loading/saving XML files.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span *************** *** 225,230 **** indentation, not spaces.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><br> ! All curly braces should be on new lines (even for one-line if ! statements).<span style='mso-spacerun:yes'> </span>For example:<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>if(test)<br> {<o:p></o:p></span></p> --- 310,315 ---- indentation, not spaces.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><br> ! All curly braces should be on new lines (even for one-line if statements).<span ! style='mso-spacerun:yes'> </span>For example:<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>if(test)<br> {<o:p></o:p></span></p> *************** *** 253,261 **** Naming Conventions<o:p></o:p></span></b></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>Pascal ! casing capitalizes the first letter of each word (e.g. <span ! class=SpellE>FooBar</span>)<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>Camel ! casing capitalizes the first letter of each word except the first one (e.g. <span ! class=SpellE>fooBar</span>)<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><br> Classes - Pascal casing<br> --- 338,345 ---- Naming Conventions<o:p></o:p></span></b></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>Pascal ! casing capitalizes the first letter of each word (e.g. FooBar)<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>Camel ! casing capitalizes the first letter of each word except the first one (e.g. ! fooBar)<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><br> Classes - Pascal casing<br> *************** *** 265,276 **** Functions Camel casing<br> Function arguments Camel casing<br> ! Internal Functions - Camel casing with internal_ prefix (an internal function ! is a class member function that needs to be publicly accessible but should ! not be accessed through the API)<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>All get/set functions begin with get and set except get functions that return ! a <span class=SpellE>boolean</span>, in which case the name should start with ! is.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span --- 349,359 ---- Functions Camel casing<br> Function arguments Camel casing<br> ! Internal Functions - Camel casing with internal_ prefix (an internal ! function is a class member function that needs to be publicly accessible but ! should not be accessed through the API)<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>All get/set functions begin with get and set except get functions that return ! a boolean, in which case the name should start with is.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><b style='mso-bidi-font-weight:normal'><span *************** *** 279,294 **** important that the source code is well-documented in two ways: 1) all components of the public API should have a detailed description of their ! function; this information gets automatically incorporated into the <span ! class=SpellE>Doxygen</span>-generated API documentation, and 2) all ! potentially confusing source code should be explained in the code.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> ! <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>Use <span ! class=SpellE>Doxygen</span> triple slash commenting style (e.g. /// Some ! comment) in front of all class, function, variable, <span class=SpellE>enum</span>, ! namespace, etc. definitions.<span style='mso-spacerun:yes'> </span>Otherwise ! use all double slash comments (e.g. // Some comment), not block comments ! (e.g. /* Some comment */).<span style='mso-spacerun:yes'> </span>Most source ! code editors have built-in functions for selecting and commenting out chunks ! of code, and they usually use double slash comments. <o:p></o:p></span></p> </td> </tr> --- 362,377 ---- important that the source code is well-documented in two ways: 1) all components of the public API should have a detailed description of their ! function; this information gets automatically incorporated into the ! Doxygen-generated API documentation, and 2) all potentially confusing source ! code should be explained in the code.<o:p></o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> ! <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'>Use ! Doxygen triple slash commenting style (e.g. /// Some comment) in front of all ! class, function, variable, enum, namespace, etc. definitions.<span ! style='mso-spacerun:yes'> </span>Otherwise use all double slash comments ! (e.g. // Some comment), not block comments (e.g. /* Some comment */).<span ! style='mso-spacerun:yes'> </span>Most source code editors have built-in ! functions for selecting and commenting out chunks of code, and they usually ! use double slash comments. <o:p></o:p></span></p> </td> </tr> |
