1. Summary
  2. Files
  3. Support
  4. Report Spam
  5. Create account
  6. Log in

Changeset 2539

Show
Ignore:
Timestamp:
08/04/12 05:24:21 (21 months ago)
Author:
jkoshy
Message:

Add stub content for the user guide.

Ticket: #279

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • trunk/tools/build-automation/userguide.nw

    r2461 r2539  
    11% $Id$ 
    22% 
    3 % A user guide. 
     3% A user guide on how to use the system--configuring and running a 
     4% build. 
    45 
    56\chapter{Using The Build System}\label{chap.userguide} 
    67 
    7 % How to use the system--configuring and running a build. 
     8In this chapter we will look at how to use the system. 
     9 
     10\section{Terminology} 
     11 
     12A \definition{build configuration} is specification of the steps need 
     13to invoke complete a build; i.e., the list of machines to be invoked, 
     14the scheduling logic for invoking these machines, the specific tasks 
     15be invoked inside each virtual machine, the results to retrieve, and 
     16so on. 
     17 
     18A \definition{build run} is an invocation of a \term{build 
     19  configuration}. 
     20 
     21A \definition{build scheduler} is a script that implements the logic 
     22for scheduling the machines that are part of the build. 
     23 
     24A \definition{build slave} is a physical or virtual machine that 
     25participates in a build. 
     26 
     27A \definition{slave script} is a script that lists the actions to 
     28be executed in a virtual machine. 
     29 
     30\section{Configuration} 
     31 
     32TODO: describe how to configure the tool. 
     33 
     34% File locations for $ROOT: 
     35%     /etc/yabs/default/ 
     36%     /etc/yabs/<job-name>/ 
     37%     $HOME/.yabs/default/ 
     38%     $HOME/.yabs/<job-name>/ 
     39 
     40 
     41% $ROOT/build-name/config           -- configuration 
     42% $ROOT/build-name/scheduler        -- which order to run stuff 
     43 
     44% $ROOT/build-name/<machine>.startup -- how to (externally) start the machine 
     45% $ROOT/build-name/<machine>.shutdown -- how to (externally) stop the machine 
     46% $ROOT/build-name/<machine>.commands -- the build commands to be issued 
     47 
     48% Logs: 
     49 
     50% /var/logs/yabs/build-name.NNN