Sun WorkShop TeamWare: User's Guide: - Preface

# Preface

## Introduction

The Sun Workshop TeamWare Users Guide describes how to use the Sun Workshop TeamWare code management tools. The concepts and information discussed apply to both command line and graphical user interfaces.

## Who Should Use This Book

Sun Workshop Teamware Users Guide is directed towards 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 Configuring section of this guide is primarily addressed to the software developer. It also addresses the needs of integrators, administrators, and release engineers.

The Versioning and Freezepointing section of this guide explains how to use Versioning for controlling files and monitoring changes on concurrent software development projects. Versioning is a graphical user interface (GUI) to the source code control system (SCCS). It also explains how to use Freezepointing, a tool that allows you to create snapshots of a project at various key junctures. These snapshots, or freezepoints, enable you to recreate the project at a particular state in its development cycle. Use this section if you write programs coded in ASCII text source. This sections assumes that you are familiar with programming constructs and processes. You need not have previous experience with SCCS.

The Building and DMake sections of this guide 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 sections if you maintain programs using the `make` utility and wish to speed up the build process. These sections also assume that you are familiar with the standard `make` utility.

This manual assumes that you are familiar with the SunOS operating system, the UNIX® source code control system (SCCS), and with general programming terminology.

## Compatibility

See the online `readme` file for specific operating environment information.

## Before You Read This Book

You should have TeamWare installed on your system. See the Installing Developer Products on Solaris manual for information on how to install the TeamWare software.

## How This Book Is Organized

Chapter 1, "QuickStart"--provides instructions for quickly getting started using the 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 portion of TeamWare. Basic concepts are discussed that are vital to understanding how Configuring works.

Chapter 4, "Introduction to Merging" --presents an overview of the Merging portion of 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, "Administering the Workspace"--discusses those considerations to be made when starting a project with the Configuring Program.

Chapter 11, "How the Configuring Program Merges SCCS Files"--describes how TeamWare Configuring manipulates SCCS history files during file transfer transactions.

Chapter 12, "Configuring Example"--contains an example that demonstrates the TeamWare Configuring bringover, putback, and resolve transaction cycle.

Chapter 13, "Error and Warning Messages"--lists TeamWare Configuring error messages and warnings. Each message is defined, and a possible remedy is provided.

Chapter 14, "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 service. It covers the basic operational tasks and walks you through step-by-step instructions.

Chapter 15, "Starting and Loading Merging" --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 16, "Examining Differences" -- examines the process of using Merging to resolve differences between files, including automatic merging, and provides a detailed example.

Chapter 17, "Introduction to 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 18, "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 19, "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 20, "Using DistributedMake"--describes DMake, a tool that allows you to distribute builds overs several hosts concurrently. The operation of DMake is described, and instructions given on how to distribute your build efficiently.

Chapter 21, "Dealing With Release Matters"--provides a summary of the post-build process, and points to a source for further help in handling release and integration matters.

"Glossary"--provides a clear explanation of the special terms used in this manual.

## How to Get Help

This release of Sun WorkShop TeamWare includes a new documentation delivery system as well as online manuals and video demonstrations. To find out more, you can start in any of the following places:

- Online Help - A new 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 TeamWare windows.
- TeamWare Documentation - A set of online manuals. These manuals make up the complete documentation set for Sun WorkShop TeamWare and are available using AnswerBookTM or (at the user's option) using a browser. To access the online manuals, choose Help TeamWare Manuals in any TeamWare window.
- Video Demonstration - This demo provides a general overview of Sun WorkShop TeamWare and describe how to use Sun WorkShop TeamWare manage code. To access, choose Help Demos in the TeamWare main window.
- Release Notes - The Release Notes contain general information about Sun WorkShop TeamWare and specific information about software limitations and bugs. To access the Release Notes, choose Help Release Notes.

## Related Books

Sun WorkShop TeamWare provides comprehensive documentation. The following books are available in online and printed forms (except where noted).

Access online books by choosing Help Online Books or Help Sun WorkShop TeamWare Contents from the main WorkShop Help menu. Many of the Sun WorkShop TeamWare tools and utilities are linked to detailed, context-sensitive, on-item help, which in turn is linked to the relevant sections of the Sun WorkShop TeamWare help volume. This release of Sun WorkShop TeamWare also provides a set of video demonstrations accessible from the main Sun WorkShop TeamWare Help menu. Some documents are available with all Sun WorkShop TeamWare products, others are not (as noted).

### Sun WorkShop TeamWare Documentation

Sun WorkShop TeamWare: Users Guide | (This book) Describes how to use all the tools in the TeamWare toolset, for both the command-line interface and the graphical user interface.
Sun WorkShop TeamWare: Solutions Guide | Provides an in-depth case study and eight scenario-based topics to help you take full advantage of TeamWare's features.
Sun WorkShop TeamWare TeamWare Online Help | Provides succinct task-oriented information to help you become familiar with the application. Help volume includes video demonstrations.
Manual Pages | (online only) Provide information about the TeamWare command-line commands and utilities.

Manual Pages (`man` pages)--TeamWare has the following manual pages:

#### Table P-1 TeamWare Manual Pages

`codemgr(1)` | `rcs2ws(1)` | `access_control(4)`
`codemgrtool(1)` | `sccsmerge(1)` | `args(4)`
`bringover(1)` | `teamware(1)` | `children(4)`
`def.dir.flp(1)` | `twbuild(1)` | `freezepointfile(4)`
`dmake(1)` | `twconfig(1)` | `notification(4)`
`filemerge(1)` | `twfreeze(1)` | `conflicts(4)`
`freezept(1)` | `twmerge(1)` | `history(4)`
`freezepttool(1)` | `twversion(1)` | `locks(4)`
`make(1)` | `vertool(1)` | `nametable(4)`
`maketool(1)` | `workspace(1)` | `parent(4)`
`putback(1)` | `ws_undo(1)` | `putback.cmt(4)`
`resolve(1)` |  |

## Ordering Additional Hardcopy Documentation

You can order additional copies of the hard copy documentation by calling SunExpress at 1-800-USE-SUNX, or visiting their web page at

    http://sunexpress.usec.sun.com

## Sun on the World Wide Web

World Wide Web (WWW) users can view Sun's Developer Products site at the following URL:

    http://sun-www.EBay.Sun.COM:80/sunsoft/Developer-products/

This area is updated regularly and contains helpful information, including current release and configuration tables, special programs, and success stories.

## What Typographic Changes Mean

The following table describes the typographic changes used in this book.`

#### Table P-2 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.

`

## Shell Prompts in Command Examples

The following table shows the default system prompt and superuser prompt for the C shell, Bourne shell, and Korn shell.`

#### Table P-3 Shell 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 | `#`

`