The Sun WorkShop TeamWare User's Guide describes how to use the Sun(TM) Workshop(TM) TeamWare code management tools. The concepts and information discussed apply to both command line and graphical user interfaces.
This manual is intended for the software developer, but also addresses integrators, administrators, and release engineers in their tasks involving code management.
As a software developer, you typically acquire code from a code integration area or integration workspace. You then:
Add new features to your program module
Test and debug the program
Put the code back in the implementation or integration workspace from which it was acquired
The descriptions of the Configuring tool are primarily addressed to the software developer, but also address the needs of integrators, administrators, and release engineers.
Use the chapters on Versioning and Freezepointing if you write programs coded in ASCII text source. These chapters assume that you are familiar with programming constructs and processes. You need not have previous experience with the Source Code Control System (SCCS).
The Building and DistributedMake chapters are a supplement to the standard make documentation. They describe how to use Building and Distributed Make to make the process of building programs more efficient. Use these chapters if you maintain programs using the make utility and wish to speed up the build process. These chapters also assume that you are familiar with the standard make utility.
This manual assumes some understanding of the Solaris(TM) operating environment and UNIX\256 commands.
Chapter 1, QuickStart" provides instructions for quickly getting started using the Sun WorkShop TeamWare code management tools.
Chapter 2, Introduction" provides a full introduction to the Sun WorkShop TeamWare product, and provides you with ways to get the best information.
Chapter 3, Introduction to TeamWare Configuring" presents an overview of the Configuring utility in TeamWare. Basic concepts are discussed that are vital to understanding how Configuring works.
Chapter 4, Introduction to Merging" presents an overview of the Merging utility in TeamWare, and describes the graphical interface.
Chapter 5, Starting a Project" presents information on how to start a new project, and how to move existing work projects into the TeamWare environment.
Chapter 6, TeamWare Configuring User Interfaces" describes the Configuring user interfaces.
Chapter 7, TeamWare Configuring Workspace" describes the Configuring workspace and the associated commands.
Chapter 8, Copying Files between Workspaces" describes the TeamWare Configuring transactions used to transfer files between workspaces.
Chapter 9, Resolving Conflicts" explains how you resolve conflicts between files in parent and child workspaces.
Chapter 10, How Configuring Merges SCCS Files" describes how TeamWare Configuring manipulates SCCS history files during file transfer transactions.
Chapter 11, Configuring Example" contains an example that demonstrates the TeamWare Configuring bringover, putback, and resolve transaction cycle.
Chapter 12, Performing Basic SCCS Functions with Versioning" describes common SCCS functions such as checking out and editing a file, checking in a new file, and displaying delta differences, using the Versioning utility. It covers the basic operational tasks and walks you through step-by-step instructions.
Chapter 13, Starting Merging and Loading Files" presents Merging, a tool that allows you merge files to resolve conflicts. It provides an introduction to the graphical interface and a tour of the command line options.
Chapter 14, Examining Differences" examines the process of using Merging to resolve differences between files, including automatic merging, and provides a detailed example.
Chapter 15, Preserving Project State With Freezepointing" presents Freezepointing, a tool that allows you to create snapshots of a project. It provides an overview of the graphical interface and shows you how to use this tool in conjunction with the other TeamWare development tools.
Chapter 16, Troubleshooting Versioning and FreezePointing" provides a problem checklist to consider before calling the Sun Support hotline. It also gives information on how to report a problem, as well as a list of error messages--their meanings and what to do next.
Chapter 17, Building Programs in Sun Workshop TeamWare" presents a discussion of the build process with specific targets, as well as hints on fixing build errors.
Chapter 18, Using the dmake Utility" describes dmake, a tool that allows you to distribute builds over several hosts concurrently. The operation of dmake is described, and instructions given on how to distribute your build efficiently.
Chapter 19, Error and Warning Messages" lists TeamWare Configuring error messages and warnings. Each message is defined, and a possible remedy is provided.
"Glossary" provides a clear explanation of the special terms used in this manual.
Appendix A, About SCCS Mergeable IDs" explains why SCCS Mergeable IDs (SMIDs) are necessary, how to translate SCCS delta IDS (SIDs) to SMIDs, and how to translate SMIDs to SIDs.
The name of the latest Solaris operating environment release is Solaris 7 but code and path or package path names may use Solaris 2.7 or SunOS 5.7.
The Sun(TM) WorkShop(TM) documentation applies to Solaris 2.5.1, Solaris 2.6, and Solaris 7 operating environments on:
The SPARC(TM) platform
The x86 platform, where x86 refers to the Intel implementation of one of the following: Intel 80386, Intel 80486, Pentium, or the equivalent
The term "x86" refers to the Intel 8086 family of microprocessor chips, including the Pentium, Pentium Pro, and Pentium II processors and compatible microprocessor chips made by AMD and Cyrix. In this document, the term "x86" refers to the overall platform architecture. Features described in this book that are particular to a specific platform are differentiated by the terms "SPARC" and "x86" in the text.
The following Sun manuals and guides provide additional useful information:
Sun WorkShop Quick Install provides installation instructions.
Sun WorkShop Installation and Licensing Reference provides supporting installation and licensing information.
Using Sun WorkShop gives information on performing development operations through Sun WorkShop.
Debugging a Program With dbx provides information on using dbx commands to debug a program.
Analyzing Program Performance with Sun WorkShop describes the profiling tools; LoopTool, LoopReport, LockLint utilities; and use of the Sampling Analyzer to enhance program performance.
Sun WorkShop Visual User's Guide describes how to use Visual to create C++ and Java(TM) graphical user interfaces.
The Solaris Linker and Libraries Guide gives information on linking and libraries.
The Solaris Programming Utilities Guide provides information for developers about the special built-in programming tools available in the SunOS(TM) system.
The SunDocsSM program provides more than 250 manuals from Sun Microsystems, Inc. If you live in the United States, Canada, Europe, or Japan, you can purchase documentation sets or individual manuals using this program.
For a list of documents and how to order them, see the catalog section of the SunExpress(TM) Internet site at http://www.sun.com/sunexpress.
Sun WorkShop documentation is available online from several sources:
The docs.sun.com Web site
AnswerBook2TM collections
HTML documents
Online help and release notes
The docs.sun.com Web site enables you to access Sun technical documentation online. You can browse the docs.sun.com archive or search for a specific book title or subject. The URL is http://docs.sun.com.
The Sun WorkShop documentation is also available using AnswerBook2 software. To access the AnswerBook2 collections, your system administrator must have installed the AnswerBook2 documents during the installation process (if the documents are not installed, see your system administrator or Chapter 3 of Sun WorkShop Quick Install for installation instructions). For information about accessing AnswerBook2 documents, see Chapter 6 of Sun WorkShop Quick Install, Solaris installation documentation, or your system administrator.
To access AnswerBook2 documents, Solaris 2.5.1 users must first download AnswerBook2 documentation server software from a Sun Web page. For more information, see Chapter 6 of Sun WorkShop Quick Install.
The following Sun Workshop documents are available online only in HTML format:
Tools.h++ Class Library Reference
Tools.h++ User's Guide
Numerical Computation Guide
Standard C++ Library User's Guide
Standard C++ Class Library Reference
Sun WorkShop Performance Library Reference Manual
Sun WorkShop Visual User's Guide
Sun WorkShop Memory Monitor User's Manual
To access these HTML documents:
Open the following file through your HTML browser:
install-directory/SUNWspro/DOC5.0/lib/locale/C/html/index.html
Replace install-directory with the name of the directory where your Sun WorkShop software is installed (the default is /opt).
The browser displays an index of the HTML documents for the Sun WorkShop products that are installed.
Open a document in the index by clicking the document's title.
This release of Sun WorkShop includes an online help system as well as online manuals. To find out more see:
Online Help. A help system containing extensive task-oriented, context-sensitive help. To access the help, choose Help Help Contents. Help menus are available in all Sun WorkShop windows.
Release Notes. The Release Notes contain general information about Sun WorkShop and specific information about software limitations and bugs. To access the Release Notes, choose Help Release Notes.
The following table describes the typographic changes used in this book.
Table P-1 Typographic Conventions
Typeface or Symbol |
Meaning |
Example |
---|---|---|
AaBbCc123 |
The names of commands, files, and directories; on-screen computer output |
Edit your .login file. Use ls -a to list all files. machine_name% You have mail.
|
AaBbCc123 |
What you type, contrasted with on-screen computer output |
machine_name% su Password: |
AaBbCc123 |
Command-line placeholder: replace with a real name or value |
To delete a file, type rm filename. |
AaBbCc123 |
Book titles, new words or terms, or words to be emphasized |
Read Chapter 6 in User's Guide. These are called class options. You must be root to do this. |
The following table shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.
Table P-2 System Prompts
Shell |
Prompt |
---|---|
C shell prompt |
machine_name% |
C shell superuser prompt |
machine_name# |
Bourne shell and Korn shell prompt |
$ |
Bourne shell and Korn shell superuser prompt |
# |