si addprojectlabel
assigns a label to a project
Synopsis
si addprojectlabel [--[no|confirm]moveLabel] [(-L label|--label=label)] [(-P project|--project=project)] [(-S sandbox|--sandbox=sandbox)] [--[no]failOnAmbiguousProject] [--devpath=path] [--projectRevision=rev] [--hostname=server] [--port=number] [--password=password] [--user=name] [(-?|--usage)] [(-Ffile|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [(-g|--gui)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] [--[no]includeUnchangedSubprojects] [-R|--[no|confirm]recurse]
Description
si addprojectlabel assigns a label to a checkpointed revision of a project. For example,
si addprojectlabel --project=c:/Aurora_Program/bin/Libra/project.pj -R --label="Release Candidate 002"
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.
• --[no|confirm]moveLabel
controls whether the application should move a label from one revision to another.
--nomoveLabel disables the moving of a label.
--confirmmoveLabel displays a confirmation message.
--moveLabel moves the label.
• -L label
--label=label
identifies a label. Note the following about using labels:
◦ Labels cannot contain colons(:), square brackets ([ ]), or leading spaces.
◦ Labels cannot have the same format as a valid revision number.
◦ Labels that include spaces must be enclosed by quotes.
◦ PTC recommends not using hyphens (-) in labels. Using hyphens may cause some si commands to fail.
◦ Labels cannot contain numbers without any spaces, for example, 14325. Numbers that contain spaces are acceptable, for example, 2432 1234.
• --[no]includeUnchangedSubprojects
specifies if to label both unchanged subprojects and build subprojects. The default is --noincludeUnchangedSubprojects.
• -R
--[no|confirm]recurse
controls whether to assign the label to subprojects recursively. Note the following:
◦ If a subproject is not in the most recent checkpoint for the project selection due to it being unchanged, that subproject is not labeled. To label such subprojects, use the --[no]includeUnchangedSubprojectsoption with this command.
◦ If you do not have permission to access a subproject, an error is displayed and the subproject and all of its child subprojects are not labeled.
◦ If you do not have permission to move a label, an error is displayed for the affected subproject.
◦ If a subproject is configured as build, the subproject is not labeled. Consequently, build subprojects on extendable development paths are also not labeled. To force the labeling of build subprojects, specify the --[no]includeUnchangedSubprojects option.
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