Shelve Changes Dialog

VCS | Shelve Changes

Use this dialog to shelve the selected files or changelists.

This dialog consists of several areas:

Modified files pane
- Toolbar
Commit Message pane
- Toolbar
Before Submit / Before Commit section
After Submit / After Commit section
Diff pane
- Toolbar

Modified files pane

This section contains a list of files that have been modified since the last commit. All files in the list are selected by default. Deselect the files that you do not want to shelve.

Toolbar

Tooltip and Shortcut	Description
Show Differences `Ctrl+D`	Click this button to open the Differences dialog that highlights the differences between your local working copy of the selected file and its repository version.	All VCSs
Refresh Changes `Ctrl+F5`	Click this button to reload the Changed files tree view so it is up-to-date.	All VCSs
Move to Another Changelist `F6`	Click this button to add the selected file(s) to another changelist. The Move to Another Changelist dialog opens where you can select an existing changelist or create a new one.	All VCSs
Revert	Click this button to revert all changes made to the local working copy of the selected files.	All VCSs
Jump to source `F4`	Click this button to open the source code of the selected file in the editor.	All VCSs
Group by Directory `Ctrl+P`	Click this button to toggle between the flat view and the directory tree view.	All VCSs
Expand or collapse all nodes `Ctrl+NumPad Plus` `Ctrl+NumPad -`	Click these buttons to expand or collapse all nodes in the directory tree. These buttons are not available in flat view.	All VCSs

The summary under the modified files pane shows statistics on the currently selected changelist, such as the number of modified, new and deleted files. This area also shows how many files of each type are shown, and how many of them will be shelved.

Commit Message pane

In this area, enter a string that will be used as the shelf name. When you unshelve your changes, a new changelist with the same name will be created in the Local Changes tab. If you leave this field empty, the shelf name will be generated using the following pattern: <number of files in the shelf>, <date and time when the shelf was created>:

Toolbar

You can click to choose from the list of recent commit messages.

Before Submit / Before Commit section

Use the controls in this area to define which additional actions you want MPS to perform before putting the selected files to a shelf.

These controls are available for the following version control systems:

Git
Subversion
Perforce

Item	Description
Reformat code	Select this checkbox to perform code formatting according to the Project Code Style settings.
Rearrange code	Select this checkbox to rearrange your code according to the arrangement rules preferences.
Optimize imports	Select this checkbox to remove redundant import statements.
Perform code analysis	Select this checkbox to run code inspection on the files you are about to commit.
Cleanup	Select this checkbox if you want to automatically apply the current inspection profile to the files you are going to commit.
Revert unchanged files	Select this checkbox to revert the files that have not been modified. This option is only available for Perforce.

After Submit / After Commit section

Use the controls in this area to define which additional actions you want MPS to perform after putting the selected files to a shelf.

Item	Description
Always use selected server	Select this checkbox to always upload files to the selected server access configuration. The list and the checkbox are only available if the Remote Hosts Access plugin is enabled.

Item

Description

Always use selected server

Select this checkbox to always upload files to the selected server access configuration.

The list and the checkbox are only available if the Remote Hosts Access plugin is enabled.

Diff pane

The Diff pane is hidden by default. To unfold it, click the arrow button next to the pane title.

In this pane you can explore the differences between the base repository version of the selected file, and the version you are about to shelve.

Toolbar

Item	Tooltip and Shortcut	Description
/	Previous Difference / Next Difference `Shift+F7` `F7`	Use these buttons to jump to the next/previous difference. When the last/first difference is reached, MPS suggests to click the arrow buttons `F7`/`Shift+F7` once more and compare other files, depending on the Go to the next file after reaching last change option in the Differences Viewer settings. This behavior is supported only when the Differences Viewer is invoked from the Version Control tool window.
	Compare Previous/Next File `Alt+LeftAlt+Right`	Click these buttons to compare the local copy of the previous/next file with its update from the server. These buttons are only available when there is more than one file in the selected changelist.
	Jump to Source `F4`	Click this button to open the selected file in the active pane in the editor. The caret will be placed in the same position as in the Differences Viewer.
Viewer type		Use this list to choose a viewer type. The side-by-side viewer has two panels; the unified viewer has one panel only. Both types of viewers enable you to Edit code. Note that one can change text only in the right-hand part of the default viewer, or, in case of the unified viewer, in the lower ("after") line, that is in your local version of the file. Perform the Apply/Append/Revert actions.
Whitespace		Use this list to define how the differences viewer should treat whitespaces. Do not ignore: white spaces are important, and all differences are highlighted. This option is selected by default. Trim whitespaces: `("\t", " ")`, if they appear in the end and in the beginning of a line. If two lines differ in trailing whitespaces only, these lines are considered equal. If two lines are different, such trailing whitespaces are not highlighted in the By word mode. Ignore whitespaces: white spaces are not important, regardless of their location in the source code. Ignore whitespaces and empty lines: the following entities are ignored: all whitespaces (as in the 'Ignore whitespaces' option) all added or removed lines consisting of whitespaces only all changes consisting of splitting or joining lines without changes to non-whitespace parts. For example, changing `a b c` to `a \n b c` is not highlighted in this mode.
Highlighting mode		Select the way differences granularity is highlighted. The available options are: Highlight words: the modified words are highlighted Highlight lines: the modified lines are highlighted Highlight split changes: if this option is selected, big changes are split into smaller 'atomic' changes. For example, `A \n B` vs. `A X \n B X` will be treated as two changes instead of one. Highlight symbols: the modified symbols will be highlighted Do not highlight: if this option is selected, the differences are not highlighted at all. This option is intended for significantly modified files, where highlighting only introduces additional difficulties.
	Collapse unchanged fragments	Click this button to collapse all unchanged fragments in both files. The amount of non-collapsible unchanged lines is configurable in the Diff & Merge settings page.
	Synchronize scrolling	Click this button to scroll both differences panes simultaneously. If this button is released, each pane can be scrolled independently.
	Disable editing	Click this button to enable editing of the local copy of the selected file, which is disabled by default. When editing is enabled, you can make last-minute changes to the modified file before committing it.
	Editor settings	Click this button to open a list of available options. Select or clear these options to show or hide line numbers, indentation guides, white spaces, and soft wraps.
	Show diff in external tool	Click this button to invoke an external differences viewer, specified in the External Diff Tools settings page. This button only appears on the toolbar when the Use external diff tool option is enabled in the External Diff Tools settings page.
	Help `F1`	Click this button to show the corresponding help page.

Note that the options listed above are available for text files only. MPS cannot compare binary files, so most commands will be unavailable for them.

Last modified: 5 July 2019