si appendcheckpointdesc
appends additional text to a checkpoint description
Synopsis
si appendcheckpointdesc [(-d desc|--description=desc)] [--descriptionFile=file] [(-P project|--project=project)] [--[no]failOnAmbiguousProject] [--projectRevision=rev] [--hostname=server] [--port=number] [--password=password] [--user=name] [(-?|--usage)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [(-g|--gui)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] project...
Description
si appendcheckpointdesc appends additional text to a checkpoint description. For example,
si appendcheckpointdesc --projectRevision=1.23 --description="Release Canadidate" c:/Aurora_Program/bin/Libra/project.pj
A checkpoint description is created when you checkpoint a project. When you review the description for a specific checkpoint, through the si viewprojecthistory or si projectinfo command, you see the appended information in a manner similar to the following:
--- Added comments --- sholmes [Oct 23, 2009 2:39:31 PM EDT]
Appended Description
Appended Description
 |
Appending a checkpoint description recursively appends the checkpoint description for all subprojects.
|
Options
This command takes the universal options available to all si commands, as well as some general options. See the options reference page for descriptions. You must specify the --project and --projectRevision options.
• -d desc
• --description=desc
specifies the new description text to be appended to the existing checkpoint description. These options and the --descriptionFile option are mutually exclusive.
|
|
Descriptions that include spaces must be enclosed by quotes.
|
• --descriptionFile=file
specifies a file name, file, containing the new description text to be appended to the existing checkpoint description. This option and the -d or --description options are mutually exclusive.
• project...
identifies a specific project; use spaces to specify more than one project.
Diagnostics
See the diagnostics reference page for possible exit status values.
Preferences
Using si setprefs or si viewprefs, you are able to set or view the preference keys for this command.
See Also