ANNOTATE
Annotate files with the Unity Version Control CLI.
Description
Shows the changeset where each line of a file was last modified and its author.
Usage
cm annotate | blame <spec>[ ...] [--format=<str_format>] [--comparisonmethod=(ignoreeol | ignorewhitespaces | ignoreeolandwhitespaces | recognizeall)] [--dateformat=<str_date_format>] [--encoding=<name>] [--stats] [--repository=<repspec>]
Options
Option / Argument | Description |
|---|
| Retrieves the output message in a specific format. See Remarks for more info. |
| Sets the specified comparison method. See Remarks for more info. |
| Sets the output format to print dates. |
| Specifies the output encoding, i.e.: utf-8. See the MSDN documentation to get the table of supported encodings and its format, (at the end of the page, in the "Name" column). |
| Shows statistics information. |
| Specifies a repository spec used to calculate the annotations. By default, this command uses the repository where the loaded revision repository in the workspace is stored. (Use to learn more about repspecs.) |
| spec | The spec of the file to annotate. (Use to learn more about specs.) Use double quotes () to specify paths containing spaces. |
Help
Binary files can't be annotated.
Comparison methods (--comparisonmethod option)
Option / Argument | Description |
|---|
| Ignores the end of line differences. |
| Ignores the whitespace differences. |
| Ignores the end of line and whitespace differences. |
| Detects the end of line and whitespace differences. |
Option / Argument | Description |
|---|
| User who changed the line the last time. |
| Source revision specification of the line. |
| Line content. |
| Date when the line was checked in. |
| Comment of the source revision of the line. |
| Changeset of the source revision of the line. |
| Line number of the file. |
| Item id. |
| Parent id of the item. |
| Repository of the item. |
| Branch of the source revision of the line. |
| Whether the revision of the line was created in a merge. |
Repository specification (--repository)
To retrieve data from a remote repository. Useful for distributed scenarios.
Examples
cm blame c:\workspace\src --comparisonmethod=ignoreeolandwhitespaces --encoding=utf-8
cm annotate c:\workspace\file.txt --comparisonmethod=ignoreeol
cm annotate c:\workspace\file.txt --format="{owner} {date, 10} {content}"
(Writes the owner field, then a blank, then the date field (aligned to right), then a blank, and the content.)
cm blame c:\workspace\file.txt --format="{owner, -7} {comment} {date}" --dateformat=yyyyMMdd
(Writes the owner field in 7 spaces (aligned to the left) followed by a blank, then the comment, followed by another blank, and ending with the formatted date (for example, 20170329).)
cm annotate c:\workspace\file.txt --repository=centralRep@myserver:8084
cm blame serverpath:/src/client/checkin/Checkin.cs#cs:73666
(Annotates the file starting in changeset 73666 using a server path.)