PARTIAL SHELVESET CREATE
Create shelvesets in a partial replica with the Unity Version Control CLI.
Read time 2 minutesLast updated 21 days ago
Description
Shelves chosen pending changes.Usage
cm partial shelveset | shelve create | mk [<item_path>[ ...]] [-c=<str_comment> | -commentsfile=<comments_file>] [--applychanged] [--symlink] [--ignorefailed] [--machinereadable [--startlineseparator=<sep>] [--endlineseparator=<sep>] [--fieldseparator=<sep>]]
Options
Option / Argument | Description |
|---|---|
| -c | Specifies a comment to the changeset created in the shelve operation. |
| -commentsfile | Applies the comment from the specified file to the changeset created in the shelve operation. |
| --applychanged | Applies the shelve operation to the changed items detected in the workspace along with the checked out items. |
| --symlink | Applies the shelve operation to the symlink and not to the target. |
| --ignorefailed | Any changes that cannot be applied (because the lock (a.k.a. exclusive checkout) cannot be adquired or because local changes are in conflict with the server changes) are discarded and the shelve operation continues without them. |
| --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. |
| item_path | Items to shelve. Use double quotes (" ") to specify paths containing spaces. Use a whitespace to separate paths. Use . to apply shelve to current directory. |
Help
The 'partial shelveset create' command stores the contents of checked out items inside the repository. This way the contents are protected without the need to checkin the files.Remarks
If neither <item_path> nor any option is specified, the shelveset will include all the pending changes in the workspace. The 'partial shelveset create' operation is always applied recursively from the given path. The 'partial shelveset create' operation is the default, which means that, if no other operation is defined, the command will try to perform a creation.Requirements to shelve an item
- The item must be under source code control.
- The item must be checked out or changed.
Examples
(Creates a new shelveset with 'figure.png' and 'landscape.png' checked-out files.)cm partial shelveset figure.png landscape.png
(Creates a new shelveset with every checked-out file in current directory and sets the comment from the 'mycomment.txt' file.)cm partial shelveset . -commentsfile=mycomment.txt
(Creates a new shelveset with 'background.png', includes a comment.)cm partial shelve background.png -c="my comment"
(Creates a new shelveset all pending changes in the workspace.)cm partial shelveset --applychanged
(Creates a new shelveset with the symlink file and not the target.)cm partial shelveset link --symlink
(Creates a new shelveset with every checked-out file in current directory, ignoring (skipping) the changes that cannot be applied.)cm partial shelveset . --ignorefailed