Surround SCM User Guide Version 2014.1 Copyrights © 2014 Seapine Software, Inc
Total Page:16
File Type:pdf, Size:1020Kb
Surround SCM User Guide Version 2014.1 Copyrights © 2014 Seapine Software, Inc. All rights reserved. Defect Scribe, QA Wizard Pro, Resource Thief, Seapine CM, SoloBug, SoloSubmit, Surround SCM, and TestTrackare trademarksor registered trademarksof Seapine Software, Inc. in the United Statesand other countries. Borland and StarTeam are trademarksor registered trademarksof Borland, Inc. in the United Statesand other countries. Delphiand JBuilder are trademarksor registered trademarksof Embarcadero Technologies, Inc. in the United Statesand other countries. Acrobat Reader isa registered trademarkof Adobe, Inc. in the United Statesand other countries. Sun, JVM, Java, JavaScript, and allJava-based marksare trademarksor registered trademarksof Sun Microsystems, Inc. in the United Statesand other countries. UNIX isa registered trademarkin the United Statesand other countries, licensed exclusivelythrough X/Open CompanyLimited. Apple, Mac, MacOS, Macintosh, Objective-C, and Safariare registered trademarksof Apple Computer, Inc. Microsoft, Windows, WindowsNT, WindowsServer, WindowsVista, MS Windows, Active Directory, Internet Explorer, Outlook, SQL Server, VisualSourceSafe, and VisualStudio are either registered trademarksor trademarksof Microsoft Corporation in the United Statesand/or other countries. Linuxisa trademarkof LinusTorvalds. Red Hat, Red Hat Enterprise Linux, and Fedora are registered trademarksof Red Hat, Inc. in the United Statesand other countries. SUSE isa registered trademarkof NovellInc. in the United Statesand other countries. Debian isa registered trademarkof Software in the PublicInterest, Inc. Ubuntu isa registered trademarkof CanonicalLtd. IBM, ClearCase, and allother IBM brand and product namesare service marks, trademarksor registered trademarksof IBM Corporation or itssubsidiariesin the United Statesand other countries. Oracle isa registered trademarkof Oracle Corporation and/or itsaffiliates. PVCS, Serena PVCS ProfessionalSuite, and Serena PVCS Version Manager are registered trademarksof Serena Software, Inc. Allother product namesmentioned herein are the trademarksof their respective owners. Allother trademarksare the propertyof their respective owners. No part of thispublication maybe reproduced, transmitted, transcribed, stored in a retrievalsystem, or translated into anylanguage in anyform byanymeanswithout the written permission of Seapine Software, Inc. Your license agreement with Seapine Software, Inc., which isincluded with the product, specifiesthe permitted and prohibited usesof the product. Anyunauthorized duplication or use of thissoftware, in whole or in part, in print, or in anyother storage and retrievalsystem is forbidden. Information in thisdocument issubject to change without notice and doesnot represent a commitment on the part of Seapine Software, Inc. Unlessotherwise noted, allcompanies, products, street addresses, and personscontained herein are purelyfictitious. Mention of third-partycompaniesand productsisfor informationalpurposesonlyand doesnot constitute an endorsement. Seapine Software, Inc. 6960 Cintas Boulevard Mason, OH 45040 (513) 754-1655 [email protected] Contents What's New 1 Getting Started 3 Starting Surround SCM 4 Managing server connections 4 Adding server connections 5 Editing server connections 6 Deleting server connections 6 Surround SCM interface 7 Branch menu 8 Branches tree 8 Repositories tree 8 Source file list 8 File details pane 8 Activity log 8 Pending changelists 8 Setting general user options 9 Changing your password 10 Managing Working Directories 11 Setting working directories for repositories 11 Configuring working directories 12 Adding working directories 12 Editing working directories 13 Deleting working directories 13 Opening working directories 14 Setting the file manager on Linux 14 Getting and Viewing Files 15 Getting files 15 Understanding file status 17 Viewing files in Surround SCM 17 Setting viewer/editor options 17 Editing viewer/editor settings 18 Deleting viewer/editor settings 19 Changing the internal viewer/editor text options 19 Opening local files from Surround SCM 19 i Modifying Files 21 Checking out files 21 Creating local directories 22 Undoing check out 23 Editing files in Surround SCM 24 Checking in updated files 24 Rolling back files 27 Adding files to Surround SCM 28 Setting custom fields 32 Changing multiple custom fields 33 Changing workflow states 34 Moving files 35 Renaming files 36 Removing files 36 Restoring removed files 37 Deleting files permanently 38 Comparing and Merging Files 41 Viewing file differences 41 Merging files 43 Merging unrelated files 44 Generating file differences reports 46 Viewing image file differences 47 Setting diff/merge options 49 Configuring diff application options 49 Configuring merge application options 50 Editing diff/merge application options 51 Deleting diff/merge application options 52 Configuring diff/merge application settings 52 Performing Code Reviews 55 About the code review process 55 Understanding code review status 56 Managing code reviews 57 Creating code reviews 58 Adding files to code reviews 59 Selecting code reviews 63 ii Removing files from code reviews 63 Starting code reviews 63 Opening code reviews 64 Editing code reviews 65 Reviewing files in code reviews 65 Reviewing changes between file versions 66 Reviewing files 68 Adding review comments to files 69 Editing and deleting review comments 70 Addressing code review comments 70 Viewing unaddressed review comments 71 Searching for code reviews 71 Viewing code reviews files are included in 72 Deleting code reviews 72 Viewing File Information 75 Using the file details pane 75 Viewing line-by-line file changes 76 Working with annotate results 77 Viewing file history 78 Viewing file history details 80 Viewing graphical file history 81 Viewing general file information 82 Viewing check out file information 82 Viewing shared file information 83 Viewing file custom field information 83 Setting Up Email Notifications 85 Adding email notifications 85 Editing email notifications 88 Duplicating email notifications 88 Disabling and enabling email notifications 88 Deleting email notifications 88 Customizing Surround SCM 91 Customizing the Source Tree window 91 Setting Source Tree options 92 Setting file information display options 93 iii Customizing shortcut menus 94 Customizing toolbars 95 Changing the user interface mode 96 Changing defaults for Surround SCM dialogs 97 Setting Get Files dialog defaults 97 Setting Check In Files dialog defaults 98 Setting Check Out Files dialog defaults 99 Setting Undo Check Out Files dialog defaults 100 Setting Add Files dialog defaults 100 Grouping file extensions 101 Adding file extension groups 102 Setting Shelve Files dialog defaults 103 Managing Repositories 105 Creating repositories 105 Viewing differences between repositories and working directories 106 Resolving missing moved and renamed items 109 Pushing changes to repositories 109 Renaming repositories 111 Moving repositories 112 Cloaking and uncloaking repositories 112 Viewing cloaked repositories 113 Removing repositories 114 Restoring repositories 115 Deleting repositories permanently 115 Sharing Files Between Repositories 117 Breaking shares 118 Viewing Repository Information 119 Viewing repository history 119 Viewing general repository information 120 Viewing repository shadow folders 121 Using Changelists 123 Creating changelists 123 Adding file actions to changelists 124 Managing changelists 124 Viewing changelist details 125 iv Working with pending changelists 125 Renaming changelists 127 Removing changelists 128 Editing changelist file actions 128 Moving changelist actions 128 Removing changelist file actions 129 Adding comments to changelist files 129 Committing pending changelists 130 Working with committed changelists 130 Searching for committed changelists 131 Viewing changelist file differences 132 Merging changelist files 133 Rolling back changelist actions 135 Rollback changelist action resolutions 137 Selecting changelists 139 Using Labels 141 Configuring labels 141 Creating labels 143 Viewing labels 144 Editing labels 144 Duplicating labels 145 Hiding labels 145 Deleting labels 145 Labeling files 146 Selecting labels 147 Searching for labels 147 Viewing label differences 148 Viewing label history 149 Generating labeled files reports 150 Removing labels from files 151 Using Shelves 153 Shelving files 153 Adding files to existing shelves 155 Managing shelves 156 Creating shelves 157 v Editing shelves 158 Deleting shelved files and shelves 158 Viewing shelved file differences 158 Unshelving files 159 Branching 161 About branches 161 When to branch 162 Branching example 163 Creating branches 165 Using branch templates 167 Including and excluding repositories for new branches 168 Selecting branch templates 169 Merging Files Between Branches 171 Deciding between promoting, rebasing, and duplicating 171 Viewing branch differences 171 Copying files across branches during check in 174 Generating branch differences reports 175 Promoting branches 178 Promote preview 180 Promote actions 182 Promoting files 183 Rolling back promoted files 186 Rebasing branches 187 Rebase preview 190 Rebase actions 191 Rebasing files 192 Rolling back rebased files 195 Duplicating selected changes across branches 196 Duplicate changes preview 198 Duplicate changes actions 199 Tracking duplicated changes 199 Viewing Branch Information 201 Viewing branch history 201 Viewing branch history details 201 Viewing general branch information 202 vi Viewing