Dimensions CM Make User's Guide Are Available from a Download Area on the Serena Web Site (See Details Below)
Total Page:16
File Type:pdf, Size:1020Kb
SERENA DIMENSIONS CM 14.1 Dimensions CM Make User’s Guide Serena Proprietary and Confidential Information Copyright © 1996–2014 Serena Software, Inc. All rights reserved. This document, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. Except as permitted by such license, no part of this publication may be reproduced, photocopied, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Serena. Any reproduction of such software product user documentation, regardless of whether the documentation is reproduced in whole or in part, must be accompanied by this copyright statement in its entirety, without modification. This document contains proprietary and confidential information, and no reproduction or dissemination of any information contained herein is allowed without the express permission of Serena Software. The content of this document is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Serena. Serena assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. Third party programs included with the Dimensions product are subject to a restricted use license and can only be used in conjunction with Dimensions. Trademarks Serena, TeamTrack, StarTool, PVCS, Comparex, Dimensions, Prototype Composer, Mariner and ChangeMan are registered trademarks of Serena Software, Inc. The Serena logo, Version Manager and Mover are trademarks of Serena Software, Inc. All other products or company names are used for identification purposes only, and may be trademarks of their respective owners. U.S. Government Rights Any Software product acquired by Licensee under this Agreement for or on behalf of the U.S. Government, its agencies and instrumentalities is "commercial software" as defined by the FAR. Use, duplication, and disclosure by the U.S. Government is subject to the restrictions set forth in the license under which the Software was acquired. The manufacturer is Serena Software, Inc., 1850 Gateway Drive, 4th Floor, San Mateo, California 94404. Publication date: June 2014 Table of Contents Welcome to Serena Dimensions CM . 5 Before you Begin . 5 Contacting Serena Technical Support . 5 Videos . 5 Legal Considerations with Respect to Dimensions CM Make. 6 Obtaining the Dimensions CM Make Executables . 6 Installing Dimensions CM Make . 6 Chapter 1 Guide to Dimensions CM Make . 7 Overview of Dimensions CM Make . 8 Dimensions CM Make Processes . 8 Dimensions CM Make Architecture . 8 Online Examples . 10 Setting Up MCX_LISTEN for Multi-Homed Servers . 10 Dimensions CM Make Terminology . 10 Invoking Dimensions CM Make . 11 Integrating with Dimensions CM Versioning . 12 The Current Project . 12 The --configuration-path Option . 14 The pcmsfile . 14 Possible Problems When Preserving Files . 22 Specifying Target Reuse. 22 Automatic Dependency Generation . 23 Building Object Libraries and Other Containers . 24 Building Double Colon Targets . 25 Options Summary . 26 Improving Dimensions CM Make Efficiency . 28 Behavior of Dimensions CM Make Under Windows . 29 Comparing Behavior of Dimensions CM Make to GNU Make. 30 Limitations in NMAKE Compatibility . 30 Source Code Availability . 31 Chapter 2 Guide to ADG. 33 Overview of ADG . 34 Invoking ADG . 34 Specifying the Inputs . 34 Specifying the Language being Processed. 34 Specifying the Initialization File. 34 Specifying the Outputs. 34 Specifying the Target. 35 Specifying the Dependency Filenames . 35 Ignoring Errors . 35 Dimensions CM Make User’s Guide 3 Table of Contents Ignoring System Include Files. 35 Examples . 35 Typical ADG Usage. 36 Writing ADG Initialization Files . 36 Updating Your makefile to Use ADG for Dependency Maintenance . 37 Rule Writing . 39 ADG Options. 41 Source Code Availability . 43 Index. 45 4 Serena® Dimensions® CM 14.1 Welcome to Serena Dimensions CM Thank you for choosing Serena® Dimensions® CM, a powerful process management and change control system. Dimensions CM helps you organize, manage, and protect your software development projects on every level—from storing and tracking changes to individual files, to managing and monitoring an entire development cycle. Before you Begin The Dimensions CM readme contains the following information: What’s new Fixed issues Software compatibility requirements Installation notes Known issues The readme is available online at: http://help.serena.com/doc_center/doc_center.html#dcmDoc Contacting Serena Technical Support Serena provides technical support for all registered users of this product, including limited installation support for the first 30 days. If you need support after that time, contact Serena Support at the following web site and follow the instructions: http://www.serena.com/support Language-specific technical support is available during local business hours. For all other hours, technical support is provided in English. You can use the Serena Support web page to: Report problems and ask questions. Obtain up-to-date technical support information, including that shared by our customers via the web, automatic email notification, newsgroups, and regional user groups. Access a knowledge base, which contains how-to information and allows you to search on keywords for technical bulletins. Download updates and fix releases for your Serena products. Videos Videos of Dimensions CM features can be viewed online at: http://help.serena.com/doc_center/doc_center.html#dcmVid Dimensions CM Make User’s Guide 5 Welcome to Serena Dimensions CM Legal Considerations with Respect to Dimensions CM Make Some of the Dimensions CM and ADG executables and associated libraries, namely: UNIX and Windows File Windows UNIX Only Only adg ✔ dm_make ✔ dm_nmake ✔ libmcx.so ✔ mcx.dll ✔ are derived from source code covered by the GNU GENERAL PUBLIC LICENSE and the GNU LIBRARY GENERAL PUBLIC LICENSE. These files, the GNU Make User Guide, and the Dimensions CM Make User's Guide are available from a download area on the Serena Web site (see details below). To have a working Dimensions CM Make and ADG system (which also enables you to use the legacy download and upload standalone utilities), you will first need to download the executables, libraries, "mini" installation scripts, and documentation from the Serena Web site as explained next. NOTE For conciseness, in the remainder of this manual the files referred to above will simply be referred to as Dimensions CM Make. As a condition of the GNU GENERAL PUBLIC LICENSE and the GNU LIBRARY GENERAL PUBLIC LICENSE, source code for the above discussed executable and library files is also available, see "Source Code Availability" on page 31 and "Source Code Availability" on page 43 for details. Obtaining the Dimensions CM Make Executables A public download area containing the compressed Dimensions CM Make files is freely accessible from the following URL: http://www.serena.com/products/dimensions/dimensions-make.html Installing Dimensions CM Make Installation instructions for Dimensions CM Make are included in the Installation Guide for Windows and Installation Guide for UNIX. 6 Serena® Dimensions® CM 14.1 Chapter 1 Guide to Dimensions CM Make Overview of Dimensions CM Make 8 Online Examples 10 Setting Up MCX_LISTEN for Multi-Homed Servers 10 Dimensions CM Make Terminology 10 Invoking Dimensions CM Make 11 Integrating with Dimensions CM Versioning 12 Building Object Libraries and Other Containers 24 Building Double Colon Targets 25 Options Summary 26 Improving Dimensions CM Make Efficiency 28 Behavior of Dimensions CM Make Under Windows 29 Comparing Behavior of Dimensions CM Make to GNU Make 30 Limitations in NMAKE Compatibility 30 Source Code Availability 31 Dimensions CM Make User’s Guide 7 Chapter 1 Guide to Dimensions CM Make Overview of Dimensions CM Make IMPORTANT! The current version of Dimensions CM Make does not support Dimensions CM streams. Therefore, all references in this chapter to Dimensions CM projects (for example, particularly in the section "Integrating with Dimensions CM Versioning" on page 12) must be read with the understanding that the term "project" is meant precisely and does not also encompass Dimensions CM streams. A Serena® Dimensions® CM product can have a physical representation in the form of a directory structure. Dimensions CM Make provides a mechanism for building configurations against the directory structure by way of Makefiles and offers a close integration of the Dimensions CM product's version management capabilities with the Make capability. This mechanism facilitates full version control and audit trails for the target files created by the build process and also embeds the necessary intelligence to determine whether a target file is out of date and therefore if it must be re-built. The Dimensions CM Make approach is mainly intended for use in development environments where the use of Makefiles is standard practice. The migration time for these environments to Dimensions CM is minimized by virtue of the Dimensions CM Make facility. This manual describes the additional functionality provided by Dimensions CM Make compared to GNU Make. For information on GNU Make, please refer to the GNU Make User Guide. Electronic copies of that document can be found on the Serena Web site, in the following format variants: make.html : HTML format. make.pdf : Portable