Brief Guide to Using SnapshotCM's Eclipse Plug-in
The SnapshotCM plug-in for Eclipse provides basic history, check in and check out support from within the Eclipse IDE.
Please consider this to be an alpha/beta release and report any plug-in related problems.
We also are looking into adding support for new/missing functionality. As you use the plug-in, please keep a list of missing/desired features, and after you've used it a bit, please send us your prioritized list. Your feedback is appreciated.
- Plug-in name: com.trueblue.snapshotcm.SscmProvider.1.83.0.jar
- SnapshotCM client releases: 1.81.01 through 1.82.08, and 1.83.6, 1.84 and newer.
- Eclipse environments: Testing was done with 3.4.2 and 3.5
- OS environments: Same as the SnapshotCM command-line, since the plug-in calls the commands.
- If you try another Eclipse release, please let us know how it works.
- Copy the SnapshotCM plug-in into the Eclipse plugins directory.
- Remove any old copy of the SnapshotCM plug-in from the Eclipse plugins directory.
- Install a supported version of the SnapshotCM clients onto your system.
- Insure that the SnapshotCM bin directory is in the PATH environment variable during eclipse start up.
- Restart eclipse.
- To enable the plug-in, you need to do two things first:
- Create a SnapshotCM workspace mapping for the files in the Eclipse workspace you want to version control.
- Enable the plug-in, by selecting a project in the Package Explorer, select the project's Team -> Share Project menu, selecting SnapshotCM, then Next and Finish.
The SnapshotCM plug-in enables the following Eclipse Team functionality:
- Ability to share a project - interface with SnapshotCM directly from within the Eclipse IDE.
- Ability to lock a version controlled file on file edit.
- Display of version control status, including
- overlay icon indicating that file is version controlled by SnapshotCM
- overlay icon indicating that file is locked in SnapshotCM
- file name prefix indicating if file is modified, out-of-date, or requires merge (<, >, <> respectively).
- Ability to remove a version controlled file from SnapshotCM via Delete context menu
- Ability to lock a file via Team context menu
- Ability to check in a changed file via Team context menu
- Ability to replace a changed file with the latest from SnapshotCM via Replace With context menu.
- Ability to display file history in a History tab via Team context menu. History tab supports pinning and linking with selection.
- Ability to view older versions of a file via the History tab's context menu on a revision.
- Ability to update the full workspace via a project's Team context menu.
Locations Where SnapshotCM Plug-in Is Visible:
- Help -> About Eclipse SDK
One entry: True Blue Software Company, SnapshotCM Plug-in, 1.83.0, com.trueblue.snapshotcm.SscmProvider, not signed.
- General -> Appearance -> Label Decorations: Check "SnapshotCM File Status Decorators" to enable.
- Team -> SnapshotCM Preferences: Options for debug output
- Project -> Properties has "SnapshotCM Properties" section with no contents.
- In Plug-ins tab, select com.trueblue.snapshotcm.SscmProvider.
Context menu contains:
- Team -> Share Project - shows available Team Plug-ins. Select SnapshotCM, Next, Finish.
- Team -> Disconnect from SnapshotCM - disable Team features in Eclipse
- In Package Explorer, select project, then context menu is:
- oTeam -> Share Project Use to enable SnapshotCM. Select SnapshotCM, which opens a SnapshotCM Repository dialog filled out with existing workspace definition. This step is necessary to enable SnapshotCM plug-in functionality. Select Next, then Finish.
- Team -> Add - not sure - not tested
- Team -> Synchronize - not sure about this
- Team -> Check Out Locked
- Team -> Check in
- Team -> Update workspace from SnapshotCM
- Team -> Disconnect from SnapshotCM
- Replace With -> Latest from Snapshot
- Ò In Package Explorer, select controlled file:
- Delete - removes local file AND file from SnapshotCM's mapped snapshot (wremove -F)
- Team -> Add - import new file into SnapshotCM (wci -u -auto ...)
- Team -> Synchronize - not sure - not tested
- Team -> Check Out Locked (wco -lt " ")
- Team -> Check in (wci -u -C "User's Comment Text")
- Team -> Show History - displays active history style of display in History tab. (whist)
- If you find others, please let us know where (the context and action).