JetBrains Rider
 
2024.3
Shortcuts: Visual Studio 2022 (Windows)
Get JetBrains Rider
  1. Reference
  2. UI reference
  3. Version control reference
  4. Shelve Changes dialog

Shelve Changes dialog

Last modified: 11 February 2024

VCS | Shelve Changes

Use this dialog to shelve the selected files or changelists.

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.

Modified files pane toolbar

Item

Tooltip and Shortcut

Description

the Show Diff button

Show Differences

Ctrl0D

Open the Differences dialog that highlights the differences between your local working copy of the selected file and its repository version.

the Revert icon

Revert

Revert all changes made to the local working copy of the selected files.

the Refresh button

Refresh Changes

CtrlAlt0R

Click this button to reload the Changed files tree view so it is up-to-date.

The Group By button

Group By

Choose how you want to group the modified files - by directory or module

the Expand All button

the Collapse All button

Expand or collapse all nodes

CtrlNumPad +

CtrlNumPad -

Click these buttons to expand or collapse all nodes in the directory tree. These buttons are not available in flat view.

Changelist

N/A

From this list, select the changelist that contains the modified files to be shelved. The active changelist is selected by default.

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 Commit window . 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>:

Submit / Commit section

Use the controls in this area to define which additional actions you want JetBrains Rider to perform before shelving the selected files.

These controls are available for the following version control systems:

  • Git

  • Subversion

  • Perforce

Item

Description

Reformat code

Perform code formatting according to the code formatting rules.

Rearrange code

Rearrange your code according to the file and type layout preferences.

Optimize imports

Remove redundant import statements.

Check TODO (<filter name>)

Review the TODO items matching the specified filter. Click Configure to choose an existing TODO filter, or open the TODO settings page and define a new filter to be applied.

Cleanup

run the code cleanup with the 'Full Cleanup' profile in the files you are going to commit/shelve.

After Submit / After Commit section

Use the controls in this area to define which additional actions you want JetBrains Rider to perform after committing the selected files.

Item

Description

Available for

Run tool

From this list, select the external tool that you want JetBrains Rider to launch after the selected changes have been committed. You can select a tool from the list, or click the Browse button the Browse button and configure an external tool in the External Tools dialog that opens.

All VCSs

Upload files to

From this list, select the server access configuration or a server group to use for uploading the committed files to a local or remote host, a mounted disk, or a directory.

  • To suppress uploading, choose None.

  • To add a server configuration to the list, click the Browse button and fill in the required fields in the Add Server dialog that opens.

The list is only available if the FTP/SFTP/WebDAV Connectivity plugin is enabled.

All VCSs

Always use selected server or group of servers

Select this checkbox to always upload files to the selected server or a server group.

The checkbox is only available if the FTP/SFTP/WebDAV Connectivity plugin is enabled.

All VCSs

Diff pane

To open the Diff pane, press Ctrl0D or right-click the file you want to investigate and select Show Diff in the context menu.

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

Diff pane toolbar

Item

Tooltip and Shortcut

Description

the Previous Difference button/the Next Difference button

Previous Difference / Next Difference ShiftF8 F8

Jump to the next or previous difference.

When the last or the first difference is reached, JetBrains Rider suggests clicking the arrow buttons or pressing F8/ShiftF8 once more and comparing other files modified locally. This behavior depends on the Go to the next file after reaching last change option in the Diff Viewer settings.

the Jump to Source button

Jump to Source

F4

Open the selected file in the editor. The caret is placed in the same position as in the Diff Viewer.

Back

Forward

Compare Previous/Next File

CtrlAltPg Up CtrlAltPg Dn

Click these buttons to compare the local copy of the previous/next file with its update from the server.

tip

These buttons are only available when there is more than one file in the selected changelist.

Viewers

Select a viewer mode: side-by-side or unified. The side-by-side mode has two panels, and the unified mode has one panel.

You can edit code and perform the Accept, Append, Revert actions in both viewers.

You can change text only in the right-hand part of the side-by-side viewer or in the lower line in the unified viewer.

You can edit only local versions of your files. You cannot edit files that have read-only status.

Whitespace

Define how the Diff Viewer should treat whitespaces.

  • Do not ignore: white spaces are important, and all the differences are highlighted. This option is selected by default.

  • Trim whitespaces: trim whitespaces if they appear in the end and at the beginning of a line (("\t", " ")).

    • If two lines differ in trailing whitespaces only, these lines are considered equal.

    • If two lines are different, 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: ignores 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, differences between a b c and a \n b c are not highlighted in this mode.

Highlighting mode

Select the way differences granularity is highlighted.

The available options are:

  • Highlight words: modified words are highlighted

  • Highlight lines: modified lines are highlighted

  • Highlight split changes: if this option is selected, big changes are split into smaller changes.

    For example, A \n B and A X \n B X are treated as two changes instead of one.

  • Highlight characters: modified symbols are highlighted

  • Do not highlight: if this option is selected, the differences are not highlighted at all.

    Use the Do not highlight option when you work with the files that were significantly modified. In such cases, highlighting might introduce additional difficulties during a review.

the Collapse Unchanged Fragments icon

Collapse Unchanged Fragments

Collapse all the unchanged fragments in both files. The amount of non-collapsible unchanged lines is configurable on the Diff & Merge settings page. To open the Diff & Merge page, open settings by pressing CtrlAlt0S and navigate to Tools | Diff & Merge. .

Synchronize scrolling

Synchronize scrolling

Scroll both differences panes simultaneously. If this button is released, each pane can be scrolled independently.

the Disable Editing icon

Disable editing

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.

the Gear icon

Editor settings

Open a list of available options. Select or clear these options to show or hide line numbers, indentation guides, white spaces, and soft wraps.

the Help icon

Help

F1

Open a browser and show the corresponding help page.

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

See also

Procedures