Surround SCM User Guide V2016.1
Total Page:16
File Type:pdf, Size:1020Kb
Surround SCM User Guide Version 2016.1 Copyrights © 2016 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 3 Managing server connections 4 Adding server connections 5 Editing server connections 6 Deleting server connections 6 Surround SCM interface 7 Setting general user options 8 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 14 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 file viewer and editor options 18 Setting the application for viewing and editing specific file types 18 Editing and deleting file viewer and editor settings 20 Changing file viewer and editor text display options 20 Opening local files from Surround SCM 21 Modifying Files 23 Checking out files 23 Creating local directories 25 Undoing check out 25 Editing files in Surround SCM 26 Checking in updated files 26 Rolling back files 29 Adding files to Surround SCM 30 i Setting custom fields 34 Changing multiple custom fields 35 Changing workflow states 36 Entering electronic signatures 37 Moving files 37 Renaming files 38 Removing files 39 Restoring removed files 40 Deleting files permanently 40 Comparing and Merging Files 43 Viewing file differences 43 Merging files 45 Merging unrelated files 46 Running file differences reports 48 Viewing image file differences 50 Setting diff/merge options 51 Adding diff/merge applications 51 Editing diff/merge applications 53 Deleting diff/merge applications 54 Configuring diff/merge application settings 54 Performing Code Reviews 57 About the code review process 57 Understanding code review status 59 Managing code reviews 60 Creating code reviews 61 Adding files to code reviews 62 Selecting code reviews 65 Removing files from code reviews 66 Starting code reviews 66 Opening code reviews 67 Editing code reviews 67 Reviewing files in code reviews 68 Reviewing changes between file versions 68 Reviewing files 70 Adding review comments to files 72 ii Editing and deleting review comments 72 Addressing code review comments 73 Viewing unaddressed review comments 73 Searching for code reviews 74 Running code review reports 75 Viewing code reviews files are included in 78 Deleting code reviews 79 Viewing File Information 81 Using the file details pane 81 Viewing line-by-line file changes 82 Working with annotate results 83 Viewing file history 84 Viewing file history details 86 Viewing graphical file history 87 Viewing file properties 88 Setting Up Email Notifications 91 Adding email notifications 91 Editing email notifications 94 Duplicating email notifications 94 Disabling and enabling email notifications 94 Deleting email notifications 94 Customizing Surround SCM 97 Customizing the Source Tree window 98 Setting Source Tree options 99 Setting file information display options 100 Customizing shortcut menus 101 Customizing toolbars 102 Changing the user interface mode 103 Changing defaults for Surround SCM dialogs 103 Setting Get Files dialog defaults 104 Setting Check In Files dialog defaults 105 Setting Check Out Files dialog defaults 106 Setting Undo Check Out Files dialog defaults 106 Setting Add Files dialog defaults 107 Grouping file extensions to find related file types 108 iii Setting Shelve Files dialog defaults 109 Managing Repositories 111 Creating repositories 111 Viewing differences between repositories and working directories 112 Resolving missing moved and renamed items 115 Pushing changes to repositories 116 Renaming repositories 117 Moving repositories 118 Cloaking and uncloaking repositories 119 Viewing cloaked repositories 120 Removing repositories 120 Restoring repositories 121 Deleting repositories permanently 122 Sharing Files Between Repositories 125 Breaking shares 126 Viewing Repository Information 127 Viewing repository history 127 Viewing general repository information 128 Viewing repository shadow folders 129 Using Changelists 131 Creating changelists 131 Adding file actions to changelists 132 Managing changelists 132 Viewing changelist details 133 Working with pending changelists 134 Renaming pending changelists 136 Removing pending changelists 136 Editing pending changelist file actions 137 Moving pending changelist actions 137 Removing pending changelist file actions 137 Adding comments to changelist files 138 Committing pending changelists 138 Working with committed changelists 138 Searching for committed changelists 140 Attaching changelists and files to TestTrack items 141 iv Rolling back changelist actions 144 Rollback changelist action resolutions 145 Selecting changelists 147 Using Labels 149 Configuring labels 149 Creating labels 151 Viewing labels 152 Editing labels 152 Duplicating labels 153 Hiding labels 154 Deleting labels 154 Labeling files 154 Selecting labels 155 Searching for labels 156 Viewing label differences 157 Viewing label history 158 Running labeled files reports 159 Removing labels from files 160 Using Shelves 161 Shelving files 161 Adding files to existing shelves 163 Managing shelves 164 Creating shelves 165 Editing shelves 166 Deleting shelved files and shelves 166 Viewing shelved file differences 166 Unshelving files 167 Branching 169 About branches 169 When to branch 170 Branching example 171 Branch status icons 173 Creating branches 174 Using branch templates 176 Including and excluding repositories for new branches 177 v Selecting branch templates 178 Merging Files Between Branches 181 Deciding between promoting, rebasing, and duplicating 181 Viewing branch differences 181 Copying files across branches during check in 184 Running branch differences reports 185 Promoting branches 188 Promote preview 190 Promote actions 192 Promoting files 193 Rolling back promoted files 196 Rebasing branches 197 Rebase preview 200 Rebase actions 201 Rebasing files 202 Rolling back rebased files 205 Duplicating selected changes across branches 206 Duplicate changes actions 209 Tracking duplicated changes 209 Viewing Branch Information 211 Viewing branch history 211 Viewing branch history details 211 Viewing general branch information 212 Viewing the graphical branch tree 213 Finding Files 215 Searching for files 215 Adding restrictions 217 Adding text restrictions 218 Using regular expressions 218 Adding