----------------------------------- Telelogic SDL/PVCS Integration Copyright by Telelogic AB 2000 PVCS is a product of INTERSOLV. ----------------------------------- Please set word wrap on in your text viewer. We strongly recommend reviewing this entire document for information not available in the user manuals. Table of Contents ================= 1 Introduction 2 Installation 2.1 Installing the PVCS Dynamic Menu 2.2 Making the script files accessible to the PVCS Dynamic Menu 2.3 PVCS Configuration Files 2.3.1 Creating a PVCS Configuration File 2.3.2 Create PVCS Configuration Files for a directory hierarchy 3 PVCS Dynamic Menu Commands 4 Tutorial 4.1 Setup Directories and Working Files 4.2 Make a vcs.cfg file 4.3 Recursive Check In 4.4 Recursive Check Out 4.5 Single file Check In and Check Out 1 Introduction ============== This README file explains how to install and use this PVCS integration for Telelogic Tau SDL suite. In this directory you will find the following files: README -- the file you are reading. pvcs.ini -- a dynamic menu to append to org-menus.ini sdtput.bat -- a script which calls PVCS's ci. sdtpvcsi.bat -- a script which makes sure binary files are initialized -- correctly. NOTE: under Win32 the script files have a .bat extension. 2 Installation ============== 2.1 Installing the PVCS Dynamic Menu ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Please add pvcs.ini to your org-menus.ini file. The SDL suite will search for the org-menus.ini first in the directory where the SDL suite was started, then in a directory pointed to by the HOME environment variable and finally in the directory in which the SDL suite was installed. If you do not already have a org-menus.ini file, the pvcs.ini can serve as one. Just copy pvcs.ini to either your HOME directory or to where you have the SDL suite installed and rename it to "org-menus.ini". For more information on dynamic menus, please see "Defining Menus in the SDL Suite" in chapter1, "User Interface and Basic Operations", of the User's Manual. 2.2 Making the script files accessible to the PVCS Dynamic Menu ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The two batch files - sdtput.bat and sdtpvcsi.bat - need to be accessible to the PVCS Dynamic Menu. We recommend that you change your PATH environment variable to point to the directory in which these files are located. Alternatively you may copy them to your "bin" directory, where all SDL suite executables are located. 2.3 PVCS Configuration Files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The PVCS Dynamic Menu is not directly aware of where your PVCS files should be stored. Each directory which contains your workfiles needs to have a configuration file which points to a directory which will serve as a repository for your PVCS archives. This configuration file is called "vcs.cfg". 2.3.1 Creating a PVCS Configuration File PVCS allows the user to specific PVCS configuration options for each workfile directory. Creating a configuration file ("vcs.cfg") in each workfile directory simplifies management of your PVCS archives since PVCS "knows" automatically where to look for archives. For example, if your repository is located in c:\proj\PVCSrep and your workfiles are located in c:\wrk then you would issue the following command: c:\wrk> echo VCSDir=c:\proj\pvcsrep > vcs.cfg This will create a file called "vcs.cfg" which instructs PVCS where to look for PVCS archives. 2.3.2 Create PVCS Configuration Files for a directory hierarchy If you have a directory hierarchy in which your workfiles are stored, it is recommended that you create a PVCS archive directory hierarchy which mirrors your workfile hierarchy. In each of your workfile directories you will need to create a PVCS Configuration File as shown above. 3 PVCS Dynamic Menu Commands ============================ 3.1 The following commands are available through the Dynamic Menu: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 3.1.1 Refresh Refreshes the Organizer Window. This updates the file permissions shown in the Organizer Window to match the current status of the files. No PVCS command is involved in this command. 3.1.2 Recursive Check In Checks in a tree (or subtree) of object files, starting at the selected object. If the SDL System file icon is the selected object then all files in the Organizer Window are checked in. SCU files are included in the check in. The user is prompted for a check in comment. 3.1.3 Check In Object Checks in the selected object file. The user is prompted for a check in comment. 3.1.4 Check In SCU Checks in the SCU file containing the selected object. The user is prompted for a check in comment. 3.1.5 Check In Link file Checks in the link file. The user is prompted for a check in comment. 3.1.6 Recursive Check Out Checks out (unlocked) a tree (or subtree) of object files, starting at the selected object. If the SDL System file icon is the selected object then all files in the Organizer Window are checked out. SCU files are included in the check out. 3.1.7 Check Out Object Checks out (unlocked) the most recent checked in version of the selected object. 3.1.8 Check Out SCU Checks out (unlocked) the most recent checked in version of the SCU file containing the selected object. 3.1.9 Check Out Object and SCU Checks out (unlocked) the most recent checked in version of the selected object and its containing SCU file. 3.1.10 Check Out Link file Checks out (unlocked) the most recent checked in version of the link file. 3.1.11 Recursive Check Out and Lock Checks out and locks a tree (or subtree) of object files, starting at the selected object. If the SDL System file icon is the selected object then all files in the Organizer Window are checked out and locked. SCU files are included in the check out. 3.1.12 Check Out and Lock Object Checks out and locks the selected object. 3.1.13 Check Out and Lock SCU Checks out and locks the SCU file containing the selected object. 3.1.14 Check Out and Lock Object and SCU Checks out and locks both the selected object and its containing SCU file. 3.1.15 Check Out and Lock Link file Checks out and locks the link file for the current SDL System. 3.1.16 Unlock Object Unlocks the selected object file. This will leave the file with the permissions "rw". If a subsequent "Check Out and Lock Object" is attempted an error message will be issued in the Organizer Log Window. The operation is then aborted. This is because PVCS expects files with "rw" to be files that are currently being edited, and therefore should not be overwritten by default. If you wish to overwrite the file, change the permissions first to "r" and re-run the "Check Out and Lock Object" command. If you do not wish to overwrite the file, but instead would like the file to be checked in as the new version, make a copy of the file, change the file permissions to "r", run the "Check Out and Lock Object" command, and then overwrite the newly checked out file with the copy. Change the permissions to "rw". At this point you may either check the file in or continue working on it. 3.1.17 Unlock SCU Unlocks the selected SCU file. Please see "Unlock Object" above for more information. 3.1.18 Unlock Link file Unlocks the selected Link file. Please see "Unlock Object" above for more information. 3.1.19 Initialize Diagram file Initializes a diagram file by creating a PVCS file for the selected object. The PVCS file is initialized for binary files. 3.1.20 Show Revision History Shows the revision history for the selected object in the Organizer Log Window. 4 Tutorial ========== This tutorial will show you how to initialize a PVCS archive repository and how to check in and out files to and from this repository. This tutorial assumes that the user has completed the installation steps detailed above. 4.1 Setup Directories and Tutorial Files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Make a scratch directory for use in this tutorial, for example: c:\tutorial Copy demongame tutorial files from Tau installation: c:\TelelogicTau40\sdt\examples\demongame (Unix: $telelogic/sdt/examples/demongame) to: c:\tutorial You do not need to copy the "omelink" and "sdl92" subdirectories. Change the permissions for all the files from read-only to readable and writeable. Make a repository directory for your PVCS archives, for example: c:\pvcsrep 4.2 Create a vcs.cfg file ~~~~~~~~~~~~~~~~~~~~~~~~~ In c:\tutorial create a file called "vcs.cfg" which contains one line pointing to your repository directory. For example: c:\tutorial> echo VCSDir=c:\rcsrep > vcs.cfg 4.3 Recursive Check In ~~~~~~~~~~~~~~~~~~~~~~ Once you have created all the directories, copied the tutorial files and created a "vcs.cfg" file, your PVCS archive repository is ready for checking in files. To check in the demongame tutorial, first create a SCU file for the demongame system. Do as follows: o open the demongame.sdt file located in c:\tutorial in the Organizer. o Do a right button mouse click on the "SDT" icon which appears in the upper-left hand corner of the Organizer window. o Select "CM Group" from the pop-up menu and click the radio button labeled "CM Group File". o Click on the "OK" button to except the default file name. A SCU file is now associated with the demongame system file and is named "demongame.sdt.scu". To begin checking in: o Select the "SDT" icon in the Organizer. o Choose the "Recursive Check In" option from the PVCS dynamic menu. Any error messages and/or progress messages are reported in the Organizer Log Window. If the recursive check in was successful all the file permission flags for the demongame files should be "r". The file permissions for the SCU file associated with the demongame system file should also be "r". 4.4 Recursive Check Out ~~~~~~~~~~~~~~~~~~~~~~~ Now that all the demongame files are checked in you may check them out for editing by: o Select the "SDT" icon in the Organizer. o Choose the "Recursive Check Out and Lock" option from the PVCS dynamic menu. If the recursive check out was successful all the file permission flags for the demongame files should be "rw". The file permissions for the SCU file should also be "rw". 4.5 Single file Check In and Check Out ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ For single file check in and check out simply select the file you would like to check in or out and choose the appropriate option from the PVCS dynamic menu. To check in or out a SCU file simply select any of the files which are controlled by the SCU file and choose "Check Out and Lock SCU file" from the PVCS dynamic menu.