readme-cmvc-client-samples.html

CMVC是IBM和许多跨国公司的缺陷管理工具。这里给出了很多在Linux下用KSH编写的使用CMVC命令的例子。这些例子来自于IBM内部的CMVC培训。

#
# FUNCTIONS:   This sample shell script displays total active defect
#              statistics on a defect owner area basis.
#
# USAGE:       defectStats ownerArea
#
# ENVIRONMENT
# VARIABLE(S): CMVC_FAMILY [CMVC_BECOME]
</pre>

<h2> <a name="defffch"> defFeaFileChgs</a>
</h2>
<p> 
The following text was copied from the header of the Korn shell script:
</p>
<pre>
# SAMPLE NAME: defFeaFileChgs
#
# FUNCTIONS:   This sample shell script lists all of the files that
#              were changed for a specified defect or feature.
#
# USAGE:       defFeaFileChgs { defectNumber | featureNumber }
#
# ENVIRONMENT
# VARIABLE(S): CMVC_FAMILY [CMVC_BECOME]
</pre>

<h2> <a name="dowith"> do_with.cmd (Rexx)</a>
</h2>
<p> 
The following text was copied from the header of the Rexx script:
</p>
<pre>
#* Name:    do_with  input_file_with_names  command  flags
#*
#* Purpose:
#*   To process the files or the directories specified in
#*   "input_file_with_names" using the "command" and the "flags" specified
#*   in the line command. The last flag should contain the action that will
#*   deal with the file, such as -extract or -create.
#*
#*   The "input_file_with_names" is the file with the list of filenames or
#*   directories, in the format of 1 name per row.
#*
#*   You can obtain the list of the filenames in your directory and all the
#*   subdirectories, in one column, by using the command in Windows NT or 95:
#*
#*     dir /b /s  >  input_file_with_fileNames     (full path only filenames)
#*
#*   You can obtain the list of the filenames in your directory in one column,
#*   by using the command:
#*
#*   (in AIX)     ls -1     >  file_with_fileNames
#*
#* Examples (Intel):
#*
#*  a) To extract all the files specified in the input_file in the directory
#*     C:\WORK:
#*
#*   Windows:  rexx  do_with    files.dir    File     -relative C:\WORK -extract
#*
#*  b) To create the directories specified in input_file starting in the
#*     current directory;
#*
#*   Windows:  rexx  do_with    directr1.dir    mkdir
#*
#*  c) To delete the files inside the directories specified in input_file:
#*
#*   Windows:  rexx  do_with    director1.dir    del /n
#*
#*  d) To remove the directories:
#*     NOTE: if the file directr1.dir was used to create the directories, then
#*           it is necessary to reverse the order of the directories to be
#*           removed.  Let's assume that directr2.dir is the reverse of
#*           directr1.dir.
#*
#*   Windows:  rexx  do_with    director2.dir    rmdir
#*
#* Note for CMVC:
#*     The following environment variables must be specified before
#*     invoking this batch_file.  These variables can be set in the
#*     config.sys/registry or by setting them directly from the command prompt.
#*
#*     CMVC_FAMILY
#*     CMVC_BECOME
#*     CMVC_RELEASE
#*     CMVC_COMPONENT
</pre>

<h2> <a name="xaffc"> extractAllFilesForComponent </a>
</h2>
<p> 
The following text was copied from the header of the Korn shell script:
</p>
<pre>
# SAMPLE NAME: extractAllFilesForComponent
#
# FUNCTIONS:   This sample shell script extracts all the files 
#              associated with a specific component and places them in 
#              the path specified by the relativePathName parameter.
#              If a file belongs to several releases, one version is
#              extracted for each release, under a subdirectory that is
#              named after the release.
#              The versions of the files can be current (default) or committed.
#
# USAGE: 
# extractAllFilesForComponent componentName relativePathName [current|committed]
#                                                             *******
</pre>

<h2> <a name="xcffr"> extractCommittedFilesForRelease </a>
</h2>
<p> 
The following text was copied from the header of the Korn shell script:
</p>
<pre>
# SAMPLE NAME: extractCommittedFilesForRelease
#
# FUNCTIONS:   This sample shell script extracts all the COMMITTED files 
#              associated with a specific release and places them in 
#              the path specified by the relativePathName parameter.
#
# USAGE:       extractCommittedFilesForRelease releaseName relativePathName
</pre>

<h2> <a name="xcuffr"> extractCurrentFilesForRelease </a>
</h2>
<p> 
The following text was copied from the header of the Korn shell script:
</p>
<pre>
# SAMPLE NAME: extractCurrentFilesForRelease
#
# FUNCTIONS:   This sample shell script extracts all the CURRENT files 
#              associated with a specific release and places them in 
#              the path specified by the relativePathName parameter.
#
# USAGE:       extractCurrentFilesForRelease releaseName relativePathName
</pre>

