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

Changeset 2530

Show
Ignore:
Timestamp:
07/31/12 16:22:45 (21 months ago)
Author:
jkoshy
Message:

Rework the introductory text of build system:

  • Change the document title to reflect the general purpose nature of the system.
  • Improve the text of the preface.

Ticket: #279

Files:
1 modified

Legend:

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

    r2461 r2530  
    4343% Add meta-data to the PDF file. 
    4444\hypersetup{ 
    45   pdftitle={The Elftoolchain Build System}, 
     45  pdftitle={A Build Automation System}, 
    4646  pdfauthor={Joseph Koshy}, 
    4747  pdfsubject={A build automation system}, 
     
    7070 
    7171% The title page. 
    72 \title{The Elftoolchain Build System} 
     72\title{A Build Automation System} 
    7373\author{Joseph~Koshy} 
    7474\maketitle 
     
    7979\chapter*{Preface} 
    8080 
    81 This document describes the build system used by the the \elftoolchain 
    82 project on \href{http://sourceforge.net/}{SourceForge.Net}.  This 
    83 build system helps the \elftoolchain project to build and test its 
    84 source tree on a variety of operating systems and machine 
    85 architectures. 
     81This document describes a build automation system being developed at 
     82the \elftoolchain project on 
     83\href{http://sourceforge.net/}{SourceForge.Net}.  The original 
     84motivation for this system was to automate the process of building and 
     85testing the \elftoolchain project's source tree on a variety of 
     86operating systems and machine architectures.  However, the design of 
     87the system is general enough that it can be used in other contexts 
     88too. 
    8689 
    87 The system is designed to use emulators such as 
    88 \href{http://www.qemu.org}{QEMU}, 
     90The system has been designed to be easy to use and to frugal in its 
     91use of computing resources.  For handling non-native platforms, the 
     92system uses emulators such as \href{http://www.qemu.org}{QEMU}, 
    8993\href{http://gxemul.sourceforge.net/}{GXemul} and 
    90 \href{http://www.virtualbox.org}{VirtualBox}, permitting the project's 
    91 source tree to be built on a wide variety of target platforms and 
    92 operating systems. 
     94\href{http://www.virtualbox.org}{VirtualBox}.  The system is not tied 
     95to these specific emulators---it can as well manage physical machines, 
     96given the appropriate control specifications. 
    9397 
    9498This document itself is a 
     
    101105This document would be useful to two audiences: 
    102106\begin{itemize} 
    103 \item Users of the build system would find part~\ref{part.intro}, 
    104   which contains an overview and a user guide, to be of interest. 
    105 \item For maintainers of the build system, 
     107\item Users of the system would find part~\ref{part.intro}, which 
     108  contains an overview and a user guide, to be of interest. 
     109\item For the maintainers of the system, 
    106110  part~\ref{part.implementation} contains the implementation itself. 
    107111\end{itemize} 
     
    110114 
    111115\begin{itemize} 
    112 \item Chapter~\vref{chap.introduction} describes the rationale and 
    113   formal requirements for the build system. 
    114 \item Chapter~\vref{chap.userguide} contains a user guide. 
     116\item Chapter~\vref{chap.introduction} describes the rationale and the 
     117  requirements for the system. 
     118\item Chapter~\vref{chap.userguide} contains a brief user guide 
     119  showing how the system may be used. 
    115120\item Chapter~\vref{chap.overview} presents an overview of the 
    116121  implementation.