Bookmarking items

You can bookmark items you frequently use to quickly access them from the Bookmarks menu. You can bookmark:

  • Files
  • Repositories
  • Branches
  • Code reviews, including reviews that are open
  • Files in code reviews, including files that are open
  • Shelves

The first nine bookmarks in the list are automatically assigned keyboard shortcuts. You can rearrange bookmarks to change the order they are displayed in the Bookmarks menu and the assigned keyboard shortcuts. See Managing bookmarks.

1. Select the item to bookmark and choose Bookmarks > Add Bookmark.

The Add Bookmark dialog box opens. The read-only Address for the item is displayed.

2. Enter a bookmark Name and Description.

The default name depends on the item you are bookmarking. You can use the default name or change it.

  • Branch—Branch name
  • File or repository—File or repository name prepended with the branch name. For example, WysiCorpDevelopment::Code or WysiWrite 2.0.x::main.cpp.
  • Code review—Code review name
  • Code review file—File name prepended with the code review name. For example, My Code Review - File main.cpp.
  • Shelf—Shelf name

3. If you are bookmarking a repository or file, select a Navigation option to indicate the branch to access when using the bookmark.

  • Always go to <BranchName> branch always navigates to the branch displayed in the Address field. For example, if the bookmark contains the WysiCorp branch, Surround SCM always navigates to the WysiCorp branch when using the bookmark.
  • Do not switch branches navigates to the repository or file in the branch selected in the Source Tree window. If this option is selected, the branch name is removed from the Address field. For example, if the bookmark contains the WysiCorp branch and the WysiCorp 1.x branch is selected when you use the bookmark, Surround SCM navigates to the repository or file in the WysiCorp 1.x branch.

4. Click OK.

The bookmark is added. To use the bookmark, select it in the Bookmarks menu.

A bookmark may no longer work and display an error when a bookmarked file, repository, or branch is moved, renamed, or deleted. A bookmarked code review, code review file, or shelf may no longer work if the mainline branch the bookmark belongs is renamed. You can delete the old bookmark and then create a new one. See Managing bookmarks.