WORKSPACESTATUS
Description
Shows changes in the workspace.
Usage
cm status [<wk_path>] [--changelist[=<name>] | --changelists] [--cutignored] [ --header] [ --noheader] [ --nomergesinfo] [ --head] [--short] [--symlink] [ --dirwithchanges] [--xml[=<output_file>]] [--encoding=<name>] [ --wrp | --wkrootrelativepaths] [--fullpaths | --fp] [<legacy_options>] [<search_types>[ ...]] [--pretty] [--machinereadable [--startlineseparator=sep] [--endlineseparator=sep] [--fieldseparator=sep]]
Options
| Option / Argument | Description |
|---|---|
| --changelist | Shows changes in the selected changelist. |
| --changelists | Shows changes grouped in client changelists. |
| --cutignored | Skips the contents of ignored directories. Requires the '--ignored' search type. See the Search types section for more information. |
| --header | Only prints the workspace status. |
| --noheader | Only prints the modified item search result. |
| --nomergesinfo | Doesn't print the merge info for changes. |
| --head | Prints the status of the last changeset on the branch. |
| --short | Lists only paths that contains changes. |
| --symlink | Applies the operation to the symlink and not to the target. |
| --dirwithchanges | Shows directories that contain changes inside them (added, moved, removed items inside). |
| --xml | Prints the output in XML format to the standard output. It is possible to specify an output file. |
| --pretty | Prints workspace changes in a nice table format. |
| --encoding | Used with the --xml option, specifies the encoding to use in the XML output, i.e.: utf-8. See the MSDN documentation at http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx to get the table of supported encodings and its format (at the end of the page, in the "Name" column). |
| --wrp | Print workspace root relative paths instead of current directory relative paths. |
| --fullpaths, --fp | Force printing absolute paths, overriding any other path printing setting. |
| --machinereadable | Outputs the result in an easy-to-parse format. |
| --startlineseparator | Used with the '--machinereadable' flag, specifies how the lines should start. |
| --endlineseparator | Used with the '--machinereadable' flag, specifies how the lines should end. |
| --fieldseparator | Used with the '--machinereadable' flag, specifies how the fields should be separated. |
| --iscochanged | Shows whether contents of a checked-out file have changed or not. This flag is only available with "--compact", "--xml" and "--machinereadable" options. If this flag is not set, the "--compact", "--xml" or "--machinereadable" options will show just "CO" status for a checked-out file with its contents changed. If this flag is set, the "--compact", "--xml" or "--machinereadable" options will show "CO+CH" status for a checked-out file with its contents changed. |
| wk_path | Path of the workspace where the search will be performed. |
Legacy options
| Option / Argument | Description |
|---|---|
| --cset | Prints the workspace status in the legacy format. |
| --compact | Prints the workspace status and changelists in the legacy format. |
| --noheaders | When used in conjunction with the '--compact' flag, the changelist headers will not be printed. (Does not apply to the new changelists format.) |
Search types
| Option / Argument | Description |
|---|---|
| --added | Prints added items. |
| --checkout | Prints checkedout items. |
| --changed | Prints changed items. |
| --copied | Prints copied items. |
| --replaced | Prints replaced items. |
| --deleted | Prints deleted items. |
| --localdeleted | Prints locally deleted items. |
| --moved | Prints moved items. |
| --localmoved | Prints locally moved items. |
| --percentofsimilarity=<value> | Percent of similarity between two files in order to consider them the same item. Used in the locally moved search. Its default value is 20%. |
| --txtsameext | Only those text files that have the same extension will be taken into account by the similarity content matching process during the moved items search. By default, any text file will be processed. |
| --binanyext | Any binary file will be taken into account by the similarity content matching process during the moved items search. By default, only those binary files that have the same extension will be processed. |
| --private | Prints non controlled items. |
| --ignored | Prints ignored items. |
| --hiddenchanged | Prints hidden changed items. (Includes '--changed') |
| --cloaked | Prints cloaked items. |
| --controlledchanged | This flag substitutes the following options: '--added', '--checkout', '--copied', '--replaced', '--deleted', '--moved'. |
| --all | This flag replaces the following parameters: '--controlledchanged', '--changed', '--localdeleted', '--localmoved', '--private'. |
Help
Remarks
The 'status' command prints the loaded changeset on a workspace and gets the changed elements inside the workspace.
This command can be used to show the pending changes in a workspace; the type of changes that can be searched can be modified by using the command parameters. By default, all changes are displayed, be they controlled or local.
The percent of similarity parameter '--percentofsimilarity' (-p) is used by the locally moved search to decide if two elements are the same item. The default value is 20% but it can be adjusted.
It is possible to show workspace changes grouped by client changelists. The 'default' changelist includes the changes that are not included in other changelists. That being said, the changes the default changelist will show depends on the search types flags specified.
Showing changes grouped by changelists requires showing controlled changes too (items with status equal to 'added', 'checkout', 'copied', 'replaced', 'deleted', or 'moved'). So, the '--controlledchanged' option will be automatically enabled when changelists are shown.
The default encoding for XML output is utf-8.
By default, this command will print current directory relative paths, unless the '--machinereadable' or '--short' flags are specified. If any of them are specified, the command will print absolute paths.
If '--xml' flag is specified, workspace root relative paths will be printed (unless the '--fp' flag is also specified, printing absolute paths instead).
Examples
cm status
(Prints the working changeset and also all item types changed in the workspace, except the ignored ones.)
cm status --controlledchanged
(Prints the working changeset and also the items that are checkedout, added, copied, replaced, deleted, and moved.)
cm status --added
(Prints only the working changeset and the added items inside the workspace.)
cm status c:\workspaceLocation\code\client --added
(Prints the working changeset and the added items under the specified path recursively.)
cm status --changelists
cm status --changelist
(Shows all the workspace changes grouped by client changelists.)
cm status --changelist=pending_to_review
(Shows the changes on the changelist named 'pending_to_review'.)
cm status --changelist=default --private
(Shows the changes in the 'default' changelist, showing private items, along with items with controlled changes, if any.)
cm status --short --changelist=pending_to_review | cm checkin -
(Checkins the changes in the changelist 'pending_to_review'.)
cm status C:\workspaceLocation --xml=output.xml
(Gets the status information in XML format and using utf-8 in the file output.xml.)
cm status --ignored
(Shows all ignored items.)
cm status --ignored --cutignored
(Shows ignored files whose parent directory is not ignored and ignored directories but not their contents.)