<h2> <a name="xffcol"> extractFilesForCommittedLevel </a>
</h2>
<p> 
The following text was copied from the header of the Korn shell script:
</p>
<pre>
# SAMPLE NAME: extractFilesForCommittedLevel
#
# FUNCTIONS:   This sample shell script extracts the committed files
#              associated with a specific committed level in a release,
#              and places them in the path specified by 
#              the relativePathName parameter.
#              This is equivalent of doing a delta extract on the committed
#              level.
#
# USAGE:  extractFilesForCommittedLevel releaseName levelName relativePathName
</pre>

<h2> <a name="xffcofr"> extractFilesForComponentForRelease </a>
</h2>
<p> 
The following text was copied from the header of the Korn shell script:
</p>
<pre>
# SAMPLE NAME: extractFilesForComponentForRelease
#
# FUNCTIONS:   This sample shell script extracts all the files 
#              associated with a specific component and a release 
#              and places them in 
#              the path specified by the relativePathName parameter.
#              The versions of the files can be current or committed.
#
# USAGE: 
# extractFilesForComponentForRelease \
#      componentName releaseName relativePathName [current|committed]
#                                                  *******
</pre>

<h2> <a name="xfft"> extractFilesForTrack </a>
</h2>
<p> 
The following text was copied from the header of the Korn shell script:
</p>
<pre>
# SAMPLE NAME: extractFilesForTrack
#
# FUNCTIONS:   This sample shell script extracts the files
#              associated with a specific committed track in a release,
#              and places them in the path specified by 
#              the relativePathName parameter.
#
# USAGE:  extractFilesForTrack releaseName trackName relativePathName
</pre>

<h2> <a name="xffunl"> extractFilesForUncommittedLevel </a>
</h2>
<p> 
The following text was copied from the header of the Korn shell script:
</p>
<pre>
# SAMPLE NAME: extractFilesForUncommittedLevel
#
# FUNCTIONS:   This sample shell script extracts the uncommitted files
#              associated with a specific uncommitted level in a release,
#              and places them in the path specified by 
#              the relativePathName parameter.
#              This is equivalent of doing a delta extract on the uncommitted
#              level.
#
# USAGE:  extractFilesForCommittedLevel releaseName levelName relativePathName
</pre>

<h2> <a name="xlumf"> extractLevelUsingMapFile </a>
</h2>
<p> 
The following text was copied from the header of the Korn shell script:
</p>
<pre>
# Name: extractLevelUsingMapFile
# 
# Purpose: To extract a committed Level using the Map File in the server.
#          This will use a File extract for each file involved, and will not
#          use the actual level extract code.
# 
# IMPLEMENTATION NOTES:   
#          This sample needs further improvement for handling input parameters
#          and error messages.
#
# WARNING:   This is AS-IS code.
#
# EDITORIAL Notes:
# 1) The ChangeView will return duplicate fileName/SID combinations   
#    if multiple tracks were specified upon checkin of a file so you   
#    may need to sort the output from Report -view ChangeView before     
#    iusing "awk".  It is possible that the following will work but may
#    not be too eloquent:
#                                                                   
#       Report -view ChangeView -where "fileId=$fileId and \          
#         versionId=$versionId and release  Name='$RELEASE' " -raw |
#         sed "s/\|/:/g" | sort -u -k4,5 -t: |                 
#         awk -F":" ' {system("/usr/lpp/cmvc/bin/File -extract " $5 \   
#         " -relative /yourAFSDir -release " $1 " -version " $4)} '     
#                                                                   
# 2) For destroyed files, the File -extract will not work since the
#    File entry in the database is destroyed.  Therefore the only   
#    thing you could do is issue a native SCCS command to get the        
#    file from the CMVC server.  This is NOT recommended since you       
#    do not really want your users issuing native SCCS commands from the 
#    CMVC server.  
</pre>

