The Seapine Technical Writing team relies heavily on Surround SCM’s shelves. Shelves are containers stored on the Surround SCM Server where you can store new and modified files from a working directory before adding or checking them in to Surround SCM. We use shelves to share documentation files for peer review.
For example, when I finish writing new topics or editing existing topics, I shelve the files and share the shelf with another team member. They can unshelve the files to copy them to their working directory, review them and add any changes, and then create a new shelf to add the changed files to. I unshelve the changed files to my working directory, accept the changes or make additional changes in the files, and then delete both shelves. I can then check in or add files to Surround. It is an easy process that helps us ensure that all files go through review before they are checked in or published.
As I use shelves, I have discovered different ways to shelve files depending where I am in Surround SCM and the files I need to shelve. You can shelve files in the following areas.
The Shelves window is the main place to work with shelved files. It displays all shelves you have access to and you can add new shelves, shelve and unshelve files, view differences, and more. To open the Shelves window, choose View > Shelves
To add a shelf, click Create Shelf
, enter a name and description, and click OK
. To add files to the shelf, select it and click Shelve Files
. Any files that are not yet added to Surround SCM or modified files are displayed. Select the files to shelve and click OK
. You can then edit the shelf to share it or make another user the owner. Other users can work with shelves shared with them in this window.
Source Tree window
Shelve files from the Source Tree window if want to shelve modified files that are already in Surround SCM. If you only want to display specific files in the file list, apply a filter. Then, right-click the files to shelve and choose Shelve Files
. The Shelve Files dialog box opens. Here, you can create the shelf at the same time as you shelve files, or add files to an existing shelf.
If you do not see Shelve Files in the shortcut menu, you can easily add it. Choose Tools > User Options
. Select the File List Menu
or Repository Menu
category. Select Shelve Files
in the Available menu items list and click the right arrow button to add it to the Current menu items list. Click OK
to save the changes. You should now see Shelve Files in the menu when you right-click a file or repository.
Working Directory Differences dialog box
My favorite way to shelve files is from the Working Directory Differences dialog box. It is the best place to quickly see files that have not yet been added to Surround and any modified files, which are valid files that you can add to shelves.
To view differences, right-click a repository and choose Working Directory Differences
. (Remember, you can add it to the shortcut menu if it is not displayed.) Optionally select Recursive
to view all differences in the repository and subrepositories. You can easily identify files to shelve by the reason they are different from the Surround SCM Server, which is displayed in the Differences column. These are ‘different timestamps’ or ‘missing on server’ files.
Select the files you want to shelve and click Shelve
. The Shelve Files dialog box opens. You can create a new shelf or add files to an existing shelf.
You can more about using shelves in the Surround SCM help