Programmer 7500

home *** CD-ROM | disk | FTP | other *** search

/ Programmer 7500 / MAX_PROGRAMMERS.iso / CLIPPER / MISC / AVTS11.ZIP / AVTS.DOC next >

Wrap

Text File | 1993-01-24 | 46.2 KB | 1,573 lines

*********************************************** * * * ARIS Version Tracking System Version 1.1 * * * *********************************************** (c) 1993 Alexander Riedel Informations-Systeme Am Schmiedberg 16a, D-8019 Glonn GERMANY CIS-ID: 100042,1707 Phone : +49-8093-5245 Fax : +49-8093-4975 ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- Definition of Shareware. . . Shareware distribution gives users a chance to try software before buying it. If you try a shareware program and continue using it, you are expected to register. Individual programs differ on details -- some request registration while others require it, some specify a maximum trial period. With registration, you get anything from the simple right to continue using the software to an updated program with printed manual. Copyright laws apply to both shareware and commercial software, and the copyright holder retains all rights, with a few specific exceptions as stated below. Shareware authors are accomplished programmers, just like commercial authors, and the programs are of comparable quality. (In both cases, there are good programs and bad ones!) The main difference is in the method of distribution. The author specifically grants the right to copy and distribute the software, either to all and sundry or to a specific group. For example, some authors require written permission before a commercial disk vendor may copy their shareware. Shareware is a distribution method, not a type of software. You should find software that suits your needs and pocketbook, whether it's commercial or shareware. The shareware system makes fitting your needs easier, because you can try before you buy. And because the overhead is low, prices are low also. Shareware has the ultimate money-back guarantee -- if you don't use the product, you don't pay for it. ARIS Version Tracking System Disclaimer - Agreement. . . Users of ARIS Version Tracking System (AVTS) must accept this disclaimer of warranty: AVTS is supplied as-is. The author disclaims all warranties, expressed or implied, including, without limitation, the warranties of merchantability and of fitness for any purpose. The author assumes no liability for damages, direct or consequential, which may result from the use of AVTS. (c) 1993 Alexander Riedel Informations-Systeme, All rights reserved ------------------------------------------------------------------------------- - 2 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- I. Introduction 4 1. What is a Version Tracking System? 4 2. Installing ARIS Version Tracking System 5 II. Tutorial 6 1. Creating and editing a project 6 2. Configuration management 8 3. Module history and editing activity 9 III. Reference 10 1. CDC - Change Delta Comment 10 2. CREATE - Creates projects and apply files to them. 11 3. DELTA - Creates a new version (delta) of a file in an AVTS project. 12 4. DIFF - Compares two files and creates a difference listing 13 5. GET - Copies a project file and locks it 14 6. HISTORY - Prints the revision history of a file in an AVTS project 15 7. LOGVIEW - View the contents of a project's log file 16 8. READ - Copies a project file without locking 17 9. RMALIAS - Removes an alias name from a specific version of a module 18 10. RMAVTS - Deletes a file from an AVTS project 19 11. SACT - Reports current editing activity in an AVTS project 20 12. SETALIAS - Sets the alias name for one or more modules 21 13. UNGET - Reverses a GET command without creating a new version 22 IV. APPENDIX A - ERROR MESSAGES 23 ------------------------------------------------------------------------------- - 3 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- I. Introduction 1. What is a Version Tracking System? A Version Tracking System is a valuable tool for managing software projects in network environments. It prevents conflicts between team members that could otherwise work on the same module and keeps track of all changes that have been applied to a module of the software project. It also helps you maintain your current configuration by preventing you from accidentally linking wrong modules and therefore increases the quality of your software if you are a single programmer or if you work in a team without network. This is done by controlling access to the source files in such a way that only one user at a time has control over the current version of a module. All other users are still able to read the current or earlier versions of a module for reference or for building test applications. Another advantage of a Version Tracking System is the ability to trace back the development path. You may retrieve information about who applied what change and when and you may even retrieve earlier versions of your modules. This gives you the security and quality you deserve. No need to guess which files belong to a specific version of your software just ask for them, even if it is a long time ago and even if you are two, three or more version after the one you want to have rebuilt. The ARIS Version Tracking System (AVTS) manages all files that belong to a certain project by storing these files in an internal form in a subdirectory. This subdirectory is created under the directory where the executable files for AVTS are stored. You may create a project by explicit use of the command CREATE but it is automatically created if you apply the first file to a non-existent project (You will see a deeper discussion of the commands and their usage later). You will have to define all files that are involved with the project to AVTS. For you as a user there is no difference whether you handle source modules (ASCII text) or binary files (executables, object files, spreadsheets or text processor documents). Once you have done that you will always follow the development cycle outlined below: - Get a file from the AVTS - Work on it - Give it back to keep a record of the changes. That's it! While you work on a specific module no other user is allowed to get it for work. They may, however, get a copy of it for reference. Perhaps you will also need some more modules from the project to create a test version of your application. Then the development cycle looks like that: - Get the file to work on from AVTS - Read all other files you need from AVTS - Work on your module - Give the modified module back That is enough theory for the moment. You will see some examples that show how to work with AVTS later. ------------------------------------------------------------------------------- - 4 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 2. Installing ARIS Version Tracking System The installation of the ARIS Version Tracking System (AVTS) is very easy. Simply type the following command at your DOS prompt: A:SETUP and press the ENTER key. If you have the product disk in a drive other than A:, replace the A with the letter of the drive to be used. You will be prompted for a directory where SETUP should install AVTS after some screens providing additional information. The default installation drive and directory is C:\AVTS. You may, however, change this to your needs. After supplying the path specification, SETUP copies all necessary files to the installation drive and directory. After this process is completed you are prompted, whether you want SETUP to edit the PATH statement in your AUTOEXEC.BAT to include the installation path in your search path. You may omit this step: - if you have already chosen a directory in the search path - or if you want to make these changes on your own. Note that AVTS needs the installation directory included in the PATH variable to work properly. Once you are back to the DOS prompt, you might have to reboot your PC to activate the changes to your AUTOEXEC.BAT. To do this, hold down the keys Ctrl-Alt-Del and your system will reboot. Below you see a list of the files you should find in the installation directory with a brief description of what they are for. CDC.EXE Changes the comment of a delta. CREATE.EXE Creates projects and apply files to them. DELTA.EXE Creates a new version (delta) of a file in an AVTS project. DIFF.EXE Creates a listing of the differences between to versions of a file. GET.EXE Copies a project file and locks it. HISTORY.EXE Prints the revision history of a file in an AVTS project. LOGVIEW.EXE Online viewer for a project's logfile. READ.EXE Copies a project file without locking it. RMALIAS.EXE Removes an alias name from a specific version of a module. RMAVTS.EXE Removes a file from an AVTS project. SACT.EXE Reports current editing activity in an AVTS project. SETALIAS.EXE Sets the alias name for one or more modules. UNGET.EXE Reverses a GET command and discards the changes. Since AVTS creates an audit trail of all changes applied to a project, it needs to know your name. For that purpose you may either specify your user name with an option for every command or, more conveniently, set the environment variable USERNAME to your login name. If you are not working in a network we suggest to set this variable to your last name or whatever suits you. ------------------------------------------------------------------------------- - 5 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- II. Tutorial 1. Creating and editing a project For all of our following examples we will assume that our project has four source code modules written in the C language (MYAPP.C, MYMENU.C, MYFILE.C and MYPRINT.C), two header files (MYAPP.H and MYFILE.H), a makefile (MYAPP.MAK) and the documentation file (MYAPP.DOC). We will now assume, that we have written a first version of all these files and will now start to introduce these files to an AVTS project. This will be done by the following command sequence: set USERNAME=MYNAME create -pmyapp MYAPP.C create -pmyapp MYMENU.C create -pmyapp MYFILE.C create -pmyapp MYPRINT.C create -pmyapp MYAPP.H create -pmyapp MYFILE.H create -pmyapp MYAPP.MAK create -t1 -pmyapp MYAPP.DOC The last command has a parameter that makes it different from the previous command: -t1 This tells AVTS that this file has to be treated as binary file rather than as ASCII file. AVTS will not create differential listings on versions applied to this file. Each version of this file is stored as is. You might now want to have a look at the log file which is updated each time you make a change in a project. Assuming that you installed the AVTS in the default directory (C:\AVTS) you will find the log file under this name: C:\AVTS\MYAPP.RCS\RCS.LOG This log file is a plain ASCII text file and readable by every editor. You do not need to remember such long paths. Simply use the utility LOGVIEW for viewing a project's log file. For the above example the log file will now look like this: Sun Dec 13 21:56:35 1992 User MYNAME creates MYAPP.C, version 1.0 Sun Dec 13 21:56:36 1992 User MYNAME creates MYMENU.C, version 1.0 Sun Dec 13 21:56:37 1992 User MYNAME creates MYFILE.C, version 1.0 Sun Dec 13 21:56:38 1992 User MYNAME creates MYPRINT.C, version 1.0 Sun Dec 13 21:56:39 1992 User MYNAME creates MYAPP.H, version 1.0 Sun Dec 13 21:56:40 1992 User MYNAME creates MYFILE.H, version 1.0 Sun Dec 13 21:56:41 1992 User MYNAME creates MYAPP.MAK, version 1.0 Sun Dec 13 21:56:42 1992 User MYNAME creates MYAPP.DOC, version 1.0 Now you decide that you want to make some enhancements to the module MYFILE.C. To make things easier, you can now set the environment variable PROJECT to MYAPP by using the command SET PROJECT=MYAPP. This allows you to omit the project name on the command lines of AVTS commands. ------------------------------------------------------------------------------- - 6 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- Issue the following command to check MYFILE.C out: get MYFILE.C This command copies the actual version of MYFILE.C to your current directory and locks this module for other users. You may now edit this module to apply the changes you have in mind without worrying about others that might change it while you work on it. For reference you might need the file MYAPP.H also, but you do not want to have it locked, so that another user is able to change this module. To achieve that, issue the command: read MYAPP.H This also copies the actual version of this file to your current directory, but leaves the module unlocked. You may also use this command if this module is locked by another user. After you have made all required changes to MYFILE.C you have to tell AVTS that you have made some changes to that module. This is done by the command delta MYFILE.C After issuing this command you will be asked to enter a comment for your changes. You may type a character string of up to 126 characters long. What if you made up your mind and decided not to change anything in a module you had checked out using the 'get' command? You may simply remove the lock flag from the module by issuing the command unget MYFILE.C This removes the lock flag of module MYFILE.C and makes it available for other users. ------------------------------------------------------------------------------- - 7 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 2. Configuration management You have now learned the basic tasks for managing a project with AVTS. You can introduce new files to a project, get files for editing and read them for reference. You also know how to give them back to AVTS to keep track of versions. There is more to AVTS. It also allows you to keep track of your configuration. In a certain project state you will decide that the current state is your "Beta Version 1.0". You may now give the current versions of your modules an alias name, that allows you to retrieve all modules belonging to this project state easily even if you have done major changes to your modules. For this purpose you have to use the command "SETALIAS". An alias name can be up to 79 characters in length. For our sample project you would have to enter the following command: setalias "-aBeta Version 1.0" MYAPP all This marks the current versions of all modules in the project MYAPP with the alias name "Beta Version 1.0". If you have already tagged one or more modules with the same alias name you will get a warning and nothing will happen to them. If the current version of a module already has another alias name you will also get a warning message and that alias name will be overwritten with the new one you specified on the command line. If you want to remove an alias name from a specific version of a module you can use this command: rmalias -aaliasname module If you want to retrieve a configuration with a specific alias name simply issue the following command: read "-aBeta Version 1.0" MYAPP all This command reads all modules tagged with the alias name "Beta Version 1.0" and copies them to your current working directory. Please note that the quotation marks are necessary if your alias name contains blanks. This mechanism provides an easy method to mark and retrieve specific project states at every time. That way you can build up version 1.0 of an application that is currently at version 15.99 without thinking about what modules belong to it. ------------------------------------------------------------------------------- - 8 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 3. Module history and editing activity A major point of interest is which user has done which changes and when. Some information can be obtained by reading the project's log file. But if you need the specific history of a module and the comments a user entered for each delta you will have to use the command 'HISTORY'. The following command retrieves all information known of a certain module and prints it to the screen. You can easily re-direct the output of this command to a file or a printer. Have a look at the examples for the command 'HISTORY' in chapter III. REFERENCE. A simple example for this command is: history MYFILE.C This command prints out a editing history for the module MYFILE.C from its initial creation up to the current version. While reviewing the comments you made for specific versions of a module you may think that the comment you typed in when the delta command asked for it, doesn't really match what you wanted to say. Therefore we supplied an extra command that allows you to change the comment for a specific version of a module. Though, if you want to change the comment for i.e. version 2.9 of module MYAPP.C you may use the following command: cdc -v2.9 -pMYAPP MYFILE.C Note that if you omit the version parameter you will change the comment of the current version. The project name (-pMYAPP) may be omitted if you have set the environment variable PROJECT correctly. Another task, mainly performed by project administrators, will be to have a look at the current activity on a project. The command 'SACT' (System activity report) lists all modules in a project and their current state. If a file is currently checked out, it also notes who owns it and at what time he checked it out. Please refer to chapter III. for more information about this command. ------------------------------------------------------------------------------- - 9 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- III. Reference 1. CDC - Change Delta Comment Synopsis cdc [-uusername] [-vx.y] [-pprojectname] file [...] Description The command cdc allows changing of the comment given to a specific version of a file in an AVTS project. The optional parameters username and project name can be omitted if the corresponding environment variables USERNAME and PROJECT are set correctly. You may specify more than one file and each file specifier may contain wildcard characters. Options -uusername Specifies the name of the user. This option can be omitted if the environment variable USERNAME is set. However, specifying a user's name with the -u flag overrides the contents of the environment variable. -vx.y This flag specifies the version of the delta for which you want to change the comment. If omitted the actual version is used. -pproject Specifies the name of the project. This option can be omitted if the environment variable PROJECT is set. However, specifying a project's name with the -p flag overrides the contents of the environment variable. Examples 1. To change the delta comment of the current version of file MYAPP.C in the project MYAPP: cdc -pMYAPP MYAPP.C This shows you the current contents of the comment and prompts you for the new comment in the following form: ARIS Version Tracking System 1.1 (c) 1992,1993 All rights reserved File MYAPP.C, created Sun Dec 13 21:56:35 1992 Version 1.2, derived from version 1.1 Comment: Debugging in progress... New comment: 2. To change the comment of a specific version of MYAPP.C: cdc -v1.1 -pMYAPP MYAPP.C ------------------------------------------------------------------------------- - 10 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 2. CREATE - Creates projects and apply files to them. Synopsis create [-uusername] [-ttype] [-pprojectname] file [...] Description The command create allows creation of a new project and/or adding files to a project. If there is no file specified the project is created. However, if you add a file to a non-existant project, the project is created automatically. The parameters -uusername and projectname can be omitted if the environment variables USERNAME and PROJECT are set correctly. You may specify more than one file and each file specifier may contain wildcard characters. Options -uusername Specifies the name of the user. This option can be omitted if the environment variable USERNAME is set. However, specifying a user's name with the -u flag overrides the contents of the environment variable. -pproject Specifies the name of the project. This option can be omitted if the environment variable PROJECT is set. However, specifying a project's name with the -p flag overrides the contents of the environment variable. -ttype Specifies the type of a new file. Legal values are 0 (null) for ASCII files and 1 (one) for binary files. If this option is omitted the default value 0 (null) will be used. Examples: 1. To create a new project NEWPRO: create -pNEWPRO 2. To add the source file MYAPP.C to the project NEWPRO: create -pNEWPRO MYAPP.C 3. To add the binary file MYAPP.DBF to the project NEWPRO create -t1 -pNEWPRO -fMYAPP.DBF ------------------------------------------------------------------------------- - 11 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 3. DELTA - Creates a new version (delta) of a file in an AVTS project. Synopsis delta [-uusername] [-f] [-pprojectname] file [...] Description The delta command creates a new version of file. The file must have been checked out with the command get by the same user. Otherwise you will get an error message that either the file has not been checked out or has been checked out by another user. See appendix A for a list of error messages. You will be prompted for a comment on the changes. The maximum length of the comment string is 126 characters. You may specify more than one file and each file specifier may contain wildcard characters. Options -uusername Specifies the name of the user. This option can be omitted if the environment variable USERNAME is set. However, specifying a user's name with the -u flag overrides the contents of the environment variable. -pproject Specifies the name of the project. This option can be omitted if the environment variable PROJECT is set. However, specifying a project's name with the -p flag overrides the contents of the environment variable. -f This forces a new version of all specified files into an AVTS project even if those file have not been checked out. This flag does not allow to create a new version of a file that is currently checked out by another user. Example To create a new version of MYAPP.C in the project MYAPP: delta -pMYAPP MYAPP.C ------------------------------------------------------------------------------- - 12 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 4. DIFF - Compares two files and creates a difference listing Synopsis diff [-s] [-mnum] oldfile newfile Description The command diff is a program that is used by the delta command to create a difference listing when a new version of an ASCII file is applied to a project. You may however, also use this command to create difference listings for your own use. From the output of the diff command you can see what changes must be made in oldfile to get newfile. The output has the following form: n1,n2d delete lines n1 to n2 from file oldfile. n1,n2cm1,m2 Replace the lines n1 to n2 in file oldfile by the lines m1 to m2 from file newfile. n1am1,m2 Insert lines m1 to m2 from file newfile in file oldfile after line n1. Options -s Creates a script which can be used to convert oldfile to newfile. -mnum num specifies how many subsequent lines have to be equal to synchronise. ------------------------------------------------------------------------------- - 13 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 5. GET - Copies a project file and locks it Synopsis get [-uusername] [-pproject] file [...] Description The command get copies a file from a project to the current working directory and locks it in the project. Therefore another user cannot "get" this file until it is checked in by the command delta or the lock is removed by the command unget. Other users may obtain a copy of a locked module by using the command read. The optional parameters username and project name can be omitted if the corresponding environment variables USERNAME and PROJECT are set correctly. You may specify more than one file and each file specifier may contain wildcard characters. Options -uusername Specifies the name of the user. This option can be omitted if the environment variable USERNAME is set. However, specifying a user's name with the -u flag overrides the contents of the environment variable. -pproject Specifies the name of the project. This option can be omitted if the environment variable PROJECT is set. However, specifying a project's name with the -p flag overrides the contents of the environment variable. ------------------------------------------------------------------------------- - 14 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 6. HISTORY - Prints the revision history of a file in an AVTS project Synopsis history [-uusername] [-vx.y] [-pproject] file [...] Description The command history prints out all activities that occured on file from the initial creation to the current version or, if supplied, to the version specified with the -v parameter. The optional parameters username and project can be omitted if the corresponding environment variables USERNAME and PROJECT are set correctly. You may specify more than one file and each file specifier may contain wildcard characters. Options -uusername Specifies the name of the user. This option can be omitted if the environment variable USERNAME is set. However, specifying a user's name with the -u flag overrides the contents of the environment variable. -vx.y This flag specifies the version of the module where the printout of the history should stop. If omitted the actual version is used. -pproject Specifies the name of the project. This option can be omitted if the environment variable PROJECT is set. However, specifying a project's name with the -p flag overrides the contents of the environment variable. Examples 1. List the revision history of MYAPP.C in project MYAPP: history -pMYAPP MYAPP.C 2. View the revision history of MYAPP.C page by page: history -pMYAPP MYAPP.C | more 3. Print the history of MYAPP.C up to version 2.5 on a parallel printer: history -v2.5 .pMYAPP MYAPP.C >prn ------------------------------------------------------------------------------- - 15 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 7. LOGVIEW - View the contents of a project's logfile Synopsis logview project Description The utility logview allows you to easily browse through the log file of the specified project. The parameter project can be omitted if the environment variable PROJECT is set to the correct value. ------------------------------------------------------------------------------- - 16 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 8. READ - Copies a project file without locking Synopsis read [-uusername] [[-vx.y] | [-aalias]] [-pproject] file [...] Description The command read copies the specified file from project to the current working directory. The retrieved module is not locked and therefore still available for other users. If you specify 'all' instead of a file's name all files in the project are copied. If no version is specified with the -v flag, the current version is used. The optional parameters username and projectname can be omitted if the corresponding environment variables USERNAME and PROJECT are set correctly. You may specify more than one file and each file specifier may contain wildcard characters. Options -uusername Specifies the name of the user. This option can be omitted if the environment variable USERNAME is set. However, specifying a user's name with the -u flag overrides the contents of the environment variable. -vx.y This flag specifies the version of the module which should be retrieved. If omitted the actual version is used. This option is not allowed in combination with the -a flag. -aalias This copies the version that has the given alias name. If there is no such version you will get an error message. -pproject Specifies the name of the project. This option can be omitted if the environment variable PROJECT is set. However, specifying a project's name with the -p flag overrides the contents of the environment variable. Examples 1. Read the file MYFILE.C from project MYAPP: read -pMYAPP MYFILE.C 2. Read version 1.5 of MYFILE.C from project MYAPP: read -v1.5 -pMYAPP MYFILE.C 3. Read all file from project MYAPP that belong to "Beta Version 1.0": read "-aBeta Version 1.0" -pMYAPP all Please note that the quotation marks are necessary because the alias name contains space characters. ------------------------------------------------------------------------------- - 17 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 9. RMALIAS - Removes an alias name from a specific version of a module Synopsis rmalias [-uusername] -aalias [-pproject] file [...] Description The command rmalias removes an alias name from the module specified by file. If 'all' is specified instead of a filename, the alias name is removed from all modules in the specified project. The optional parameters username and project can be omitted if the corresponding environment variables USERNAME and PROJECT are set correctly. You may specify more than one file and each file specifier may contain wildcard characters. Options -uusername Specifies the name of the user. This option can be omitted if the environment variable USERNAME is set. However, specifying a user's name with the -u flag overrides the contents of the environment variable. -aalias This specifies the alias name that should be removed. If there is no such alias you will get an error message. -pproject Specifies the name of the project. This option can be omitted if the environment variable PROJECT is set. However, specifying a project's name with the -p flag overrides the contents of the environment variable. Examples 1. Remove the alias "BETA" from module MYFILE.C in project MYAPP: rmalias -aBETA -pMYAPP MYFILE.C 2. Remove the alias "BETA" from all files in project MYAPP: rmalias -aBETA -pMYAPP all ------------------------------------------------------------------------------- - 18 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 10. RMAVTS - Deletes a file from an AVTS project Synopsis rmavts [-uusername] [-pproject] file [...] Description The command rmavts deletes all specified files from the project either specified with the -p flag or the project specified by the environment variable PROJECT. The optional parameter username may be omitted if the environment variable USER is set correctly. Please note that rmavts does not allow deleting a file which is currently checked out. There may be one or more file specifiers on the command line, where each allows usage of wildcard characters. Options -uusername Specifies the name of the user. This option can be omitted if the environment variable USERNAME is set. However, specifying a user's name with the -u flag overrides the contents of the environment variable. -pproject Specifies the name of the project. This option can be omitted if the environment variable PROJECT is set. However, specifying a project's name with the -p flag overrides the contents of the environment variable. ------------------------------------------------------------------------------- - 19 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 11. SACT - Reports current editing activity in an AVTS project Synopsis sact [-uusername] [-l] project Description The command sact prints out for each file in project whether it is currently checked out and by whom or not. The optional parameter username can be omitted if the corresponding environment variable USERNAME is set correctly. Options -uusername Specifies the name of the user. This option can be omitted if the environment variable USERNAME is set. However, specifying a user's name with the -u flag overrides the contents of the environment variable. -l If specified, sact will only display those files, that are currently locked in the project. Unlocked files will not appear in the list. ------------------------------------------------------------------------------- - 20 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 12. SETALIAS - Sets the alias name for one or more modules Synopsis setalias [-uusername] [-vx.y] -aalias [-pproject] file [...] Description The command setalias sets an alias name for the specified file. If 'all' is given instead of a filename, all files in the specified project will get this alias name. If there is no version specified with the -v flag, the current version of file will be used. If you have already tagged another version of the specified module with the same alias name you will get a warning and nothing will happen. If the specified version of a module has already another alias name you will also get a warning message and the alias name will be over- written with the new one you specified with the -a flag. The optional parameters username and project can be omitted if the corresponding environment variables USERNAME and PROJECT are set correctly. You may specify more than one file and each file specifier may contain wildcard characters. Options -uusername Specifies the name of the user. This option can be omitted if the environment variable USERNAME is set. However, specifying a user's name with the -u flag overrides the contents of the environment variable. -vx.y Specifies the version of the module which should get an alias name. -aalias Specifies the alias name which should be used for the file. Maximum length is 78 characters. -pproject Specifies the name of the project. This option can be omitted if the environment variable PROJECT is set. However, specifying a project's name with the -p flag overrides the contents of the environment variable. Example Tag the current versions of all file in project MYAPP with the alias name "BETA": setalias -aBETA -pMYAPP all ------------------------------------------------------------------------------- - 21 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- 13. UNGET - Reverses a GET command without creating a new version Synopsis unget [-uusername] [-pproject] file [...] Description The command unget unlocks a file previously locked with the get command. Any changes on a file are ignored and the version counter is not increased. The optional parameters username and project can be omitted if the corresponding environment variables USERNAME and PROJECT are set correctly. You may specify more than one file and each file specifier may contain wildcard characters. Options -uusername Specifies the name of the user. This option can be omitted if the environment variable USERNAME is set. However, specifying a user's name with the -u flag overrides the contents of the environment variable. -pproject Specifies the name of the project. This option can be omitted if the environment variable PROJECT is set. However, specifying a project's name with the -p flag overrides the contents of the environment variable. ------------------------------------------------------------------------------- - 22 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- IV. APPENDIX A - ERROR MESSAGES Delta was created by another user, access denied You tried to change the delta comment of a version that was created by another user. Use the history command to obtain information about this module and contact the user who created this module. File filename already in project projectname You tried to introduce a file to a project that is already in that project with the create command. File name already in use You tried to do an action on a file that is currently checked out. For further information use the command sact which provides useage information for each file in a project. File name already in use by user username The specified file is currently checked out by another user. You cannot complete the desired action until this user checks the file in again. File name checked out by username, access denied You tried to modify the information of a file that is currently checked out by another user. File name is not checked out You tried to create a delta on a file that is not checked out. If you modified a file you obtained with the read command this error can be overcome by doing the following actions: - rename the file you want to check in (file.BAK). - Use the get command to lock the desired file on your user-id. - rename the file back to its original name. - use the delta command. Note that it is recommended to check the project log file first if to ensure that no other user made modifications to that file in the meantime. File name is not checked out, cannot unget You tried to use the unget command for a file that is not checked out. File name not in project You specified a file for an AVTS command that is not found in the project specified. Check the environment variable PROJECT and the spelling of the issued command. ------------------------------------------------------------------------------- - 23 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- Internal failure, not found name Please contact ARIS support immediately if this error occurs. Missing argument A required argument, such as file- or projectname have not been specified. Check the typing of the issued command. Missing file name You did not specify a filename where it was required. Missing project name You did not specify a project name where it was required. Project name already exists You tried to create a new project with the create command which already exists. Use another name. Projects is locked, access denied An AVTS command was not able to lock the project directory file after ten attempts. This may be caused by heavy use of the system. Repeat your command and contact your network administrator if it occurs again. Unable to create name An AVTS command was unable to create the file specified by name. This might be caused by several reasons: 1. Your disk has no more free space 2. Your disk is write protected 3. The file specified by name already exists and has a read-only or a system attribute. 4. On a network drive you may have no write access to the current directory, contact your system administrator for further information. Unable to create file name See above message for explanation. Unable to open input file name The file you specified cannot be opened. This may either be caused by a misspelling or insufficient access rights in a network environment. ------------------------------------------------------------------------------- - 24 - ARIS VERSION TRACKING SYSTEM Version 1.1 ------------------------------------------------------------------------------- Unable to open RCS.DAT If this happens on a newly created project, you have not yet added files to the project. Therefore no project directory exists. If you where able to access the project before, your disk may have been corrupted. Check the file system and use your backup to restore the project. Username unknown There is no username specified. You must either use the -u command line switch or the environment variable USERNAME to specify a name. ------------------------------------------------------------------------------- - 25 -