PBS Toolkit: Owner List Format

Each table of contents frame for a landscape begins with a header which lists vital information about a subsystem:

1. The $PROJECT name
2. The $RELEASE name
3. A list of people related to the subsystem (only if file is present)
4. The last update of the bookshelf for this subsystem

   Numbers 1, 2, and 4 are automatically generated. Number 3 requires a list be provided by the bookshelf manager.

   The file is refered to as an owner list file, but in fact the format is general enough for listing ANY entries of the form:

   Title: Information

   Location:

   There are two possible locations depending on whether the list is release specific or not.

   • $MYBKSHELF/$PROJECT/owners/$SUBSYSTEM.owners

     Used for lists which don't need to change from release to release.

   • $MYBKSHELF/$PROJECT/$RELEASE/owners/$SUBSYSTEM.owners

     Used for lists which are specific to a release.

   Format:

   The format for the file are lines containing three quoted entries of the form:

   "Title" "Information" "Link"

   • Title - A category for the person. Some common ones are:
     • Code owner
     • Backup
     • LS owner
     • Manager
     • Team leader
     • Subsystem leader
     • Project leader
     • Release leader

     A Title entry must always be present, but it could be null by using an entry of "". A null Title entry is useful when more than one person needs to be listed for a single Title. For example, there may be more than one manager, or code owner.

   • Information - Usually a name

   • Link - A link associated with the Information.

     A Link entry must always be present, but it could be null by using an entry of "". If a null Link is given, the Information is presented as normal text. Otherwise, it is presented as a clickable link with the link path as given.

   Examples:

   • Here's the actual header from the parser subsystem from the C488 project:

     parser

     Project:	C488
     Release:	V1
     Code owner:	David Wortman
     LS owner:	Gary Farmaner
     Last updated:	21 Aug 1998

     The owner list file that would be required is $MYBKSHELF/C488/owners/parser.owners with the contents:

     "Code owner" "David Wortman" ""
     "LS owner" "Gary Farmaner" "mailto:dialog@cs.toronto.edu"
     

   • The following illustrates multiple people under a single title, but specific to a release:

     eg

     Project:	eg
     Release:	R1
     Manager:	Ric Holt
     	Gary Farmaner
     Last updated:	21 Aug 1998

     The owner list file that would be required is $MYBKSHELF/eg/R1/owners/eg.owners with the contents:

     "Manager" "Ric Holt" "mailto:holt@uwaterloo.ca" 
     "" "Gary Farmaner" "mailto:dialog@cs.toronto.edu"
     

   ---

   See also: Legend