home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / misc2 / scctrl.lzh / DOC.SCC next >
Encoding:
Text File  |  1991-06-12  |  30.1 KB  |  933 lines
  1.                            SCC Doc.scc
  2.  
  3.                   Software Change Control (SCC)
  4.  
  5.              Copyright (c) 1990-91 by Walter Erickson
  6.                       All Rights Reserved.
  7.  
  8.                          Softime Systems
  9.                           P.O Box 2447
  10.                   Lake Ronkonkoma LI. NY 11779
  11.                          (516) 981-8386
  12.  
  13.  
  14.  
  15.                       DISCLAIMER - AGREEMENT
  16.                       ----------------------
  17.      Users of SCC must accept this disclaimer of warranty:
  18. "SCC is supplied as is.  The author disclaims all warranties,
  19. expressed or implied, including, without limitation, the
  20. warranties of merchantability and of fitness for any purpose. The
  21. author assumes no liability for damages, direct or consequential,
  22. which may result from the use of SCC."
  23.  
  24.     
  25.                           Installing SCC
  26.                           --------------
  27.  
  28.   To install SCC on your system refer to "readme.scc" file.
  29.  
  30.                           Special Notes
  31.                           -------------
  32.  
  33.   See "invoice.scc" for explication of the differences between the
  34. above SCC "Shareware" and "registered" options.
  35.   This documentation covers all copies of SCC, the freely distributed
  36. and "registered" versions. If a particular part only applies to a 
  37. certain SCC copy it will be noted as
  38.  
  39.                        ONLY SCC "Shareware"
  40.                        -------------------
  41.  
  42.                      ONLY SCC_I  "registered"
  43.                      -----------------------
  44.  
  45.                   ONLY SCC_I SCC_II "registered"
  46.                   -----------------------------
  47.  
  48.   See "invoice.scc" for explication of the differences between the
  49. above SCC "Shareware" and "registered" options.
  50.  
  51. Page 1
  52.      
  53.                    Common questions about SCC
  54.                    --------------------------
  55.  
  56.                           What is SCC ?
  57.                           -------------
  58.  
  59.   Software Change Control (SCC), as the name implies, is one of
  60. the most powerful and cost-effective products available.
  61.  
  62.   SCC closely tracks (logs) all software/text changes between two
  63. similar source files, thereby giving a complete (version to
  64. version) audit trail.
  65.  
  66.  
  67.  
  68.                         What does SCC do ?
  69.                         ------------------
  70.  
  71.   When SCC is run, the tracking (output) log file will then
  72. reflect (in context) what changes that have occurred between the
  73. two (input) source files, thus allowing the programmer and/or
  74. management to have a clear visual SCC log of all software and/or
  75. text changes.
  76.  
  77.   This feature enables the user to control all enhancements and
  78. documentation of source data at this critical level.
  79.  
  80.  
  81.  
  82.                        Why is SCC needed ?
  83.                        -------------------
  84.  
  85.   All software source files will need changes. In fact, it is a
  86. truism that every software project released, including those
  87. released quite recently, need changes. The most important
  88. consideration at this stage is to regulate and control the
  89. documentation and its changes.
  90.  
  91.   SCC is a decomposition process that offers a complete, precise
  92. description of what changes have occurred between two source
  93. files. This results in faster development time, along with
  94. software that is far less likely to fail in use.
  95.  
  96. Page 2
  97.      
  98.                        Can managers use SCC ?
  99.                        ----------------------
  100.  
  101.   The management of software changes at the programming (source)
  102. level (generally accepted as the most expensive and weakest link
  103. in software management) is one of the most difficult problems
  104. managers and programmers alike have.
  105.  
  106.   Using SCC creates an environment that is very time and cost
  107. effective. SCC allows changes to be made in a more maintainable,
  108. reliable and controllable way; that is, software control is fully
  109. documented, along with a full audit trail of what changes have
  110. occurred between software versions. 
  111.  
  112.   SCC greatly improves the suitability and appropriateness of
  113. software change documents; enhances clarity, readability,
  114. reliability and complete recoverability; allowing software
  115. changes to be a great deal easier to track and maintain.
  116.  
  117.  
  118.  
  119.                 Does SCC require a special editor ?
  120.                 -----------------------------------
  121.  
  122.   No, all that is required is that the input source files to SCC
  123. be in (ASCII TEXT) format.
  124.  
  125.  
  126.  
  127.                    Does SCC require a data base ?
  128.                    ------------------------------
  129.  
  130.   No, SCC can either be integrated into a data base or stand
  131. alone, for most small projects a data base is not necessary, thus
  132. eliminating complexity and cost (KISS). All header file-id, code
  133. and documentation changes "between versions" are kept within the
  134. SCC Log itself.
  135.  
  136.  
  137.  
  138.              Can I run SCC against existing versions ?
  139.              -----------------------------------------
  140.  
  141.   Yes, you can build new and complete SCC change logs from older
  142. existing (version to version) files, this will give a complete
  143. audit trail of any software changes between versions.
  144.  
  145. Page 3
  146.      
  147.                     What can SCC be used for ?
  148.                     --------------------------
  149.  
  150.     o Documenting
  151.     o Software/text control
  152.     o Software Debugging
  153.     o Code walkthrough's
  154.     o etc.
  155.  
  156.  
  157.  
  158.                     Using SCC for Documenting
  159.                     -------------------------
  160.  
  161.   When SCC is run, the tracking (output) log file will then
  162. reflect (in context) what changes that have occurred between the
  163. two (input) source files, thus allowing the programmer and/or
  164. management to control, enhance and document software at this
  165. critical source level.
  166.  
  167.   SCC generates a software change (log) that closely tracks and
  168. records all changes
  169.  
  170.  
  171.  
  172.                   Using SCC for Software control
  173.                   ------------------------------
  174.  
  175.   The manager/programmer can visually see on one listing (the
  176. change log) all changes and special tracking symbols that were
  177. necessary to build the later version from the early version, thus
  178. keeping an accurate control over all changes.
  179.  
  180.   For example: to (recover delete errors) the change log can be
  181. used as a source reference by copying from the log file any
  182. (special marked) unwanted deletes, then reinserting them back
  183. into the later version.
  184.  
  185.   The reverse (delete insert errors) can be viewed from the log
  186. file and the necessary edits can be done directly into the
  187. later version.
  188.  
  189.   When SCC is re-run, using the just updated later version, a new
  190. SCC (output) log file will be rebuilt.
  191.  
  192.   This rebuilt log will then reflect all the recovered changes
  193. that were just made against the later version.
  194.  
  195.   SCC will also reveal all unintentional and possible
  196. unauthorized changes to source files, thus preventing future
  197. problems in the next released version. 
  198.  
  199. Page 4
  200.      
  201.                      SCC as a debugging aid
  202.                      ----------------------
  203.  
  204.   If a feature in the software has a bug in the later version,
  205. and that same feature had no bug in the earlier version, the
  206. programmer can use SCC as a debugging aid.
  207.  
  208.   If the programmer does not already have an SCC log, he can run
  209. SCC against the earlier and later versions to generate a SCC log.
  210.  
  211.   Then programmer can visually see on one listing (the SCC log)
  212. all changes that were necessary to build the (now buggy) later
  213. version.
  214.  
  215.   By reviewing and using the SCC change log as a source file, the
  216. programmer can experiment by removing or reinserting what changes
  217. created the (now buggy) later version. By isolating those
  218. changes, the programmer should be better able to locate what
  219. caused the bug, thus eliminating an untold amount of time and
  220. money by using the older method.
  221.  
  222.  
  223.  
  224.                           SCC summary
  225.                           -----------
  226.  
  227.   o  SCC is a comprehensive utility designed to compare two files
  228.      and generate various reports (log files) that display any or all
  229.      change differences.
  230.  
  231.   o  SCC log records who, why, when and where changes were made,
  232.      thus maintaining a complete history of all changes.
  233.  
  234.   o  SCC enables detailed verification of auditing accuracy,
  235.      eliminates undetected programming errors and drastically reduces
  236.      manual desk checking time.
  237.  
  238.   o  The manager/programmer knows exactly what the changes are
  239.      between versions.
  240.  
  241.   o  SCC accepts (ASCII TEXT) output from your favored editor.
  242.  
  243.   o  You can build new and complete SCC change logs from older
  244.      existing (version to version) files.
  245.  
  246.   o  You can track any coding progress on software changes by
  247.      viewing an SCC log against the previous and developing files.
  248.  
  249.   o  You can backtrack to any version to find what changes created
  250.      that version at that time.
  251.  
  252.   o  SCC change logs (version to version) can greatly help in
  253.      debugging source code errors between releases (one works the
  254.      other does not)
  255.  
  256. Page 5
  257.      
  258.                             LOG_BUILD
  259.                             ---------
  260.  
  261.   The SCC Log is the first (output) file to be built using two
  262. similar, but modified, source (input) files. When an SCC Log 
  263. (type) is selected to be built, this Log file will record all 
  264. control numbers, changes and selected options in a clear fully
  265. documented and printable form.
  266.  
  267.  
  268.  
  269.                             LOG_BUILD
  270.                             ---------
  271.  
  272.                      ONLY SCC_II "registered"
  273.                      -----------------------
  274.    You can reconstruct any version (forward or backward) from the
  275. SCC log file.  Selecting this menu will give you several options
  276. of how the SCC Log (output) file will be built. A few of the SCC
  277. Log build options are (Long, Medium, or Short) Log types, Header
  278. information, ignore upper/lower case, etc.
  279.  
  280.  
  281.  
  282.                          OLD_MASTER_BUILD
  283.                          ----------------
  284.  
  285.                      ONLY SCC_II "registered"
  286.                      -----------------------
  287.   SCC can re-build an Old master (output) file from a single file
  288. by using the LONG type SCC Log file alone. SCC also can re-build
  289. an Old master (output) file from two (input) files by using the
  290. MEDIUM or SHORT type SCC Log file and its associated New master file.
  291.  
  292.  
  293.  
  294.                          NEW_MASTER_BUILD
  295.                          ----------------
  296.  
  297.                      ONLY SCC_II "registered"
  298.                      -----------------------
  299.   SCC can re-build a New master (output) file from a single file
  300. by using the LONG type SCC Log (input) file alone. SCC also can
  301. re-build a New master (output) file from two (input) files by using
  302. the MEDIUM or SHORT type SCC Log file and its associated Old master
  303. file.
  304.  
  305.  
  306.                             UTILITIES
  307.                             ---------
  308.  
  309.   This menu contains a renumbering utility that will create a
  310. (numbered) copy of an original file.
  311.  
  312. Page 6
  313.      
  314.                         (SCC) Log Header
  315.                         ----------------
  316.  
  317.                      ONLY SCC_II "registered"
  318.                      -----------------------
  319.   The Log Header File describes various user input parameters
  320. similar to the following.
  321.  
  322.      Entered_By ......................
  323.      Author ..........................
  324.      Date_Created ....................
  325.      Edit_Last_By ....................
  326.      Project .........................
  327.      Project_Type ....................
  328.      Application .....................
  329.      File ............................
  330.      Location ........................
  331.      Description .....................
  332.      etc. etc. .......................
  333.  
  334.   If any of the above fields are filled in then, those fields
  335. will be included as part of the SCC Log File.
  336.  
  337.  
  338.  
  339.                           LONG_LOG_BUILD
  340.                           --------------
  341.  
  342.   A Long and detailed SCC Log will show all control numbers along
  343. with  their corresponding deleted/inserted lines from the Old/New
  344. masters. This Log will also show all the unchanged (common) lines
  345. between the two files.  During development and debugging time, the
  346. Long Log can be used (in context) as a visual overview of all the
  347. changes and documentation that were necessary to build the present
  348. (New master) file.
  349.  
  350.  
  351.                           LONG_LOG_BUILD
  352.                           --------------
  353.  
  354.                      ONLY SCC_II "registered"
  355.                      -----------------------
  356.   The Long SCC Log has all the necessary information (no need for
  357. any other input file) to re-build either the New or Old master
  358. (output) files.
  359.  
  360. Page 7
  361.      
  362.                           LONG_LOG_BUILD
  363.                           --------------
  364.  
  365.   One of the general purposes of the Long SCC Log is to assist in
  366. the development of a New master update. It also aids in the
  367. backtracking to earlier versions for the purpose of viewing and
  368. debugging past undocumented changes.
  369.  
  370.   The Long SCC Log helps the programmer and manager to make
  371. changes, "edit out" any tactical coding/design errors between
  372. two source files. This is usually done by using a similar method
  373. such as the following:
  374.  
  375.  
  376.   Initial Technical Design Review
  377.     o revision of raw draft coding design
  378.     o clarification of ambiguous design content
  379.     o identification of coding gaps and         
  380.       inconsistencies
  381.     o discovery of major/minor coding errors
  382.  
  383.   Quick Coding Review
  384.     o verification of technical content NOT     
  385.       already tested/debugged
  386.     o incorporation of late technical coding    
  387.       changes
  388.     o writing specs for changed documentation
  389.  
  390.   Final Technical Design Review
  391.     o refining the source code/documentation    
  392.       for usability
  393.     o minor "edit" cleanup
  394.     o careful configuration control and test    
  395.       proofing
  396.  
  397.   Field Maintenance of Released Software
  398.     o discovery of unintentional coding errors
  399.     o discovery of undocumented features
  400.  
  401. Page 8
  402.      
  403.                     Long SCC Log Control format
  404.                     ---------------------------
  405.  
  406.                         ONLY SCC Shareware
  407.                         ------------------
  408.  
  409. #        Log control character
  410. #Change  change number
  411. #
  412. # ... (at line #:), # lines deleted from old filename
  413. # ... # (New) lines inserted into new filename
  414. #
  415. -        Old  changed or deleted line
  416.          Old  moved   or ignored line optional
  417.     62:  New  moved   or ignored line optional
  418. +   63:  New  changed or added   line
  419.     64:  New & Old       common  line
  420.  
  421.  
  422.  
  423.                    Long SCC Log Control format
  424.                    ---------------------------
  425.  
  426.                  ONLY SCC_I and SCC_II "registered"
  427.                  ---------------------------------
  428.  
  429. #        Log control character
  430. #Change  change number
  431. #15,25   Old  deleted            line numbers
  432. #10,63   New  added              line numbers
  433. -        Old  changed or deleted line
  434.          Old  moved   or ignored line optional
  435.     62:  New  moved   or ignored line optional
  436. +   63:  New  changed or added   line
  437.     64:  New & Old       common  line
  438.  
  439.   Note:  a single number is a line placeholder
  440.  
  441. #100     Old  placeholder        line
  442. #140     New  placeholder        line
  443.  
  444. Page 9
  445.      
  446.                          MEDIUM_LOG_BUILD
  447.                          ----------------
  448.  
  449.                         ONLY SCC Shareware
  450.                         ------------------
  451.  
  452. #        Log control character
  453. #Change  change number
  454. #
  455. # ... (at line #:), # lines deleted from old filename
  456. # ... # (New) lines inserted into new filename
  457. #
  458. -        Old  changed or deleted line
  459.          Old  moved   or ignored line optional
  460.     62:  New  moved   or ignored line optional
  461. +   63:  New  changed or added   line
  462.  
  463.  
  464.                  ONLY SCC_I and SCC_II "registered"
  465.                  ---------------------------------
  466.  
  467.   A Medium SCC Log will show all control numbers along with their
  468. corresponding deleted/inserted lines from the Old/New masters. One
  469. of the main benefits of the Medium SCC Log is that the Log file is
  470. generally much smaller (no common Old/New coded lines). All the
  471. delete/insert changes can still be seen.
  472.  
  473.  
  474.  
  475.                          MEDIUM_LOG_BUILD
  476.                          ----------------
  477.  
  478.                      ONLY SCC_II "registered"
  479.                      -----------------------
  480.   The Medium SCC Log has all the necessary (input) information
  481. along with an Old/New (input) master to re-build either New/Old
  482. master (output) file.
  483.  
  484.  
  485.  
  486.                   Medium SCC Log Control format
  487.                   -----------------------------
  488.  
  489. #        Log control character
  490. #Change  change number
  491. #15,25   Old  deleted            line numbers
  492. #10,63   New  added              line numbers
  493. -        Old  changed or deleted line
  494.          Old  moved   or ignored line optional
  495.     62:  New  moved   or ignored line optional
  496. +   63:  New  changed or added   line
  497.  
  498.   Note:  a single number is a line placeholder
  499.  
  500. #100     Old  placeholder        line
  501. #140     New  placeholder        line
  502.  
  503. Page 10
  504.      
  505.                        FWD_SHORT_LOG_BUILD
  506.                        -------------------
  507.  
  508.                      ONLY SCC_II "registered"
  509.                      -----------------------
  510.   The Forward short SCC Log has all the necessary (input)
  511. information along with an Old master (input) file to re-build a
  512. New master (output) file.
  513.  
  514.   The main benefits of the forward short SCC Log is that
  515.   o the Log file generally is far smaller than either Long or
  516. Medium Log types
  517.   o The control numbers and newly inserted changes can still be
  518. seen
  519.   o Only an earlier reference (Old master) and a series of the
  520. (smaller) Forward Short Logs has to be kept in order to rebuild
  521. up to the present New master, thus saving a lot of storage space.
  522.  
  523.   For example: starting from an earlier reference (Old master)
  524. any New master version can be daisy-chained (rebuilt) from its
  525. associated Log. This rebuilding process can continue up to the
  526. New master desired.
  527.  
  528.  
  529.  
  530.               Forward Short SCC Log Control format
  531.               ------------------------------------
  532.  
  533.                      ONLY SCC_II "registered"
  534.                      -----------------------
  535. #        Log control character
  536. #Change  change number
  537. #15,25   Old  deleted            line numbers
  538. #10,63   New  added              line numbers
  539.     10:  New  added              line
  540.  
  541.   Note:  a single number is a line placeholder
  542.  
  543. #140     New  placeholder        line
  544.  
  545. Page 11
  546.      
  547.                        REV_SHORT_LOG_BUILD
  548.                        -------------------
  549.  
  550.                      ONLY SCC_II "registered"
  551.                      -----------------------
  552.   The Reverse short SCC Log has all the necessary (input)
  553. information along with a New master (input) file to re-build an
  554. Old master (output) file.
  555.  
  556.   The main benefits of the reverse short SCC Log is that
  557.   o the Log file generally is far smaller than either Long or
  558. Medium Log types
  559.   o The control numbers and newly deleted changes can still be
  560. seen
  561.   o Only a later reference (New master) and a series of the
  562. (smaller) Reverse Short Logs has to be kept in order to rebuild 
  563. back to the Old master desired, thus saving a lot of storage space.
  564.  
  565.   For example: starting from a later reference (New master) any
  566. Old master version can be daisy-chained (rebuilt) from its
  567. associated (New master) Log. This rebuilding process can continue
  568. up to the Old master version desired.
  569.  
  570.  
  571.  
  572.               Reverse Short SCC Log Control format
  573.               ------------------------------------
  574.  
  575.                     ONLY SCC_II "registered"
  576.                     -----------------------
  577. #        Log control character
  578. #Change  change number
  579. #15,25   Old  deleted            line numbers
  580. #10,63   New  added              line numbers
  581.     15:  Old  deleted            line
  582.  
  583.   Note:  a single number is a line placeholder
  584.  
  585. #100     Old  placeholder        line
  586.  
  587. Page 12
  588.      
  589.                          CRUNCH_LOG_BUILD
  590.                          ----------------
  591.  
  592.   SCC Crunch Log purpose is for condensed VIEWING only (cannot be
  593. used to rebuild a master file). 
  594.  
  595.   The SCC Crunch Log will NOT reflect:
  596.     o  change control information
  597.     o  common lines between masters
  598.     o  moved (but not changed) lines
  599.     o  the set SCC Log (ignore) options.
  600.  
  601.   The SCC Crunch Log WILL reflect:
  602.     o  the SCC Crunch header
  603.     o  all the log lines with -/+ indicators.
  604.     o  - Old line numbers, changed or deleted
  605.     o  + New line numbers, changed or inserted
  606.  
  607.  
  608.  
  609.                       Crunch SCC Log format
  610.                       ---------------------
  611.  
  612. -   20:  Old  changed or deleted line
  613. +   63:  New  changed or added   line
  614.  
  615.  
  616.  
  617.                          Use Your Editor
  618.                          ---------------
  619.  
  620.   In order to edit, you must first set your editor name
  621.  
  622.   For "SCC Log" data integrity, your editor will be able only
  623. to read the SCC Log.
  624.  
  625.   If you wish to change the SCC Log, re-edit the (New) master
  626. input file, then re-build the SCC Log.
  627.  
  628.   You need only to enter the file-name for your choice of editor.
  629. DOS must be able to find the editor in order to run, therefore
  630. the editor "DOS path" should exist, or the editor itself must
  631. be in the present directory.
  632.  
  633. Page 13
  634.      
  635.                            SUSPEND SCC 
  636.                            -----------
  637.  
  638.                          Go to DOS shell
  639.                   To return to SCC, type "exit"
  640.  
  641.  
  642.  
  643.  
  644.                           RUN_LOG_BUILD
  645.                           -------------
  646.  
  647.   Before the RUN option appears on the menu (not blank) the
  648. operator must select from the menu the type Log desired (Long,
  649. Medium, Crunch, etc). Then enter the appropriate Old and
  650. New master (input) file names. A suggested Log file (output) name
  651. will then appear and, if desired, this name can be accepted or
  652. changed. 
  653.  
  654.   If the RUN option appears in the menu, then the operator can
  655. select same to build the log file. If the RUN option does not
  656. appear, retry the above.
  657.  
  658.  
  659.  
  660.                        NEW_MASTER_RE_BUILD
  661.                        -------------------
  662.  
  663.                      ONLY SCC_II "registered"
  664.                      -----------------------
  665.   SCC can re-build the New master (output) file from a single
  666. file by using the LONG type SCC Log file alone.
  667.  
  668.   SCC also can re-build the New master (output) file from two
  669. (input) files by using a MEDIUM or SHORT type SCC Log file and an
  670. Old master file.
  671.  
  672.  
  673.  
  674.                      RUN_NEW_MASTER_RE_BUILD
  675.                      -----------------------
  676.  
  677.                      ONLY SCC_II "registered"
  678.                      -----------------------
  679.   Before the RUN option will appear on the menu (not '~') the
  680. operator must enter the appropriate Log file (input) name and, if
  681. required (by the type Log), an Old master file (input) name. Then
  682. a suggested New master (output) name will appear and, if desired,
  683. this name can be accepted or changed. 
  684.  
  685.   If the RUN option appears in the menu, then the operator can
  686. select same to build the log file. If the RUN option does not
  687. appear, retry the above.
  688.  
  689. Page 14
  690.      
  691.                        OLD_MASTER_RE_BUILD
  692.                        -------------------
  693.  
  694.                      ONLY SCC_II "registered"
  695.                      -----------------------
  696.   SCC can re-build the Old master (output) file from a single
  697. file by using the LONG type SCC Log (input) file alone.
  698.  
  699.   SCC also can re-build the Old master (output) file from two
  700. (input) files by using a MEDIUM or SHORT type SCC Log file and a
  701. New master file.
  702.  
  703.  
  704.  
  705.                      RUN_OLD_MASTER_RE_BUILD
  706.                      -----------------------
  707.  
  708.                      ONLY SCC_II "registered"
  709.                      -----------------------
  710.   Before the RUN option will appear on the menu (not '~') the
  711. operator must enter the appropriate Log file (input) name and if
  712. required (by the type Log), a New master file (input) name. Then
  713. a suggested Old master (output) name will appear and, if desired,
  714. this name can be accepted or changed. 
  715.  
  716.   If the RUN option appears in the menu, then the operator can
  717. select same to build the log file. If the RUN option does not
  718. appear, retry the above.
  719.  
  720. Page 15
  721.      
  722.                              VIEW_LOG
  723.                              --------
  724.  
  725.   View (or your editor) can be used as a quick visual format
  726. verification of a SCC file.
  727.  
  728.   For example: you can look over (or edit, using your editor) a
  729. tentative new master, or review a just generated SCC Log file for
  730. items such as:
  731.   o SCC Log header contents
  732.   o option settings of the SCC Log
  733.   o Change (auditing) accuracy of the new
  734.     master.
  735.  
  736.   Using this quick view greatly helps with the elimination of
  737. possible unintended design and/or change errors, thus drastically
  738. reducing desk checking time.
  739.  
  740.   The Following describes view key commands.
  741.  (F1) gives the same key help.
  742.  
  743.   HOME          top   of    document
  744.   END           end   of    document
  745.   PGUP          up    one   screen  
  746.   PGDN          down  one   screen  
  747.   CTRL  HOME    start of    line   
  748.   UP    ARROW   up    one   line    
  749.   DOWN  ARROW   down  one   line    
  750.   RIGHT ARROW   move  right line    
  751.   LEFT  ARROW   move  left  line
  752.     
  753.   Special "log" commands          
  754.   ------------------------
  755.  'P'    previous    change #        
  756.  'N'    next        change #        
  757.  'G'    goto log    line   #        
  758.  'L'    lock cursor toggle        
  759.  'E'    Your Editor 
  760.  
  761.   ONLY SCC_I SCC_II "registered"
  762.   -----------------------------
  763.  'X'    goto match  line   #        
  764.  'Z'    flip match  line   #        
  765.  
  766.  
  767.                             NUMBER_FILE
  768.                             -----------
  769.  
  770.   This will create a numbered (printable) copy of an original
  771. master file (with an extension of .num).
  772.  
  773.   This printed file may be used as a visual reference along the
  774. side of a SCC generated change log. These files then, can be used
  775. for direct change validation and conformation.
  776.  
  777.                           RUN_NUMBER_FILE
  778.                           ---------------
  779.  
  780. Page 16
  781.      
  782.                              LOG_DETAIL
  783.                              ----------
  784.  
  785.                ONLY SCC_I and SCC_II "registered"
  786.                ---------------------------------
  787.   By selecting Yes; detailed comments will then be inserted into
  788. the next newly generated SCC log.
  789.  
  790.           Examples of the Detail option are as follows:
  791.  
  792. #
  793. #Change 1
  794. #
  795. #5,7  ... 3 (Old) lines deleted  from filename
  796. #2,2  ... 1 (New) lines inserted into filename
  797. #
  798.  
  799.   Note, a place-holder is a line number marker where an insertion
  800. or deletion would have taken place in the (Old/New) filename (if
  801. insertion or deletions were needed).
  802. #
  803. #Change 2
  804. #
  805. #9,10 ... 2 (Old) lines deleted  from filename
  806. #7    ... (New) line place-holder for filename
  807. #
  808.  
  809. #
  810. #Change 3
  811. #
  812. #19   ... (Old) line place-holder for filename
  813. #9,12 ... 4 (New) lines inserted into filename
  814. #
  815.  
  816. Page 17
  817.      
  818.                          STRIP_END_WHITE
  819.                          ---------------
  820.  
  821.   By selecting Yes; this option will eliminate (strip) any ending
  822. white space (spaces and tabs) between the two master files.
  823.  
  824.   Since ending white space will be striped from both files, the
  825. SCC log (change) comparison procedure will then only be able to
  826. compare (each line) up to its last visual character.
  827.  
  828.   When this option is selected the resulting built SCC log
  829. control lines will also have no ending white space. Thus a master
  830. rebuilt from this log (forward/backward) will also have no
  831. corresponding ending white space.
  832.  
  833.  
  834.  
  835.                            IGNORE_CASE
  836.                            -----------
  837.  
  838.   By selecting Yes; Upper/Lower case will be treated as equal
  839. characters (will not trigger the -/+ log indicators).
  840.  
  841.   For example:
  842.  
  843.      Old master          New master
  844.      ----------          ----------
  845.     "Abc"             = "abc"
  846.     "NOW IS THE TIME" = "now is the time"
  847.  
  848.  
  849.  
  850.                           IGNORE_WHITE
  851.                           ------------
  852.  
  853.   By selecting Yes; all white characters (space tab, carriage
  854. return, new line and vertical tab) will be ignored (will not
  855. trigger the -/+ log indicators).
  856.  
  857.   For example:
  858.  
  859.      Old master    New master
  860.      ----------    ----------
  861.     "The quick" = "T h e   q  uic  k"
  862.  
  863. Page 18
  864.      
  865.                          IGNORE_NUMBERS
  866.                          --------------
  867.  
  868.   By selecting Yes; all Numbers will be ignored (will not trigger
  869. the -/+ log indicators).
  870.  
  871.   For example:
  872.  
  873.      Old master    New master
  874.      ----------    ----------
  875.     "goto 1234" = "goto 567"
  876.  
  877.  
  878.  
  879.                          IGNORE_STRINGS
  880.                          --------------
  881.  
  882.                ONLY SCC_I and SCC_II "registered"
  883.                ---------------------------------
  884.   By selecting Yes; each character string that is inserted into
  885. the list will be ignored (will not trigger the -/+ log
  886. indicators).
  887.  
  888.   For example let:
  889.      string 1 = "brown"
  890.      string 2 = "uic"
  891.  
  892.      Old master          New master
  893.      ----------          ----------
  894.     "The quick brown" = "The quick "
  895.     "The quick brown" = "The qk brown"
  896.      
  897.  
  898. Page 19
  899.  
  900.      SCC can also be run as batch mode by typing for (batch) help
  901.  
  902.                C:> SCC /        <enter>
  903.  
  904.      or follow the below BATCH format
  905.  
  906.                                Between {} are optional\n");
  907.         LOG_BUILD              -----------------------\n");
  908.            OPTIONS             = /LO,{E},{C},{W},{N}\n");
  909.               STRIP_END_WHITE  =  ----|   |   |   |\n");
  910.               IGNORE_CASE      =  --------|   |   |\n");
  911.               IGNORE_WHITE     =  ------------|   |\n");
  912.               IGNORE_NUMBERS   =  ----------------|\n");
  913.            LONG_LOG_BUILD      = /LL,old-master,new-master,{log-name}\n");
  914.            MEDIUM_LOG_BUILD    = /LM,old-master,new-master,{log-name}\n");
  915.            CRUNCH_LOG_BUILD    = /LC,old-master,new-master,{log-name}\n");
  916.         UTILITIES \n");
  917.            NUMBER FILE         = /UN,in-file,{out-file}\n");
  918.         VIEW                   = /V,{log},{your-editor}\n");
  919.  
  920.      for example, to build a LONG Log with ignore (white space) and a view
  921.      type in the following.
  922.  
  923.      
  924.                C:> SCC /LO,W /LL,sample.v1,sample.v2 /V        <enter>
  925.  
  926.  
  927.      
  928.      To number a file for reference with a view, type in the following.
  929.  
  930.      
  931.                C:> SCC /UN,sample.v1 /V        <enter>
  932.  
  933.