Laserfiche WebLink
The types of files that can and should be stored using revision control are: <br />Source code files, including header files. <br />? <br />Makefiles and/or imakefiles (see Task Memorandum 1.05-21). <br />? <br />UNIX shell script programs. <br />? <br />mosaic <br />Documentation, including man pages, documentation, and other documents. <br />? <br />Certain data sets, e.g., sample data sets (if stored and distributed with program source <br />? <br />code). <br />Other important text files (e.g., configuration files). <br />? <br />Although it takes some time to place files under revision control, doing so results in a more refined <br />file organization, and also protects the developer from lost work. <br />Compiling Revision Control Files <br />Compilers cannot directly process files that are under revision control because of the revision control <br />commands within the files. Consequently, files must be extracted from revision control before they <br />are compiled. Two situations can exist: <br />(1)The file is already extracted because someone is revising the file (and recompiling to test <br />the functionality of a routine). This situation also occurs when a file that is under revision <br />control is extracted for compiling or printing but is not being edited. <br />(2)The file is not extracted and exists in revision control form only. <br />In the first case when the file is being edited, the editable file should remain after the compile is <br />complete because more changes to the file may be made. In the second case, the editable file should <br />be removed because it is only being used to compile, and there is no reason to edit the file. The <br />make <br /> program, which is used to maintain software projects (see Task Memorandum 1.05-21) can be <br />configured to have default rules for processing files that are under revision control. For example, a <br />default rule to compile a ?.c,v? file (C routine under revision control) into a ?.o? file (object code) <br />make <br />can be written. The program understands that if a ?.c? file already exists, then it should <br />compile that file and leave it as is. However, the ?.c,v? to ?.o? rule (called a suffix rule) can be <br />written to automatically delete the ?.c,v? file after the compile has been done. This prevents a <br />compile operation from leaving many files checked-out of revision control. <br />Placing Existing Code Under Revision Control <br />It is important to place the original code of existing applications under revision control, even if <br />changes have been made during the Phase I activity. This ensures that the CRDSS code can be <br />validated against the original code. The procedure described in this section will use as an example <br />the ?abnorm? subroutine taken from the CRSM code supplied to the State by the USBR. The State <br />has modified a copy of the original code since it was received. <br />3 <br />A275 01.08.95 1.05-20 Malers <br />