[Buildbot-devel] HTML docs
Stephen Davis
stephendavis at mac.com
Sat Jun 18 17:25:37 UTC 2005
On Jun 17, 2005, at 8:19 PM, Brian Warner wrote:
>> I just looked at the Makefile and did "man makeinfo" to find that I
>> could just do "makeinfo --html buildbot.texinfo". It had an error so
>> I had to add the "--force" option but otherwise it mostly worked.
>>
>
> Ah, somehow --force doesn't actually work. Delete that offending
> @image line
> (I haven't created the overview drawing yet) and re-run makeinfo. The
> resulting HTML is pretty basic, but functional (and, annoyingly,
> each texinfo
> page becomes a separate .html file). buildbot/index.html is the
> entry point.
It's still broken. Not knowing TeX at all, this may be the fault of
the version (4.7) of makeinfo shipping with Mac OS X Tiger b/c it
just totally mangles the table of contents and spits out bad html
that (rightfully) chokes Safari. Judicious hand-editing of the
output of index.html makes it all work. I've included the generated
index.html here just for reference.
[see the <style> section which turns into a big comment which
envelops the whole table of contents. ???]
stephen
<html lang="en">
<head>
<title>Index - BuildBot Manual 1.0</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="BuildBot Manual 1.0">
<meta name="generator" content="makeinfo 4.7">
<link title="Top" rel="start" href="index.html#Top">
<link rel="prev" href="Resources.html#Resources" title="Resources">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-
home" title="Texinfo Homepage">
<!--
This is the BuildBot manual.
Copyright (C) 2005 Brian Warner
Copying and distribution of this file, with or without
modification, are permitted in any medium without royalty
provided the copyright notice and this notice are preserved.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family: serif; font-weight<div class="contents">
<h2>Table of Contents</h2>
<ul>
<li><a name="toc_Top" href="index.html#Top">BuildBot</a>
<li><a name="toc_Introduction"
href="Introduction.html#Introduction">1 Introduction</a>
<ul>
<li><a href="History-and-Philosophy.html#History-and-Philosophy">1.1
History and Philosop<ul class="index-cp" compact>
<li><a href="Arch.html#index-Arch-Checkout-10">Arch Checkout</a>: <a
href="Arch.html#Arch">Arch</a></li>
<li><a href="Bazaar.html#index-Bazaar-Checkout-11">Bazaar Checkout</
a>: <a href="Bazaar.html#Bazaar">Bazaar</a></li>
<li><a href="Buildslave-Specifiers.html#index-bots-4">bots</a>: <a
href="Buildslave-Specifiers.html#Buildslave-Specifiers">Buildslave
Specifiers</a></li>
<li><a href="Defining-Builders.html#index-builders-5">builders</a>:
<a href="Defining-Builders.html#Defining-Builders">Defining Builders</
a></li>
<li><a href="Version-Control-Systems.html#index-CVS-2">CVS</a>: <a
href="Version-Control-Systems.html#Version-Control-Systems">Version
Control Systems</a></li>
<li><a href="CVS.html#index-CVS-Checkout-7">CVS Checkout</a>: <a
href="CVS.html#CVS">CVS</a></li>
<li><a href="Darcs.html#index-Darcs-Checkout-9">Darcs Checkout</a>:
<a href="Darcs.html#Darcs">Darcs</a></li>
<li><a href="Introduction.html#index-introduction-1">introduction</
a>: <a href="Introduction.html#Introduction">Introduction</a></li>
<li><a href="IRC-Bot.html#index-IRC-15">IRC</a>: <a href="IRC-
Bot.html#IRC-Bot">IRC Bot</a></li>
<li><a href="PBListener.html#index-PBListener-16">PBListener</a>: <a
href="PBListener.html#PBListener">PBListener</a></li>
<li><a href="P4Sync.html#index-Perforce-Update-12">Perforce Update</
a>: <a href="P4Sync.html#P4Sync">P4Sync</a></li>
<li><a href="Defining-Builders.html#index-
periodicBuildTime-6">periodicBuildTime</a>: <a href="Defining-
Builders.html#Defining-Builders">Defining Builders</a></li>
<li><a href="Setting-the-slaveport.html#index-
slavePortnum-3">slavePortnum</a>: <a href="Setting-the-
slaveport.html#Setting-the-slaveport">Setting the slaveport</a></li>
<li><a href="SVN.html#index-SVN-Checkout-8">SVN Checkout</a>: <a
href="SVN.html#SVN">SVN</a></li>
<li><a href="BuildFactory-Attributes.html#index-
treeStableTimer-13">treeStableTimer</a>: <a href="BuildFactory-
Attributes.html#BuildFactory-Attributes">BuildFactory Attributes</a></
li>
<li><a href="HTML-Waterfall.html#index-Waterfall-14">Waterfall</a>:
<a href="HTML-Waterfall.html#HTML-Waterfall">HTML Waterfall</a></li>
</ul>hy</a>
<li><a href="System-Architecture.html#System-Architecture">1.2 System
Architecture</a>
<li><a href="Control-Flow.html#Control-Flow">1.3 Control Flow</a>
</li></ul>
<li><a name="toc_Installation"
href="Installation.html#Installation">2 Installation</a>
<ul>
<li><a href="Requirements.html#Requirements">2.1 Requirements</a>
<li><a href="Installing-the-code.html#Installing-the-code">2.2
Installing the code</a>
<li><a href="Creating-a-buildmaster.html#Creating-a-buildmaster">2.3
Creating a buildmaster</a>
<li><a href="Creating-a-buildslave.html#Creating-a-buildslave">2.4
Creating a buildslave</a>
<li><a href="Launching-the-daemons.html#Launching-the-daemons">2.5
Launching the daemons</a>
<li><a href="Logfiles.html#Logfiles">2.6 Logfiles</a>
<li><a href="Shutdown.html#Shutdown">2.7 Shutdown</a>
<li><a href="Maintenance.html#Maintenance">2.8 Maintenance</a>
<li><a href="Troubleshooting.html#Troubleshooting">2.9
Troubleshooting</a>
<ul>
<li><a href="Starting-the-buildslave.html#Starting-the-
buildslave">2.9.1 Starting the buildslave</a>
<li><a href="Connecting-to-the-buildmaster.html#Connecting-to-the-
buildmaster">2.9.2 Connecting to the buildmaster</a>
<li><a href="Forcing-Builds.html#Forcing-Builds">2.9.3 Forcing
Builds</a>
</li></ul>
</li></ul>
<li><a name="toc_Concepts" href="Concepts.html#Concepts">3 Concepts</a>
<ul>
<li><a href="Version-Control-Systems.html#Version-Control-
Systems">3.1 Version Control Systems</a>
<ul>
<li><a href="Generalizing-VC-Systems.html#Generalizing-VC-
Systems">3.1.1 Generalizing VC Systems</a>
<li><a href="Source-Tree-Specifications.html#Source-Tree-
Specifications">3.1.2 Source Tree Specifications</a>
<li><a href="How-Different-VC-Systems-Specify-Sources.html#How-
Different-VC-Systems-Specify-Sources">3.1.3 How Different VC Systems
Specify Sources</a>
<li><a href="Attributes-of-Changes.html#Attributes-of-Changes">3.1.4
Attributes of Changes</a>
</li></ul>
<li><a href="Changes.html#Changes">3.2 Changes</a>
<li><a href="Users.html#Users">3.3 Users</a>
<ul>
<li><a href="Doing-Things-With-Users.html#Doing-Things-With-
Users">3.3.1 Doing Things With Users</a>
<li><a href="Email-Addresses.html#Email-Addresses">3.3.2 Email
Addresses</a>
<li><a href="IRC-Nicknames.html#IRC-Nicknames">3.3.3 IRC Nicknames</a>
<li><a href="Live-Status-Clients.html#Live-Status-Clients">3.3.4 Live
Status Clients</a>
</li></ul>
</li></ul>
<li><a name="toc_Configuration"
href="Configuration.html#Configuration">4 Configuration</a>
<ul>
<li><a href="Config-File-Format.html#Config-File-Format">4.1 Config
File Format</a>
<li><a href="Loading-the-Config-File.html#Loading-the-Config-
File">4.2 Loading the Config File</a>
<li><a href="Defining-the-Project.html#Defining-the-Project">4.3
Defining the Project</a>
<li><a href="Listing-Change-Sources.html#Listing-Change-Sources">4.4
Listing Change Sources</a>
<li><a href="Setting-the-slaveport.html#Setting-the-slaveport">4.5
Setting the slaveport</a>
<li><a href="Buildslave-Specifiers.html#Buildslave-Specifiers">4.6
Buildslave Specifiers</a>
<li><a href="Defining-Builders.html#Defining-Builders">4.7 Defining
Builders</a>
<li><a href="Interlocks.html#Interlocks">4.8 Interlocks</a>
<li><a href="Defining-Status-Targets.html#Defining-Status-
Targets">4.9 Defining Status Targets</a>
<li><a href="Debug-options.html#Debug-options">4.10 Debug options</a>
</li></ul>
<li><a name="toc_Getting-Source-Code-Changes" href="Getting-Source-
Code-Changes.html#Getting-Source-Code-Changes">5 Getting Source Code
Changes</a>
<ul>
<li><a href="Change-Sources.html#Change-Sources">5.1 Change Sources</a>
<ul>
<li><a href="Choosing-ChangeSources.html#Choosing-
ChangeSources">5.1.1 Choosing ChangeSources</a>
<li><a href="CVSToys-_002d-PBService.html#CVSToys-_002d-
PBService">5.1.2 CVSToys - PBService</a>
<li><a href="CVSToys-_002d-mail-notification.html#CVSToys-_002d-mail-
notification">5.1.3 CVSToys - mail notification</a>
<li><a href="Other-mail-notification-ChangeSources.html#Other-mail-
notification-ChangeSources">5.1.4 Other mail notification
ChangeSources</a>
<li><a href="PBChangeSource.html#PBChangeSource">5.1.5
PBChangeSource</a>
</li></ul>
<li><a href="Sending-Changes-at-the-Buildmaster.html#Sending-Changes-
at-the-Buildmaster">5.2 Sending Changes to the Buildmaster</a>
<li><a href="Receiving-Changes.html#Receiving-Changes">5.3 Receiving
Changes</a>
</li></ul>
<li><a name="toc_Build-Process" href="Build-Process.html#Build-
Process">6 Build Process</a>
<ul>
<li><a href="Build-Steps.html#Build-Steps">6.1 Build Steps</a>
<ul>
<li><a href="Common-Parameters.html#Common-Parameters">6.1.1 Common
Parameters</a>
<li><a href="ShellCommand.html#ShellCommand">6.1.2 ShellCommand</a>
<li><a href="Simple-ShellCommand-Subclasses.html#Simple-ShellCommand-
Subclasses">6.1.3 Simple ShellCommand Subclasses</a>
<ul>
<li><a href="Configure.html#Configure">6.1.3.1 Configure</a>
<li><a href="Compile.html#Compile">6.1.3.2 Compile</a>
<li><a href="Test.html#Test">6.1.3.3 Test</a>
</li></ul>
<li><a href="Source-Checkout.html#Source-Checkout">6.1.4 Source
Checkout</a>
<ul>
<li><a href="CVS.html#CVS">6.1.4.1 CVS</a>
<li><a href="SVN.html#SVN">6.1.4.2 SVN</a>
<li><a href="Darcs.html#Darcs">6.1.4.3 Darcs</a>
<li><a href="Arch.html#Arch">6.1.4.4 Arch</a>
<li><a href="Bazaar.html#Bazaar">6.1.4.5 Bazaar</a>
<li><a href="P4Sync.html#P4Sync">6.1.4.6 P4Sync</a>
</li></ul>
</li></ul>
<li><a href="Build-Factories.html#Build-Factories">6.2 Build
Factories</a>
<ul>
<li><a href="BuildStep-Objects.html#BuildStep-Objects">6.2.1
BuildStep Objects</a>
<li><a href="BuildFactory.html#BuildFactory">6.2.2 BuildFactory</a>
<ul>
<li><a href="BuildFactory-Attributes.html#BuildFactory-
Attributes">6.2.2.1 BuildFactory Attributes</a>
<li><a href="Quick-builds.html#Quick-builds">6.2.2.2 Quick builds</a>
</li></ul>
<li><a href="Process_002dSpecific-build-
factories.html#Process_002dSpecific-build-factories">6.2.3 Process-
Specific build factories</a>
<ul>
<li><a href="GNUAutoconf.html#GNUAutoconf">6.2.3.1 GNUAutoconf</a>
<li><a href="CPAN.html#CPAN">6.2.3.2 CPAN</a>
<li><a href="Python-distutils.html#Python-distutils">6.2.3.3 Python
distutils</a>
<li><a href="Python_002fTwisted_002ftrial-
projects.html#Python_002fTwisted_002ftrial-projects">6.2.3.4 Python/
Twisted/trial projects</a>
</li></ul>
</li></ul>
</li></ul>
<li><a name="toc_Status-Delivery" href="Status-Delivery.html#Status-
Delivery">7 Status Delivery</a>
<ul>
<ul>
<li><a href="HTML-Waterfall.html#HTML-Waterfall">7.0.1 HTML
Waterfall</a>
<li><a href="IRC-Bot.html#IRC-Bot">7.0.2 IRC Bot</a>
<li><a href="PBListener.html#PBListener">7.0.3 PBListener</a>
</li></ul>
</li></ul>
<li><a name="toc_Resources" href="Resources.html#Resources">8
Resources</a>
<li><a name="toc_Index" href="Index.html#Index">Index</a>
</li></ul>
</div>
: normal; }
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Index"></a>Previous: <a rel="previous" accesskey="p"
href="Resources.html#Resources">Resources</a>,
Up: <a rel="up" accesskey="u" href="index.html#Top">Top</a>
<hr><br>
</div>
<h2 class="unnumbered">Index</h2>
</body></html>
More information about the devel
mailing list