DOCERR: Corrections for Errors in SourceSafe 3.1 Documentation

• Microsoft Visual SourceSafe, 16-bit and 32-bit, for Windows, version 4.0
• Microsoft SourceSafe for Windows, version 3.1
• Microsoft SourceSafe for Windows NT, version 3.1
• Microsoft SourceSafe for MS-DOS, version 3.1

SUMMARY

This article is a master list of corrections for documentation errors in the Microsoft SourceSafe version 3.1 manuals. Included are corrections to the following manuals and files that ship with SourceSafe:

• README.TXT file
• Online Windows Help file SSW.HLP
• "Microsoft SourceSafe User Guide"
• "Microsoft SourceSafe Reference"

MORE INFORMATION

Corrections to the README.TXT file

SourceSafe 3.1 Network installation instructions

   SourceSafe stores it's contents in a database like area. All
   SourceSafe information shared by users will be in one location,
   specifically the DATA directory. When installing for multiple
   users, you would want to install SourceSafe in a location everyone
   has access to. Typically this location is a network server.

SourceSafe 3.1 Client installation instructions

   Often users desire to have executables and other personal files on
   the local machine for speed purposes. This can be done with the
   following steps:

    - Copy executables and Dynamic Link Libraries (DLLs) to the local
      directory.

    - Set the environment variable SSDIR to point to the network
      installation of SourceSafe. For example: SET SSDIR=G:\SS

   Some additional optional steps are:

    - Make a copy of the SS\TEMP directory on the local machine. Set
      the variable Temp_Path in the SS.INI. For example:

         Temp_Path = c:\ss\temp

    - Make a copy of the SS\USERS\<user name> subdirectory on the local
      machine. Set the variable for the desired user in the USERS.TXT
      file to point to the new location. For example:

         JOHN = c:\ss\users\john\ss.ini.

    For additional information on how to set up a local machine copy,
    please see the following articles in the Microsoft Knowledge Base:

       ARTICLE-ID: Q130141
       TITLE     :How to Install SourceSafe on a Windows Client Workstation

       ARTICLE-ID: Q130142
       TITLE : How to Install SourceSafe on a Windows NT Client Workstation

       ARTICLE-ID: Q129112
       TITLE     : How to Install SourceSafe on a Windows 95 Workstation

Disabling Keyword Expansion

   Help says in "Keyword Expansion - The Format" that there is a
   special keyword $Nokeywords:$ that disables expansion for all
   keywords below it in the file that it is in. The format for the
   keyword is incorrect. It should be:

      $NoKeywords: $

   For additional information, please see the following article in
   the Microsoft Knowledge Base:

      ARTICLE-ID: Q131092
      TITLE     : PRB: Keyword Expansion Is Case Sensitive

Creating a Shadow Directory

   Help says in "Creating a Shadow Directory", under step 2, "This
   simply means that you go to the directory, delete any files that are
   in it, and then Get all the files from the project."

   There is a knowledge base article which gives more information on
   how to do this step. For additional information, please see the
   following article(s) in the Microsoft Knowledge Base:

      ARTICLE-ID: Q131023
      TITLE     : DOCERR: How to Set Up a Shadow Directory

The Configuration Variables

   There are some additional SourceSafe INI Settings which are not
   listed in the "The Configuration Variables" help topic.

   For additional information, please see the following article(s) in
   the Microsoft Knowledge Base:

      ARTICLE-ID: Q127189
      TITLE     : DOCERR: Additional SourceSafe INI Settings

(Page 32)    Method 3: Command Line Parameters

   The command line examples are incorrect. They should be:

      SSW.EXE -yMARY

      or:

      SSW.EXE -yMARY,BIRTHMARK

(Page 67)    SourceSafe Keywords

   The last item in SourceSafe Keywords Table is:

      $Nokeywords: $     Disables expansion for all keywords below it
                         in the file.

   The format for the keyword is incorrect. It should be:

      $NoKeywords: $

   For additional information, please see the following article in
   the Microsoft Knowledge Base:

      ARTICLE-ID: Q131092
      TITLE     : PRB: Keyword Expansion Is Case Sensitive

(Page 67)    Columnar Formatting and Binary Files

   The second sentence of the second paragraph is incorrect. It
   currently says:

      This tells SourceSafe that the dollar sign after the keyword is
      exactly where you want it.

   It should be changed to say:

      This tells SourceSafe that the dollar sign after the keyword is
      exactly where you want the column to end.

(Page 74)    Creating a Shadow Directory

   Step 2 says "This simply means that you go to the directory, delete
   any files that are in it, and then Get all the files from the
   project."

   There is a knowledge base article which gives more information on
   how to do this step. For additional information, please see the
   following article in the Microsoft Knowledge Base:

      ARTICLE-ID: Q131023
      TITLE     : DOCERR: How to Set Up a Shadow Directory

(Page 96)    APPENDIX B - Command Syntax

   The table which lists command options is incomplete.  For additional
   information, please see the following article(s) in the Microsoft
   Knowledge Base:

      ARTICLE-ID: Q127188
      TITLE     : DOCERR: SourceSafe Undocumented Command Line Switches

   The last sentence of the first paragraph is incorrect.  It currently
   says:

      (The Delta project name must be specified with the -d option.)

   It should be changed to say:

      (The Delta project directory must be specified with the -d
      option.)

Additional SourceSafe INI Settings

    There are some additional SourceSafe INI Settings which are not
    described in chapter 2 of the Microsoft SourceSafe Reference.

    For additional information, please see the following article(s) in
    the Microsoft Knowledge Base:

       ARTICLE-ID: Q127189
       TITLE     : DOCERR: Additional SourceSafe INI Settings

    The table which lists command line options is incomplete.  For
    additional information, please see the following article(s) in the
    Microsoft Knowledge Base:

       ARTICLE-ID: Q127188
       TITLE     : DOCERR: SourceSafe Undocumented Command Line Switches