Đang tải... (xem toàn văn)
Phần mềm quản lý hệ thống source code Starteam server hướng dẫn cài đặt Cài đặt StarTeam Server , cấu hình , sử dụng . .
StarTeam ® Getting Started Guide ® Borland Borland Software Corporation 100 Enterprise Way, Scotts Valley, CA 95066-3249 www.borland.com Revision History August 15, 2001 May 15, 2002 June 6, 2003 November 7, 2003 StarTeam StarTeam StarTeam StarTeam 5.1 5.2 5.3 5.4 Copyright Notice Made In Borland® Copyright © 1995-2003 Borland Software Corporation All rights reserved All Borland brand and product names are trademarks or registered trademarks of Borland Software Corporation in the United States and other countries All other marks are the property of their respective owners Corporate Headquarters: 100 Enterprise Way, Scotts Valley, CA 95066-3249 • 831-431-1000 • www.borland.com • Offices in: Australia, Brazil, Canada, China, Czech Republic, France, Germany, Hong Kong, Hungary, India, Ireland, Italy, Japan, Korea, the Netherlands, New Zealand, Russia, Singapore, Spain, Sweden, Taiwan, The United Kingdom, and the United States Contents Preface v StarTeam Manuals v StarTeam Online Documentation vi Contents of the StarTeam Installation CD vii Contacting Borland Support viii Documentation Conventions ix Chapter 1: Introduction to StarTeam Components of StarTeam What Is Version Control? What Is a Change Request? What Is a Requirement? .3 What Is a Task? What Are Topics? What Is the Audit Log? How to Use the Getting Started Guide Chapter 2: StarTeam for Administrators Configuring the StarTeam Server Creating a Server Configuration Modifying a Server Configuration 13 Starting and Stopping a Server Configuration 20 Creating a StarTeam Project 21 What Is a Project? .21 Before Creating a Project 22 Creating a Project 23 After Creating a Project 27 Adding Files to a Project View 28 Creating Additional Project Views .32 Creating Branching Views 34 Creating View Labels 39 Using Promotion States 41 Promoting a View Label to the Next State 44 Customizing Item Properties 47 Changing a Property Field 47 Translating a Custom Field 51 Adding Groups .53 Contents iii Adding Users 55 Setting Access Rights 58 Viewing the Audit Log 66 Chapter 3: StarTeam for Users 69 Learning to Use StarTeam 70 Starting StarTeam 70 Adding a Server Configuration 71 Logging onto StarTeam 74 Opening an Existing Project 75 Using the Project View Window 78 Understanding StarTeam Folders 80 Adding a Folder to the StarTeam Hierarchy 80 Modifying Folder Properties 86 Placing a File under Version Control 87 Adding Files 88 Modifying a File to Create a New Revision 91 Reviewing Revision History 100 Comparing File Revisions 101 Checking Out a Prior Revision 103 Deleting a Folder from the Sample Project 105 Working with Change Requests 105 Creating a Change Request 105 Resolving a Change Request 108 Creating Topics and Responses 109 Creating a Link 115 Deleting Items from the Sample Project 117 Creating a Chart 118 Creating a Report 120 Index 123 iv StarTeam Getting Started Guide Preface StarTeam Manuals The StarTeam documentation set explains how to use the applications in the StarTeam product suite Not all of the applications described in the manuals may be on your system, as this depends on the StarTeam products your company has licensed and installed StarTeam Installation Guide Provides step-by-step instructions on installing the StarTeam products and the system requirements for each product StarTeam Getting Started Guide Presents an overview of StarTeam and tutorials on configuration management Chapter 2: StarTeam for Administrators explains how to perform essential administrative functions, such as configuring a server and adding users and groups Chapter 3: StarTeam for Users explains the StarTeam features most often used by team members in their daily work, such as checking files in and out, sending messages, etc StarTeam User’s Guide Supplies detailed information on using StarTeam to track and manage changes to files, share files among team members, access prior versions of a file, and other functions Also explains how to use change requests, requirements, topics, and tasks StarTeam Administrator’s Guide Describes the steps required to configure and maintain the StarTeam Server; create and maintain StarTeam objects, and manage user access Includes information on the use of the StarTeam Server with existing PVCS and Visual SourceSafe files StarTeam Extensions User’s Guide Explains how to design and manage StarFlow Extensions, such as alternate property editors (APEs) Also covers StarFlow Designer and StarFlow Notification Agent Preface v StarTeamMPX Server Administrator’s Guide Supplies information on the basic operation and architecture of a StarTeamMPX Server system, including installation and configuration instructions StarDisk User’s Guide Explains the process of installing and using the StarDisk client, a virtual file system that enables you to access files managed by StarTeam Server from Windows-based applications—such as Microsoft® Windows® Explorer or Netscape® StarTeam Online Documentation Installing StarTeam also places online versions of the StarTeam manuals in the Online Documentation folder of StarTeam or the StarTeam Server The following table lists the StarTeam online manuals and their file names The online manuals you receive depend upon the StarTeam products your company has licensed and the StarTeam client you have installed File Name StarTeam Manual install.pdf StarTeam Installation Guide start.pdf StarTeam Getting Started Guide user.pdf StarTeam User’s Guide admin.pdf StarTeam Administrator’s Guide workflow.pdf StarTeam StarFlow Extensions Guide adminMPX.pdf StarTeamMPX Server Administrator’s Guide stardisk.pdf StarDisk User’s Guide (Windows client only) Important The online manuals are distributed in Adobe’s portable document format (.pdf) and require version 4.0 or higher of Adobe Acrobat Reader to display them The installation program for Adobe Acrobat Reader is located in the \Docs folder of the StarTeam Installation CD The free reader is also available from the Adobe Web site at www.adobe.com vi StarTeam Getting Started Guide Contents of the StarTeam Installation CD The StarTeam installation CD contains the following folders: Folder Contents \Client Files necessary to install StarTeam \Docs Online (.pdf) versions of this and other manuals, plus the Adobe Acrobat Reader installer \Extras Copies of Guiffy (a comparison and merge utility) and OpenMake (a build utility) \MPX Files necessary to install StarTeamMPX Server The MPX Server requires a specific license \Readme StarTeam readme files, which provide an overview of all of the products, including a list of new features \Server Files necessary to install StarTeam Server, which provides client/server access to StarTeam projects \StarDisk Files necessary to install StarDisk, which extends Windows Explorer to include StarTeam’s version control system StarTeam requires a specific license for this product, but an evaluation is available \StarGate Files needed to install StarGate Runtime \Utility Files for DAO, ODBC, Java VM, and Winsock, each in its own folder You may need to reinstall your drivers from this location if another software application installed after StarTeam overwrites the drivers with ones incompatible with StarTeam Another child folder contains SQL scripts for use with Oracle databases Preface vii Contacting Borland Support Borland is committed to providing world-class services in the area of consulting and technical support We have over 15 years of experience in supporting developers and enterprise customers Our qualified technical support engineers are prepared to handle your support needs on a caseby-case basis or in an ongoing partnership Borland provides support worldwide, delivering timely, reliable service to ensure every customer’s business success For more information about Borland's support services, please see our Web site at http://support.borland.com From the Web site, you can also access many newsgroups where users exchange information, tips, and techniques See http://info.borland.com/newsgroups/ for the latest list of free product newsgroups Also available on the Internet is the Borland Developer Network site at http://community.borland.com The Borland Community provides access to product specific information, articles, code examples, and news When contacting support, be prepared to provide complete information about your environment, the version of the product you are using, and a detailed description of the problem For support on third-party tools or documentation, contact the vendor of the tool viii StarTeam Getting Started Guide Documentation Conventions This Guide uses the following documentation conventions Select File > Exit Indicates cascading menu commands In this case, select File from the menu bar, then select Exit from the drop-down menu Fixed-Space Font Identifies information that must be entered; also used for messages from the system italics Indicates manual titles, names of dialogs, and information that should be replaced with the names of your files, child folders, etc Bold Highlights menu names, options, buttons, or fields; also used for new terms or items requiring special attention [ Surrounds optional syntax | ] Separates mutually exclusive choices Note Identifies supplemental information Tip Identifies information on alternative procedures or other helpful but nonessential information Important Identifies information that is essential to the completion of a task Caution Identifies actions that may result in loss of data or procedures that must be followed to ensure that data is not lost Preface ix x StarTeam Getting Started Guide Your new topic appears on the bottom line in the upper pane of the project view window Note Topics have many additional features that increase their flexibility and value to users For example, by using the Attachments tab, you can send a picture or additional information along with your message To respond to a topic: On the topic tree, highlight the topic you just created Chapter 3: StarTeam for Users 113 Select Respond from the Topic or context menu The New Topic dialog appears Enter the title of your response in the Title text box Enter your response in the Content text box 114 StarTeam Getting Started Guide Click OK The response appears as a child of the topic in the upper pane of the project view window Creating a Link In StarTeam, an item is a file, change request, requirement, task, or topic A link is a connection between two folders, two items, or a folder and an item Creating links can be quite useful For example, linking a file to a change request allows you to mark it as fixed when you check in the edited file By linking files to the requirements document that the files fulfill, you can easily refer to or update the document To view the links for a selected item, use the Link tab on the lower pane To view the links for a selected folder, select Folder > Properties, then the Link tab The following exercise uses the topic you created and links it to a change request created in an earlier exercise Chapter 3: StarTeam for Users 115 To link one item to another: On the Topic tab, select the topic you created Link Mouse Pointer Select the Link button from the toolbar The button now looks as though it has been pushed down, and the mouse pointer looks like a knotted rope On the Change Request tab, select the change request you created Select the Link button from the toolbar The toolbar button and the mouse pointer will return to normal To see the results, select one of the connected items, then look at the Link tab Information about the link will appear in the lower pane If you want to link several items of the same type (for example, change requests) to a single item of a different type (for example, a file), you can create all the links at the same time Simply select the change requests on the upper pane, then use the Link icon to connect them to the specific file 116 StarTeam Getting Started Guide Tips To use a folder as the beginning of a link, select Folder > Links > Create Link To use it as the end of a link, select Folder > Links > Complete Link To cancel a link after you have started to create it, select Links > Cancel Link from any of the component menus or from one of their context menus If you are using the Link button on the toolbar, press Esc Deleting Items from the Sample Project To restore the sample project to its original state and enable the next user to follow the exercises, you should delete the change request, topic and response, and link that you have created To delete the link: Select the Links tab On the lower pane, select the link you created and right click A context menu opens Select Delete from the menu (or simply press the Delete key on the keyboard) A message asks you to confirm the deletion Click OK To delete the change request: Select the Change Request tab On the upper pane, select the change request you created Select Change Request > Delete from the menu bar or context menu A message asks you to confirm the deletion Click OK To delete the topic and response: Select the Topics tab from the upper pane On the upper pane, select the topic you created Select Topic > Delete from the menu bar or context menu A message asks you to confirm the deletion Click OK StarTeam deletes the tree created by your topic and response Chapter 3: StarTeam for Users 117 Creating a Chart With StarTeam, you can create charts for files, change requests, requirements, topics, tasks, and audit log entries Charts are based on the data displayed in the upper pane Therefore, before creating a chart, you must adjust the display in the upper pane to fit the chart’s purpose, then select the items that you want to chart In this exercise, you will create a chart of file sizes To create a chart of file sizes: Select the root folder from the StarTeam folder hierarchy Select the File tab All Descendants Select All Descendents from the drop-down menu or click All Descendants on the toolbar Select Charts > Simple from the File menu or context menu The Simple Chart dialog appears Enter a name for your chart in the Chart name text box Select Size from the Series list box 118 StarTeam Getting Started Guide Choose Select All from the Create chart for group box Select Landscape from the Printer page orientation group box Select OK to display a chart of file sizes You can create a variety of charts with StarTeam, including: z Simple charts to create local size or content versions for all or selected items z Correlation charts to display X and Y coordinates for content version vs local size z Time-series charts to display items for a specified date and time range using local time stamp information z Distribution charts to display items you have grouped and sorted in the file list Chapter 3: StarTeam for Users 119 Creating a Report StarTeam allows you to create reports on files, change requests, requirements, topics, tasks, and the audit log It uses HTML templates to generate reports via your Web browser In this example, you will create a File Detail report, which lists files and their revision histories To create a report showing file details: Select the root folder from the StarTeam folder hierarchy Select the File tab All Descendants Select All Descendants from the drop-down menu or click All Descendants on the toolbar Select a folder or several files on the upper pane Select File > Reports The Reports dialog appears Select Detail from the Available reports group box Select Current selection from the Create report for group box In the Output file name text box, enter or browse for the location in which you want to store the report Be sure to use htm or html as the extension 120 StarTeam Getting Started Guide Enter a name for the report in the Report title text box 10 Do one of the following: z Click Generate to view the report Your web browser will open and display your report z Click Print to print the report as it would appear in the browser This command works only if your computer has a “print” action file association for the htm extension Tip You can print a Detail Report by selecting Print from the File, Change Request, Requirement, Task, Topic, or Audit menu Congratulations! You have successfully completed the basic exercises for StarTeam users However, this guide provides only a brief overview of StarTeam’s flexible, customized solution For complete instructions on additional functions and advanced features, consult the StarTeam User’s Guide Chapter 3: StarTeam for Users 121 122 StarTeam Getting Started Guide Index A accessing servers 24 access rights granting 58 project 58 setting up 58 summary at project level 66 views 61 adding groups 53 server description 24 users 53, 55 administrators getting started audit logs 66 viewing 66 Audit tab 67 audit trail 66 B blank branching view 34 blue changed text color 102 branching all 35 none 35 branching view 34 branching views 34 blank 34 creating 34 build labels type of view labels 41 C categories 106 CD contents vii change requests Category field 106 Component field 106 creating 105 defect type 106 deleting 117 Description field 107 Fix field 109 linking 115 resolving 108 responsibility 107 suggestion type 106 synopsis 106 workflow 108 changing files 91 working files 94 charts creating 118 simple chart 118 check in new version 95 checking in revisions 95 checking out files 92 codes colors in Visual Diff 102 colors Visual Diff 102 comparing file revisions 101 comparison color code 102 StarTeam view window and working folder window 22 complete link 116 components 106 compression 31, 90, 98 configuration creating configurations floating 38 convention fixed-space type ix creating branching views 34, 35 change requests 105 charts 118 enumerated type 50 folders 81 links 115 projects via New Project wizard 23 promotion states 42 Index 123 property fields 47 reports 120 server configuration StarTeam projects 21 topics 110 view labels 39, 40 views 32 creating fields creating property 47 custom field translating 51 customization 47 creating property fields 47 D default editor 94 default view 33 default working folder 37 defect change request type 106 defects entering 105 deleting change requests 117 folders 105 links 117 topics 117 working files 31, 90, 97 deltas 31, 90, 98 descriptions change requests 107 detail reports printing 121 developer support viii differences color codes 102 displaying history list 100 changing 91, 94 checking in 95 checking out 92 comparing file revisions 101 compression 31, 90, 98 deltas 31, 90, 98 editing 91, 94 linking 115 locking 96 modifying 91, 94, 95 Not In View 29 revision number 100 unlocking 96 fixed-space type convention ix fixing change requests 108 floating configurations 38 folder default working 37 defined 69 folder hierarchy 80 explained 27 folder properties modifying 86 folders creating 81 deleting 105 deleting working files 31, 90, 97 linking 115 overview 80 properties 86 full revision storage 31, 90, 98 G editing files 91 working files 94 endpoint 24 enumerated creating types 50 exclusive lock 30, 89 getting started for administrators overview team members 69 granting access rights 58 gray matching text color 102 green inserted text color 102 groups adding 53 F H E files 124 StarTeam Quick Start Guide hierarchy explained 27 history 100 file revision 100 history list displaying 100 HTML report templates 120 I icons property fields 47 installation CD contents vii item properties customizing 47 items linking 115 L labels creating 40 left panes 78 linking items 115 links creating 115 deleting 117 locking files 96 lock status 30, 89 logon 57 logs audit 66 lower pane explained 78 M modifying files 91 folder properties 86 working files 94 modifying files 95 N name logon 57 New Folder wizard 81 non-exclusive lock 30, 89 Notepad default editor 94 Not In View file status 29 O opening StarTeam project 71 Open Project wizard 72 output file 120 overview folders 80 software configuration management StarTeam 1, P printing detail reports 121 reports 121 product support viii project access rights 58 adding files 88 defined 69 project level access rights summary 66 projects creating via New Project wizard 23 project views 32 promoting view labels 44 view label to the next state 44 promotion states creating 42 property field enumerated type 50 property fields 47 creating enumerated types 50 icons 47 R read/only rollback view 34 read/write reference view 33 read-only reference view 33 read-only view 33 red deleted text color 102 reference views read-only 33 reports Index 125 creating 120 HTML templates 120 output file 120 printing 121 repository customization 47 creating property fields 47 resolving change requests 108 responding to topics 113 responses topics 113 Responsibility change requests 107 revision history reviewing 100 revision number 100 revisions checking in 95 comparing 101 rollback view 34 S security 58 server adding configuring server configuration creating defined server descriptions adding 24 servers accessing 24 setting up access rights 58 simple chart 118 StarTeam 71 benefits of using opening projects 71 StarTeam folder hierarchy explained 27 StarTeam project add files 88 StarTeam window explained 77 starting 71 StarTeam 71 states promotion 42 storage 126 StarTeam Quick Start Guide full revision 31, 90, 98 store versions as deltas 31, 90, 98 storing reports 120 submitting change requests 105 suggestion change request type 106 support viii Synopsis change requests 106 T tasks linking 115 team members getting started 69 technical support viii templates reports 120 threaded conversations explained Topic component topic discussions topics creating 110 deleting 117 explained 109 linking 115 responding 113 U unlocking files 96 upper pane explained 78 users adding 53, 55 V vault folder location VC Version Control version control explained 87 version history 100 view defined 69 view labels build labels 41 creating 39, 40 promoting 44 views access rights 61 blank branching view 34 branch all 35 branching 34, 35 branching your baseline 34 branch none 35 creating 32 default 33 floating configurations 38 promoting labels 44 purposes of 21, 32 read/only rollback 34 read/write reference 33 read-only 33 read-only reference 33 view window explained 78 Visual Diff default color codes 102 W wizards New Project 23 workflow change requests 108 working files checking in revisions 95 deleting 31, 90, 97 editing 94 working folder defined 69 Index 127