home *** CD-ROM | disk | FTP | other *** search
- #************************************
- #
- # Software Change Control (SCC)
- # Version 1.08 06-01-91
- #
- # Softime Systems
- # P.O Box 2447
- # Lake Ronkonkoma LI. NY 11779
- # (516) 981-8386
- #
- # Copyright (c) 1990-91 Walter Erickson
- # ALL RIGHTS RESERVED
- #
- # ------------ Header -------------
- # ---------------------------------
- #
- # Out LOG = sample.log
- # type = LONG
- # day/month/year = 16/6/1991
- # hr:min:sec = 10:31:21
- #
- # In MASTER (old) = sample.v1
- # lines = 263
- # length = 10931
- # day/month/year = 15/6/1991
- # hr:min:sec = 17:52:12
- # hash = 866619
- #
- # In MASTER (new) = sample.v2
- # lines = 398
- # length = 16448
- # day/month/year = 16/6/1991
- # hr:min:sec = 10:31:3
- # hash = 1281029
- #
- # ------- SCC Build Options -------
- #
- # Log Detail = Yes
- # Strip End White = No
- # Ignore Case = Yes
- # Ignore White = Yes
- # Ignore Numbers = Yes
- # Ignore Strings = Yes
- #
- # -------- Ignore Strings ---------
- #
- # String 1 = "Old"
- # String 2 = "New"
- # String 3 = "SCC"
- # String 4 = "CSS"
- # String 5 = "Funny"
- #
- #
- # User ID# PS2 0000-010106
- #************************************
-
-
- #
- #Change 1
- #
- #0 ... (Old) line place-holder for sample.v1
- #1,127 ... 127 (New) lines inserted into sample.v2
- #
- + 1: *** Please Read the following information ***
- + 2:
- + 3: This file must be viewed from within the SCC VIEW utility. Therefor
- + 4: start SCC by typing in at the prompt "SCC /v,reg_log.scc" or use SCC
- + 5: VIEW menu selection. This will bring up the SCC VIEW utility with this
- + 6: file displayed. Then continue reading the following.
- + 7:
- + 8: **** NOTE ****
- + 9:
- + 10: The main difference between Shareware Log and a registered Log is a
- + 11: few extra Log options such as "Ignore Strings". The VIEW utility will
- + 12: display this Log in an enhanced mode. Please *** NOTE *** this file
- + 13: "reg_log.scc" is just a sample of how a registered type Log looks like..
- + 14: other than that, all the below principles remain the same.
- + 15:
- + 16: Invest only 15 minutes of your time, and discover the "Advantage" of
- + 17: SCC's small CASE utility and its ease of use. This example log file
- + 18: will review a typical SCC generated change LOG.
- + 19:
- + 20: Some of the "LOG" options set (see above log header) for this SCC
- + 21: example VIEW utility are set as:
- + 22:
- + 23: Log Detail = Yes
- + 24: Strip End White = No strip ending white space from Old/New
- + 25: Ignore Case = Yes
- + 26: Ignore White = Yes
- + 27: Ignore Numbers = Yes
- + 28: Ignore Strings = Yes
- + 29:
- + 30: String 1 = "Funny" strings to ignore for this SCC log example.
- + 31: String 2 = "Old"
- + 32: String 3 = "New"
- + 33: String 4 = "SCC"
- + 34: String 5 = "CSS"
- + 35:
- + 36: If you have a color monitor (for the enhanced view), please note:
- + 37:
- + 38: 1) Main "text" screen attributes (forground/background):
- + 39:
- + 40: o CONTROL = High White & Blue Background.
- + 41: o Old Document = Light White & Blue Background.
- + 42: o New Document = Yellow & Blue Background.
- + 43:
- + 44: 2) Cursor line attributes:
- + 45:
- + 46: o Cursor = Black & Cyan Background.
- + 47:
- + 48: 3) Left cursor status window attributes:
- + 49:
- + 50: o CONTROL = Black & Cyan Background.
- + 51: o Common Lines = High White & Black Background.
- + 52: o Old Document = High White & Black Background.
- + 53: o New Document = Yellow & Black Background.
- + 54:
- + 55: 4) Lower left status window attributes:
- + 56: When any of the above options are set (= Yes) and the SCC log
- + 57: line cursor position matches a set option or any other condition,
- + 58: the VIEW status line will indicate same.
- + 59:
- + 60: " Ignore Strings " a selected ignore "string" was found.
- + 61: " Ignore White Sp " white space was ignored between lines.
- + 62: " Ignore Numbers " numbers was ignored between lines.
- + 63: " Ignore Case " upper/lower case was considered equal.
- + 64: " Multi Match " two or more options were necessary to match.
- + 65: " Moved Line " exact matching lines between documents.
- + 66: " Common Lines " common lines (with line #) between documents.
- + 67: " Deleted Line " old line (deleted) from the document.
- + 68: " Inserted Line " new line (inserted) into the document.
- + 69: " Close Match " test lines are similar (best guess).
- + 70:
- + 71: 5) Lower left cursor compare lines window attributes:
- + 72:
- + 73: o Cursor = Black & Cyan Background.
- + 74:
- + 75: 6) Lower left compare lines window character annotations:
- + 76:
- + 77: o Common Lines = High White & Black Background.
- + 78: o Common Lines = Yellow & Black Background.
- + 79:
- + 80:
- + 81: NOTE, if a pair of line numbers appear in the status window, you may
- + 82: then flip between the old and new documents by pressing either
- + 83: 'X' or 'Z' characters.
- + 84:
- + 85:
- + 86: For the help menu, press the F1 key.
- + 87:
- + 88: Note... there are two cursor "tracking" status windows on
- + 89: the left side of the screen. The status window within the cursor
- + 90: position will show special symbol that reflects SCC Log control
- + 91: operations, such characters as '-', '+', or blank ' '. The
- + 92: status on the lower left of the screen will show what type of
- + 93: operation SCC "change" control took place.
- + 94: If the cursor status equals a blank character ' ' the cursor
- + 95: either will be located either on a SCC Log control line or within
- + 96: the document text.
- + 97: The following examples will follow only the cursor position
- + 98: within the SCC Log document text.
- + 99:
- + 100:
- + 101: When the cursor is on a Log line (the left control side) that
- + 102: has either '-', or '+', then one of the following line operations
- + 103: will apply.
- + 104:
- + 105:
- + 106: Log status Operation Flip (press either 'X' or 'Z')
- + 107: ---------- --------- ----
- + 108: '-' " Deleted Line " No
- + 109: '+' " Inserted Line " No
- + 110: '-' or '+' " Close Match " Yes
- + 111:
- + 112:
- + 113: When the cursor is on a Log line (the left control side) that
- + 114: equals a blank character ' 'one of the following line operations
- + 115: will then apply.
- + 116:
- + 117:
- + 118: Log status Operation Flip (press either 'X' or 'Z')
- + 119: ---------- --------- ----
- + 120: ' ' " Common Lines " No Old line # shown
- + 121: ' ' " Moved Line " Yes
- + 122: ' ' " Ignore Strings " Yes
- + 123: ' ' " Ignore White Sp " Yes
- + 124: ' ' " Ignore Numbers " Yes
- + 125: ' ' " Ignore Case " Yes
- + 126: ' ' " Multi Match " Yes
- + 127:
- 128: The above two SCC Log status windows (along with different SCC
- 129: Log option settings) can help generate a "filtered" SCC change
- 130: control report Log to what is important (delete or insert status)
- 131: and not important (blank status) in your file.
- 132: For example you may not want the '-' or '+' (delete or insert)
- 133: Log status characters for such lines containing differences of
- 134: only "White Space", "Upper/Lower Case" etc.
- 135:
- 136:
- 137:
- 138:
- 139:
- 140: START OF EXAMPLES.....
- 141:
- 142:
- #
- #Change 2
- #
- #16,22 ... 7 (Old) lines deleted from sample.v1
- #143,146 ... 4 (New) lines inserted into sample.v2
- #
- - The following changes without SCC could be extrenely difficult (and
- - costly) to find. Try fliping between versions('X' key) to help
- - amplify how a small change could have been ezsley overlooked.
- - Ww%(123)*(4)[index]A.x,b.7(.Bc)Cd.()*,+|DeEf|FgGh\@$,#&|!\+(0)
- - " Deleted Lines "
- - Will show what line and line # that was deleted from the old
- - document.
- + 143: The following changes without SCC could be extremely difficult (and
- + 144: costly) to find. Try flipping between versions('Z' key) to help
- + 145: amplify how a small change could have been easily overlooked.
- + 146: Ww%(123)*(4)[index]A.x,b.7(.Bc)Cd.()*,+|DeEf|FgGh\@$.#&|!\+(0)
- 147: " Common Lines "
- 148: Common Line numbers between the Old and New documents. Cursor
- 149: status will show the corresponding Old line #.
- 150:
- 151:
- 152:
- 153:
- 154:
- #
- #Change 3
- #
- #31,59 ... 29 (Old) lines deleted from sample.v1
- #155,184 ... 30 (New) lines inserted into sample.v2
- #
- " Moved Lines "
- These are exact matching lines between documents but may have
- different line numbers. NOTE... whenever the "lower" status window
- has two line numbers, you can Flip between documents by pressing
- either 'X' or 'Z' keys.
- " Ignore Funny Strings "
- All the text match except for selected "strings" between the New
- and Old documents.
- " Ignore W h i t e Sp "
- All the text match e xcept for white space between documents.
- " IGNORE CASE "
- All The Text Match Except For UPPER/lower Case between documents.
- " MULTI Funny MATCH "
- All the TEXT match by using Two or more options between the New
- and Old documents. For example if the option "IGNORE CASE" and
- "IGNORE string" allowed the Funny lines match t h e n this status.
- - " Removed Lines "
- - The status window will show the old line # that was deleted.
- - " Close Matchs"
- - Will show what lines and line # that closley matches between
- - the old & new documents
- " Ignore Numbers "
- 65 4321 All the text match except for numbers between documents.
- Strip End White
- If "Strip End White" was selected the following lines will be
- exactly alike (same length) and would show as "Common Lines".
- If "Strip End White" was ** NOT ** selected then the lines
- will be of different lengths.
- Watch the cursor by flipping ('Z' or 'X' key) between documents.
- 155: " Ignore Strings "
- 156: All the text match except for selected "strings" between the Old
- 157: and New documents.
- + 158: " Inserted Lines "
- + 159: Will show what line and line # that was inserted into the new
- + 160: document.
- 161: " Ignore White Sp "
- 162: All the text match except for white space between documents.
- 163: " Ignore 1234 Numbers "
- 164: 4321 All the text match except for numbers 5678 between documents.
- 165: " Ignore Case "
- 166: All the text match except for upper/lower case between documents.
- 167: " Multi Match "
- 168: All the TEXT match by using two or more options between the Old
- 169: and New documents. For example if the option "Ignore Case" and
- 170: "Ignore string" allowed the lines match then this status.
- 171: " Moved Lines "
- 172: These are exact matching lines between documents but may have
- 173: different line numbers. NOTE... whenever the "lower" status window
- 174: has two line numbers, you can Flip between documents by pressing
- 175: either 'X' or 'Z' keys.
- + 176: " Close Match "
- + 177: Will show what lines and line #'s that closely matches between
- + 178: the Old/New documents.
- 179: Strip End White
- 180: If "Strip End White" was selected the following lines will be
- 181: exactly alike (same length) and would show as "Common Lines".
- 182: If "Strip End White" was ** NOT ** selected then the lines
- 183: will be of different lengths.
- 184: Watch the cursor by flipping ('Z' or 'X' key) between documents.
- 185:
- 186: ** Note ** SCC can also track and VIEW any (ASCII TEXT)
- 187: formatted document such as the following.
- 188:
- 189:
- 190:
- 191:
- 192: Page 1 Overview.scc
- 193:
- 194: Software Change Control (SCC)
- 195:
- #
- #Change 4
- #
- #71,74 ... 4 (Old) lines deleted from sample.v1
- #196,199 ... 4 (New) lines inserted into sample.v2
- #
- - Softtime Systems
- P.O. Box 2447
- - Lk Ronknnkoma LI. NY 11779
- - 516 981-8386
- + 196: Softime Systems
- 197: P.O. Box 2447
- + 198: Lake Ronkonkoma LI. NY 11779
- + 199: (516) 981-8386
- 200:
- 201: Copyright (c) 1990-91 by Walter Erickson
- 202: All Rights Reserved.
- 203:
- 204:
- 205: "A small CASE for a big problem"
- #
- #Change 5
- #
- #81,87 ... 7 (Old) lines deleted from sample.v1
- #206,217 ... 12 (New) lines inserted into sample.v2
- #
- Page 1
- OVERVIEW
- - Questions "about" SCC
- - What is SCC .
-
- - Software Change Control SCC, as the name implies, is one of the most
- - powerful an cost-effective tool in this energing field of CASE.
- + 206: Mary J Erickson
- 207:
- + 208:
- + 209:
- 210: Page 2
- 211: Overview
- + 212: Common questions about SCC
- + 213:
- + 214: What is SCC ?
- + 215: -------------
- + 216: Software Change Control (SCC), as the name implies, is one of the most
- + 217: powerful and cost-effective tool available in this emerging field of CASE.
- 218: SCC features friendly menu-driven interfaces (with automatic context help)
- 219: suitable for use by non-technical administrative, as well as for the
- 220: sophisticated user.
- 221:
- 222: SCC closely tracks (logs) all software/text changes between two similar
- 223: source files, thereby giving a complete (version to version) audit trail.
- 224:
- 225: A SCC generated Log greatly simplifies any user request for the
- 226: (identification) of what, when and why changes were made.
- 227:
- #
- #Change 6
- #
- #98,101 ... 4 (Old) lines deleted from sample.v1
- #228,231 ... 4 (New) lines inserted into sample.v2
- #
- What does CSS do ?
- ------------------
- - When SCC is run the tracking (output) log file will then reflect
- - (context) what changes have occurred between the two source files,
- 228: What does SCC do ?
- 229: ------------------
- + 230: When SCC is run the tracking (output) log file will then reflect (in
- + 231: context) what changes have occurred between the two (input) source files,
- 232: thus allowing the programmer and/or management to have a clear visual SCC
- 233: log of all software and/or text changes.
- 234:
- 235: This feature enables the user to control all enhancements and
- 236: documentation of source data at this critical level.
- 237:
- 238: Why is SCC needed ?
- 239: -------------------
- 240: All software source files will need changes. In fact, it is a truism that
- 241: every software project released, including those released quite recently,
- 242: need changes. The most important consideration at this stage is to regulate
- 243: and control the documentation and its changes.
- 244:
- 245: SCC is a decomposition process that offers a complete and precise
- 246: description of what (line-by-line) changes have occurred between two source
- 247: files. This results in faster development time, along with software that is
- 248: far less likely to fail in use.
- 249:
- 250: Page 3
- 251: Can managers use SCC ?
- 252: ----------------------
- #
- #Change 7
- #
- #123,131 ... 9 (Old) lines deleted from sample.v1
- #253,261 ... 9 (New) lines inserted into sample.v2
- #
- Using SCC creates an environment that is very time and cost effective.
- SCC allows changes to be made in a more maintainable, reliable and
- controllable way; that is, software control is fully documented, along with
- a full audit trail of what changes have occurred between software versions.
-
- The management of software changes at the programming (source) level
- (generally accepted as the most expensive and weakest link in software
- management) is one of the most difficult problems managers and programmers
- alike have.
- 253: The management of software changes at the programming (source) level
- 254: (generally accepted as the most expensive and weakest link in software
- 255: management) is one of the most difficult problems managers and programmers
- 256: alike have.
- 257:
- 258: Using SCC creates an environment that is very time and cost effective.
- 259: SCC allows changes to be made in a more maintainable, reliable and
- 260: controllable way; that is, software control is fully documented, along with
- 261: a full audit trail of what changes have occurred between software versions.
- 262:
- 263: SCC greatly improves the suitability and appropriateness of software
- 264: change documents; enhances clarity, readability, reliability and complete
- 265: recoverability; allowing software changes to be a great deal easier to
- 266: track and maintain.
- 267:
- #
- #Change 8
- #
- #138,143 ... 6 (Old) lines deleted from sample.v1
- #268,273 ... 6 (New) lines inserted into sample.v2
- #
- - Does SCC require a speceal editor ?
- -----------------------------------
- - No, all that's required is that the input source files to CSS be in
- (Ascii TEXT) format.
-
- Does CSS Require a Data Base ?
- + 268: Does SCC require a special editor ?
- 269: -----------------------------------
- + 270: No, all that is required is that the input source files to SCC be in
- 271: (ASCII TEXT) format.
- 272:
- 273: Does SCC require a data base ?
- 274: ------------------------------
- 275: No, SCC can either be integrated into a data base or stand alone, for
- 276: most small projects a data base is not necessary, thus eliminating
- 277: complexity and cost (KISS). All header file-id, code and documentation
- 278: changes "between versions" are kept within the SCC Log itself.
- 279:
- 280: Can I run SCC against existing versions ?
- 281: -----------------------------------------
- 282: Yes, you can build new and complete SCC change logs from older existing
- 283: (version to version) files, this will give a entire audit trail of any
- 284: software changes between versions.
- 285:
- 286: What can SCC be used for ?
- 287: --------------------------
- 288: o Documenting
- #
- #Change 9
- #
- #159,161 ... 3 (Old) lines deleted from sample.v1
- #289,291 ... 3 (New) lines inserted into sample.v2
- #
- - o Software control
- o Software Debugging
- - o version pre release (development) change control
- + 289: o Software/text control
- 290: o Software Debugging
- + 291: o version pre-release (development) change control
- 292: o Code walkthrough's
- 293: o etc.
- 294:
- 295: Using SCC for Documenting
- 296: -------------------------
- 297: When SCC is run, the tracking (output) log file will then reflect (in
- 298: context) what changes that have occurred between the two (input) source
- 299: files, thus allowing the programmer and/or management to control, enhance
- 300: and document software at this critical source level.
- 301:
- 302: SCC generates a software change (log) that closely tracks and records all
- 303: changes consisting of a header, control change numbers and special symbols
- 304: to reflect the operations of delete '-', insert '+', move ' ' etc.
- 305:
- #
- #Change 10
- #
- #176,179 ... 4 (Old) lines deleted from sample.v1
- #306,309 ... 4 (New) lines inserted into sample.v2
- #
- Page 3
- Using SCC for Software control
- ------------------------------
- The Manager/Programmer can visually see on one listing (the CHANGE Log)
- 306: Page 4
- 307: Using SCC for Software control
- 308: ------------------------------
- 309: The manager/programmer can visually see on one listing (the change log)
- 310: all changes and special tracking symbols that were necessary to build the
- 311: later version from the earlier version, thus keeping an accurate control
- 312: over all changes.
- 313:
- 314: SCC will also reveal all unintentional and possible unauthorized changes
- 315: to source files, thus preventing future problems in the next released
- 316: version.
- 317:
- 318: SCC helps the programmer and manager to make changes, "edit out" any
- 319: tactical coding/design errors between two source files. This can be done by
- 320: using a similar method such as the following:
- 321:
- 322: Initial Technical Design Review
- 323: o revision of raw draft coding design
- 324: o clarification of ambiguous design content
- 325: o identification of coding gaps and inconsistencies
- 326: o discovery of major/minor coding errors
- 327:
- #
- #Change 11
- #
- #198,204 ... 7 (Old) lines deleted from sample.v1
- #328,335 ... 8 (New) lines inserted into sample.v2
- #
- - Coding Review
- - o verification of content NOT already tested or debugged
- o incorporation of late technical coding changes
- - o writing specs for changed docunentation
-
- Final Technical Design Review
- - o refining the source code for usability
- + 328: Quick Coding Review
- + 329: o verification of technical content NOT already tested or
- + 330: debugged
- 331: o incorporation of late technical coding changes
- + 332: o writing specs for changed documentation
- 333:
- 334: Final Technical Design Review
- + 335: o refining the source code/documentation for usability
- 336: o minor "edit" cleanup
- 337: o careful configuration control and test proofing
- 338:
- 339: Field Maintenance of Released Software
- 340: o discovery of unintentional coding errors
- 341: o discovery of undocumented features
- 342: o uncovering code that once worked, but now does not
- 343: o SCC Log header information for release identification and control
- 344:
- 345: Page 5
- 346: SCC summary
- 347: -----------
- #
- #Change 12
- #
- #216 ... (Old) line place-holder for sample.v1
- #348,351 ... 4 (New) lines inserted into sample.v2
- #
- + 348: SCC is a comprehensive utility designed to compare two files and generate
- + 349: various reports (log files) that display any or all change differences as
- + 350: they evolve.
- + 351:
- 352: SCC log records who, why, when and where changes were made, thus
- 353: maintaining a complete history of all changes.
- 354:
- 355: SCC enables detailed verification of auditing accuracy, eliminates
- 356: undetected programming errors and drastically reduces manual desk checking
- 357: time.
- 358:
- 359: The manager/programmer knows exactly what the changes are between
- 360: versions.
- 361:
- 362: SCC accepts (ASCII TEXT) output from your favored editor.
- 363:
- 364: You can build new and complete SCC change logs from older existing
- 365: (version to version) files.
- 366:
- 367: You can track any coding progress on software changes by viewing an SCC
- 368: log against the previous and/or developing files.
- 369:
- 370: You can backtrack to any previous version to examine what changes created
- 371: that release at that time.
- 372:
- 373:
- 374: SCC change log report (version to version) can greatly help in debugging
- 375: changes between versions (one works the other does not).
- 376:
- 377: The key benefits of SCC are:
- 378: o lower project costs
- 379: o controlled release management
- 380: o structured walkthroughs
- 381: o faster software coding thruput
- 382: o higher software quality
- 383:
- 384:
- 385: ONLY SCC_II "registered"
- 386: ------------------------
- 387: You can use the SCC Log to re-create any version (forward or backward),
- 388: the SCC header ensures integrity, synchronization and recoverability of the
- 389: reconstructed source.
- 390:
- 391: By using the SCC "short Log" option, you can better utilize disk storage
- 392: on your computer.
- 393:
- 394:
- 395: If you would like further information about this or the SCC registered
- 396: programs, please call Walter Erickson at (516) 981-8386
- 397:
-