pbs_build

Summary: Generate a bookshelf for a release of a software system.

Syntax: pbs_build [option] $PROJECT $SRC_OFFSET $RELEASE $PREV_RELEASE

Example:

pbs_build -D C488 . V1

Once a project has been initialized with pbs_init the process of constructing a bookshelf for a particular release is accomplished with pbs_build.

This program manages the four phases of bookshelf generation:

• Extraction of facts from source code
• Manipulation of facts into architectural TA files
• Auto-layout for visualization purposes
• Populate the bookshelf repository with the facts, TA, and HTML file which constitutes a bookshelf of a release.

Parameters:

• option - optional switch

  One of:

  • -F for full build (default)
  • -D for slice/layout/populate only
  • -M to start after extract stage (factbase.rsf must be present)
  • -L for layout and populate only (highLevelFacts.rsf and contain.rsf needed)
  • -I base on options in project's config file in ~/.pbs/$PROJECT.inf

• $PROJECT - The project for which to generate a bookshelf.

  Must have already been initialized with pbs_init.

• $SRC_OFFSET - Offset from source base to source for release

  When pbs_init is executed the base source directory path for the source code is given.

  The source offset is the path relative to the source base path to the source code for a release. If the source code is in the source base directory, then you use a source offset of "."

• $RELEASE - The release for which to generate a bookshelf.

  As a software system evolves, there may be multiple releases over time. Each release will have a name that is defined within the culture.

• $PREV_RELEASE - The release for which this release it to be based on.

  When new releases are introduced, you'll want certain aspects of the previous release to be reused (layouts, etc.>. By supplying the name of the previous release, you guide pbs_build on where to get vital information to be copied over and/or reused.

  Note: By default, if it is not present, $PREV_RELEASE = $RELEASE