PBS Toolkit Legend

To make it easier to document the Bookshelf files, and locations, it is helpful to have placeholders (variables, macros) to refer to certain paths, directories, and other unfixed values.

• $MYBKSHELF - The Software Bookshelf must be put somewhere on a file system. This is the absolute path to the root directory of all bookshelves you may generate.

• $MYURL - The http:// path address to $MYBOOKSHELF.

  Example:

  $MYBKSHELF = /home/pbs on the machine bkshelf
  $MYURL = http://bkshelf/home/pbs

• $PBS_ROOT - The path to the directory where the PBS Toolkit was installed.

• $PROJECT - This is a name for a particular software system being presented within the Bookshelf. This should be the common name the system is referred to within the development group.

  Examples: LINUX, Mozilla

• $RELEASE - A project may have multiple releases. The $RELEASE name identifies a particular snapshot of the software system. The name should be the common title a release is referred to within the development group.

  Examples: R11, V1.0.3

• $SUBSYSTEM - A particular subsystem within a bookshelf.

• $MODULE - A source file within a bookshelf.

• $ENTITY - A module, or subsystem within a landscape.

• $SRC_BASE - The base path to all releases of the source code. Each release will probably have it own source directory or directory tree. This path leads to the common base directory for all releases.

• $SRC_OFFSET - This is the path relative to the $SRC_BASE which points to the source code for a particular $RELEASE.