Changeset 493 for palm/trunk/DOC/tec
- Timestamp:
- Mar 1, 2010 8:30:24 AM (15 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
palm/trunk/DOC/tec/technical_documentation.html
r486 r493 1 1 <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en"> 2 2 <html><head> 3 4 3 5 4 6 … … 27 29 </p><ul> <a href="#Kapitel1.0">1.0</a> 28 30 History of changes <p><a href="#Kapitel2.0">2.0</a> 29 How to change the model source 30 code </p> <p><a href="#Kapitel3.0">3.0</a> 31 How to change the source 32 code and how to document modifications<br> 33 </p> <p><a href="#Kapitel3.0">3.0</a> 31 34 Description of selected model numerics<br> 32 35 </p> … … 917 920 <br> 918 921 <h2><a name="Kapitel2.0"></a>2.0 How 919 to change the model source 920 code</h2>Currently 922 to change the source 923 code and how to document modifications<br> 924 </h2>Currently 921 925 (Sep 23rd, 2009), only selected users are allowed to commit changes to 922 the repository. Some rules about how to check in modified code will be 923 added later.<br> 926 the repository. Rules given below are preliminary, until we have switched to the "trac"-System.<br> 927 <br> 928 <ol> 929 <li>Change source code in your current working copy. Document changes in the respective file headers unter "<span style="font-family: Courier New,Courier,monospace;">Current revisions:</span>". 930 Additionally, document all changes in a local file (e.g. 931 ~/palm/current_version/CURRENT_MODIFICATIONS), including the files that 932 have been changed. Classify changes in three cases, new (N), changed 933 (C), and bugfix (B). <span style="font-weight: bold;">Try to be as short and as precise as possible in describing the changes!</span><br> 934 <br> 935 </li> 936 <li>Test the changed version, unless it works sufficiently.<br> 937 <br> 938 </li> 939 940 <li>Commit the changes to the repository<br> 941 <br> 942 <span style="font-family: Courier New,Courier,monospace;"> svn commit -m "message string" trunk<br> 943 </span><br> 944 where "<span style="font-family: Courier New,Courier,monospace;">message string</span>" is a short, <span style="font-weight: bold;">meaningful</span> summary of the changes.<br> 945 <br> 946 Alternatively, in case that you have made quite a lot of changes, you 947 can also give the contents of your file CURRENT_MODIFICATIONS as the 948 log message:<br> 949 <br> 950 <span style="font-family: Courier New,Courier,monospace;"> svn commit -F CURRENT_MODIFICATIONS trunk</span><br> 951 <br> 952 </li> 953 954 <li>Enter the changes into the technical documentation (under <span style="font-family: Courier New,Courier,monospace;">.../trunk/DOC/tec/technical_documentation.html</span>).<br> 955 <br> 956 </li> 957 <li>Move the change comments in the file headers from "Current 958 revisions:" to "Former revisions:". Set the current svn id in front of 959 that.<br> 960 <br> 961 <span style="font-weight: bold;">Example:</span><br> 962 <br> 963 <span style="font-weight: bold;">before move:</span><br> 964 <br> 965 <span style="font-family: Courier New,Courier,monospace;">! Current revisions:</span><br style="font-family: Courier New,Courier,monospace;"> 966 <span style="font-family: Courier New,Courier,monospace;">! -----------------</span><br style="font-family: Courier New,Courier,monospace;"> 967 <span style="font-family: Courier New,Courier,monospace;">! <span style="font-weight: bold;">new dummy argument abcd</span></span><span style="font-family: Courier New,Courier,monospace;"></span><br style="font-family: Courier New,Courier,monospace;"> 968 <span style="font-family: Courier New,Courier,monospace;">!</span><br style="font-family: Courier New,Courier,monospace;"> 969 <span style="font-family: Courier New,Courier,monospace;">! Former revisions:</span><br style="font-family: Courier New,Courier,monospace;"> 970 <span style="font-family: Courier New,Courier,monospace;">! -----------------</span><br style="font-family: Courier New,Courier,monospace;"> 971 <span style="font-family: Courier New,Courier,monospace;">! $Id$</span><br style="font-family: Courier New,Courier,monospace;"> 972 <span style="font-family: Courier New,Courier,monospace;">!</span><br style="font-family: Courier New,Courier,monospace;"> 973 <span style="font-family: Courier New,Courier,monospace;"></span><span style="font-family: Courier New,Courier,monospace;"></span><span style="font-family: Courier New,Courier,monospace;"></span><span style="font-family: Courier New,Courier,monospace;">! 407 2009-12-01 15:01:15Z maronga</span><br style="font-family: Courier New,Courier,monospace;"> 974 <span style="font-family: Courier New,Courier,monospace;">! var_ts is replaced by dots_max </span><br> 975 <br> 976 <span style="font-weight: bold;">after move:</span><br> 977 <br> 978 <span style="font-family: Courier New,Courier,monospace;">! Current revisions:</span><br style="font-family: Courier New,Courier,monospace;"> 979 980 <span style="font-family: Courier New,Courier,monospace;">! -----------------</span><br style="font-family: Courier New,Courier,monospace;"> 981 982 <span style="font-family: Courier New,Courier,monospace;">! </span><br style="font-family: Courier New,Courier,monospace;"> 983 984 <span style="font-family: Courier New,Courier,monospace;">!</span><br style="font-family: Courier New,Courier,monospace;"> 985 986 <span style="font-family: Courier New,Courier,monospace;">! Former revisions:</span><br style="font-family: Courier New,Courier,monospace;"> 987 988 <span style="font-family: Courier New,Courier,monospace;">! -----------------</span><br style="font-family: Courier New,Courier,monospace;"> 989 990 <span style="font-family: Courier New,Courier,monospace;">! $Id$<br> 991 !</span><br style="font-family: Courier New,Courier,monospace;"> 992 <span style="font-family: Courier New,Courier,monospace;">! </span><span style="font-family: Courier New,Courier,monospace;"><span style="font-weight: bold; color: rgb(51, 51, 255);">377 2008-08-30 11:03:41Z raasch</span><br> 993 ! </span><span style="font-family: Courier New,Courier,monospace; font-weight: bold;">new dummy argument abcd</span><br style="font-family: Courier New,Courier,monospace;"> 994 995 <span style="font-family: Courier New,Courier,monospace;">!</span><br style="font-family: Courier New,Courier,monospace;"> 996 997 <span style="font-family: Courier New,Courier,monospace;">! 359 2008-06-01 15:01:15Z maronga</span><br style="font-family: Courier New,Courier,monospace;"> 998 999 <span style="font-family: Courier New,Courier,monospace;">! var_ts is replaced by dots_max<br> 1000 </span><br> 1001 </li> 1002 <li>Commit the changes in the technical documentation and the file headers:<br> 1003 <br> 1004 <span style="font-family: Courier New,Courier,monospace;"> svn commit -m "last commit documented" trunk</span><br> 1005 <br> 1006 <br> 1007 </li> 1008 </ol> 1009 924 1010 <h2> 925 1011 <a name="Kapitel3.0"></a>3.0 Description
Note: See TracChangeset
for help on using the changeset viewer.