<h2> <a name="filelk"> fileLkAfterRelLk </a>
</h2>
<p> 
The following text was copied from the header of the Korn shell script:
</p>
<pre>
# SAMPLE NAME: fileLkAfterRelLk
#
# USAGE:       fileLkAfterRelLk [-committed] [-defect <defect name>] \
#                               <old release> <new release> [-?] [-help]
#
# PURPOSES:   
#   a) To continue a release link that did not complete successfully:
#
#   b) To bypass completely the Release -link command, and perform a
#      complete link of the files between releases.
#
# FUNCTION:
#      This sample shell script gets the list of all the files related 
#      to the specified releases which were linked from the 
#      <old release> either committed or current (default),
#      to <new release>, finds out what files are missing
#      during the Release -link operation, then does File -link
#      on all those missing files.
#
# NOTES:
#  * The parameter "-defect" really is the track number (defect/feature).
#
#  * This shell script does not check if the new release is using a subprocess
#    that requires a defect/feature (track).
#    Thus, in case that this new release needs a track and you do not provide
#    one, then the following error will be shown:
#
# Loop through the missing files and do File -link, one-by-one
# Running: File -link T6.CMD  -release testlevel -to testlevel2
# 0010-258 The requested action requires that you specify one or more
#          defects or features.
</pre>

<h3> <a name="dowithtxt"> Instructions on how to use do_with.cmd (Rexx)</a>
</h3>
<p>
For more details on how to use the do_with.cmd Rexx script, see the following file
that is included in this package: README-do_with.txt

<h2> <a name="profile"> profile.client </a>
</h2>
<p> 
The following text was copied from the header of the Korn shell script:
</p>
<pre>
## Name: profile.client
##
## Usage:  
##   1) copy this file into the desired $HOME and rename it as .profile
##   2) edit the profile by following the customization instructions below. 
##
## Purpose:
##  To setup all the environment variables needed to work with 
##  a CMVC V4 client.
##  It uses the Korn shell. 
##
## Customization instructions:
##  * Review this profile and change the appropriate values for the 
##    following mandatory environment variables:
##       CMVC_HOME, CMVC_FAMILY, CMVC_AUTH_METHOD
##  * Also, you need to customize the configuration variables that affect 
##    the prerequisites:
##       JAVA_HOME, MOZILLA_HOME (Netscape) 
##  * The lines that begin with double ## are comments.
##  * The lines that begin with single #  are not comments, 
##    but are statements that you may decide to uncomment in order 
##    to activate them.
##  * For explanation on the CMVC environment variables, see the 
##    Server section in the CMVC InfoCenter at:
##     http://w3.sdwb.ibm.com/cmvc/4.0/infocenter/htdocs/help/index.html
##
## Miscellaneous notes:
##  * Starting with CMVC V4.0, there are some changes in which the message
##    catalog is handled:
##    - The NLSPATH and CMVC_CATALOG variables are no longer needed for 
##      the server nor the client.
##    - The new CMVC_CLIENT_CMC variable is optional and is only needed
##      for the CMVC client line commands.
##  * If using CDE (Common Desktop Environment), add the following    
##    line (uncommented, of course), at the end of $HOME/.dtprofile 
##    in order to invoke this profile:
##                   DTSOURCEPROFILE=true                             
##
##----------------------------------------------------------------------
</pre>

<h2> <a name="what"> what.exe for Windows </a>
</h2>
<p> 
The tool what.exe for Windows is an equivalent to the Unix "what"
command, which allows the end user to find out any embedded strings
in an executable.
For example:
<pre>
cd c:\cmvc\bin
what Report.exe

# The result could be:
Report.exe:
         cmvc      CMVC Command: Report
         cmvc      SID         : 1.23
         cmvc      CMVC Version: 4.0.0.026(SP5)
         cmvc      Date Build  : 2002/12/02
         cmvc      Platform    : WIN32
         cmvc      (c) Copyright, IBM Corp.,1994-2002
         cmvc      **** THIS PROGRAM IS FOR INTERNAL USE ONLY ****
</pre>

<hr>
<h1> <a name="other"> Other Samples </a>
</h1>
<p>
For more details, see the comments in the header of each file.
<ul>

<li> featureReport.sh
<br> 
This sample shell script generates a global feature report
showing tracks, tests, sizes, approvals and fixes.
The report contains 132 columns of data and should be piped
to an output file for subsequent printing.
<p>

<li> featuresInLevel.sh
<br> 
This sample shell script lists all features contained
in a specified level.
<p>

<li> featureStats.sh
<br> 
This sample shell script displays total active feature
statistics on a feature owner area basis.
<p>

<li> featuresInState.sh
<br> 
This sample shell script lists the feature number
of all features that are in a specified state.
<p>

<li> fileCheckIn.sh
<br> 
This sample shell script checks files into the CMVC tool.
It shows common files and constructs a File -checkin command
using common releases.  The CMVC_RELEASE environment variable 
must be set if the release name is not specified on the command line.
<p>

<li> fileCompare.sh
<br> 
This sample shell script checksout a file and compares it with
the previous copy in the same directory.  The CMVC_RELEASE
environment variable must be set if the releaseName is not
specified on the command line.
<p>

<li> fileHistory.sh
<br> 
This sample shell script lists all defect and feature