QEF Advanced Software Inc.

An Introduction to the

Software Process Automation System

Preface

Part I - Introduction to QEF

1	Welcome to QEF
	1.1	What is QEF?
	1.2	Why QEF?
	1.3	The QEF Software Philosophy
	1.4	Three-Phase Constructions
	1.5	Concepts and Terms
	1.6	An Example Process
	1.7	An Overview of the Toolset
2	QEF Documentation
	2.1	Sources of Q-Tree Documentation
	2.2	Xdbs, Quete, Mkquete, and the Quete Databases
3	Getting Started
	3.1	$QTREE, $PATH, and qd
	3.2	Initializing Your $HOME/.qtree Directory
4	The QEF Tutorials
	4.1	Tutorial 1
	4.2	Tutorial 2
	4.3	Tutorial 3
	4.4	Miscellaneous Notes

5	The QEF Graphical User Interface
	5.1	Program Overview
	5.2	The Welcome Window
	5.3	The Tree Browser and the Directory Server
	5.4	The Navigator
	5.5	The Build Monitor
	5.6	The Qef Info Tool
6	Qdsrv and Qhost: The QEF Servers
	6.1	The QDSRV Services
	6.2	QDSRV Startup
	6.3	QDSRV Client Programs
	6.4	The Path Database, Qds, and Qd
	6.5	The QHOST Server
7	Getting Started, Really
	7.1	Creating the Project Infrastructure
	7.2	Creating the Project Wide Configuration Files
	7.3	Creating the Multi-directory Tree Walk
	7.4	Creating a qeffile For Each Directory
	7.5	The Construction Script
	7.6	Source Modification
	7.7	Example Sub-Projects

Part II - Advanced Topics

8	Qvrs: The QEF Variables System
	8.1	Introduction to Qvrs
	8.2	The Qvrs Files
	8.3	Configuration Tools
	8.4	Qvrs Variables
	8.5	The Qvrs Files and Their Processing Order
	8.6	Qvrs Keywords
	8.7	Formal Rules
	8.8	Qvrs Command-Line Options
	8.9	The Traits System
9	Qsg: The Principal QEF Script Generator
	9.1	What Qsg Is and How It Works
	9.2	Qsg Tools and Libraries
	9.3	Command Syntax
	9.4	Creating a Project Specific Qsg Library
	9.5	The Qsg Script Language
	9.6	Example Qsg Script
	9.7	Qsg Variables
	9.8	Script Generating Principles
	9.9	Qsg and this Guide
10	The File System Integrity Check (FSIC) System
	10.1	Introduction
	10.2	The FSIC Database Files
	10.3	Checking and Fixing the Source Tree

	10.4	Checking and Fixing the Inst/Obj Trees
11	Advanced Tools
	11.1	Qremote, Cush, Lash, Josh, & Envset
	11.2	Distributed Processing
	11.3	Go, G, Goes, Gomonitor, and the Build Monitor
	11.4	Mkvernum and Vcc
	11.5	Mnfdb: The Source Manifest Database Package
	11.6	Ct and Pa
	11.7	Rpl -- An Oldie But Goldie
	11.8	The -f Flag
12	QEF and Large Projects
	12.1	Objectives
	12.2	The Software Process
	12.3	Overall Project Architecture
	12.4	The Principle of Locality
	12.5	Rolling Release Engineering
	12.6	Bare Metal Builds
	12.7	Project Specific SysVrs files
	12.8	Version Control Systems
	12.9	Project Administration Support
	12.10	Documentation of Project Processes
	12.11	Supplementary QEF Tools and Files
	12.12	-30-

The Appendices

A	QEF Installation Instructions
	A.1	Choosing the Q-Tree Installation Directory
	A.2	QEF Installation on Windows
	A.3	QEF Installation
	A.4	Post Installation Processing
	A.5	Creating Lclqtree
B	Q-Tree Maintenance Procedures
	B.1	The Company Information File (company.cf)
	B.2	The Traits Files (traits.ext & traits/*.tab)
	B.3	The Quete Databases (quete/*)
	B.4	The Qdsrv Data Base (qdsrv.db)
	B.5	The *.qtree Variables
	B.6	The Qdsrv Log (qdsrv.log)
	B.7	The Mkvernum Log (mkvernum.db)
	B.8	The Qremote Command Files (qremote/*)
	B.9	The System Name Mapping File (sysnames.tab)

	B.10	File of Path to Path Mappings (roots.map)
	B.11	New User Setup and Localizing dotqtree Dirset
	B.12	The lib/sysvrs/`system -v`.vrs File
	B.13	Other Possible Changes
C	Using QEF on Microsoft Platforms
	C.1	MIDL, Precompiled Header Files, and DLLs
	C.2	Working with Visual Studio
	C.3	Targeting Different Environments
D	Q-Tree Command Summaries
E	The QEF Quick Reference Card
F	The QEF Specialist's Reference Card
G	Index of the X-q* Databases

book.qh - 9.3 - 03/10/22