SliTaz Repositories

     1.1 --- a/en/doc/cookbook/build-bot.html	Sat Jun 20 21:12:52 2009 +0000
     1.2 +++ b/en/doc/cookbook/build-bot.html	Sun Jun 21 20:14:32 2009 +0000
     1.3 @@ -31,9 +31,10 @@
     1.4  <h2><font color="#DF8F06">Build Bot (tazbb)</font></h2>
     1.5  
     1.6  <p>
     1.7 -The goal of Tazbb is to automate, test and report packages building from a
     1.8 -wok. Run <code>tazbb usage</code> for the list of available commands with
     1.9 -a short description. Status of Tank Build Bot via Tazbb web interface at
    1.10 +The goal of Tazbb is to automate, test and report packages built inside a wok.
    1.11 +Run <code>tazbb usage</code> for the list of available commands with
    1.12 +a short description. 
    1.13 +The Status of the Tank Build Bot via a Tazbb web interface is at
    1.14  <a href="http://bb.slitaz.org/">bb.slitaz.org</a> and for collaboration:
    1.15  <a href="http://labs.slitaz.org/wiki/distro/Tazbb">Tazbb Wiki</a>.
    1.16  </p>
    1.17 @@ -41,7 +42,7 @@
    1.18  <ul>
    1.19  	<li><a href="#about">How it works</a></li>
    1.20  	<li><a href="#cmds">Commands</a></li>
    1.21 -	<li><a href="#wok">Hg and chroot Wok</a></li>
    1.22 +	<li><a href="#woks">Hg and chroot Wok</a></li>
    1.23  	<li><a href="#log">Log files</a></li>
    1.24  	<li><a href="#web">Web interface</a></li>
    1.25  	<li><a href="#hg-hook">Hg hook</a></li>
    1.26 @@ -52,66 +53,66 @@
    1.27  <a name="about"></a>
    1.28  <h3>How it works</h3>
    1.29  <p>
    1.30 -Tazbb can be run by a cron job and check the last commit done by contributors
    1.31 -and then cook modified packages. Runnning 'tazbb cook-commit' will just
    1.32 -rebuild last modified packages, to rebuild all missing, modified or unbuilt
    1.33 -packages you must use 'tazbb cook-all'.
    1.34 +Tazbb can be run by a cron job and checks the last commit done by contributors
    1.35 +and then cooks the modified packages. Runnning 'tazbb cook-commit' will just
    1.36 +rebuild the last modified packages. To rebuild all missing, modified or unbuilt
    1.37 +packages you must use the 'tazbb cook-all' command.
    1.38  </p>
    1.39  <p>
    1.40 -Generating report will source all receipt in the wok and check if the package
    1.41 -file exist, if not we add the package name in the current cooklist. For
    1.42 -existing packages we compare all files date in the Hg wok (receipt, stuff)
    1.43 -to the package.tazpkg file date, if it differ we add the package to the cooklist.
    1.44 +Generating a report will source all the receipts in the wok and check if a package
    1.45 +file exists, if not we add the package name to the current cooklist. For
    1.46 +existing packages we compare all the files' dates in the Hg wok (receipt, stuff)
    1.47 +against the package.tazpkg file date, if it differs, we add the package to the cooklist.
    1.48  </p>
    1.49  <p>
    1.50 -Tazbb must also look in the chroot wok to check if the package is built, there
    1.51 -should be a taz/ directory, if none we log and add it also to the cooklist.
    1.52 -All package are cooked with 'script', log for cooked packages are stored in
    1.53 -$LOG_DIR and a link exist for the web interface so developers can easily check
    1.54 -the bug.
    1.55 +Tazbb must also look in the chroot wok to check if the package is already built, (there
    1.56 +should be a taz/ directory), if not we log it and add it also to the cooklist.
    1.57 +All packages are cooked with a 'script'. Logs for cooked packages are stored in
    1.58 +$LOG_DIR and a link exists for the web interface so that developers can easily check
    1.59 +for bugs.
    1.60  </p>
    1.61  <p>
    1.62 -When run with the option 'cook' Tazbb will also remove oold and corrupted packages,
    1.63 -and then execute 'tazwok genlist --text' to rebuild all packages lists. To work
    1.64 -properly Tazwok and Tazbb configured paths must match. Tazbb system wide configuration
    1.65 -file is: <code>/etc/slitaz/tazbb.conf</code>
    1.66 +When run with the option 'cook' - Tazbb will also remove old and corrupted packages
    1.67 +and then execute 'tazwok genlist --text' to rebuild all the packages lists. To work
    1.68 +properly, the Tazwok and Tazbb configured paths must match. The Tazbb system wide 
    1.69 +configuration file is: <code>/etc/slitaz/tazbb.conf</code>
    1.70  </p>
    1.71  
    1.72  <a name="cmds"></a>
    1.73  <h3>Commands</h3>
    1.74  <p>
    1.75 -Tazbb can be installed on your machine and be run manualy from the command
    1.76 -line, just type 'tazbb usage' for a list of available functions. Tazbb can be
    1.77 -run in report mode and display more information with the '--verbose' option.
    1.78 +Tazbb can be installed on your machine and run manually from the command
    1.79 +line - just type 'tazbb usage' for a list of available functions. Tazbb can be
    1.80 +run in report mode and made to display more information with the '--verbose' option.
    1.81  </p>
    1.82  
    1.83  <a name="woks"></a>
    1.84  <h3>Hg and chroot Wok</h3>
    1.85  <p>
    1.86 -Tazbb use 2 wok: a clean Hg wok and a wok to build package in a chroot.
    1.87 -Each time Tazbb is called, the Hg wok is updated and copied to the build
    1.88 -wok so we avoid messing with build results and we can also modify manually
    1.89 -receipts or patches directly with affecting the main Hg. If configured
    1.90 +Tazbb uses 2 woks: a clean Hg wok and a wok to build packages in a chroot environment.
    1.91 +Each time Tazbb is called; the Hg wok is updated and copied to the build
    1.92 +wok, so we avoid messing with build results and can also manually modify 
    1.93 +receipts or patches directly without affecting the main Hg. If configured
    1.94  correctly 'tazdev update-wok' can also update the Hg wok and copy files.
    1.95  </p>
    1.96  
    1.97  <a name="log"></a>
    1.98  <h3>Log files</h3>
    1.99  <p>
   1.100 -Tazbb use existing tool such as tazwok to build package but generate it own
   1.101 -log files and have it own database stored in text file. The log files are
   1.102 -available throught the web interface and the default path for the files is
   1.103 -naturally: <code>/var/log/tazbb</code>
   1.104 +Tazbb uses existing tools such as tazwok to build packages, but generates its own
   1.105 +log files and has its own database stored in a text file. The log files are
   1.106 +available through the web interface and the default path for the files is:
   1.107 +<code>/var/log/tazbb</code>
   1.108  </p>
   1.109  
   1.110  <a name="web"></a>
   1.111  <h3>Web interface</h3>
   1.112  <p>
   1.113 -Tazbb log's all his activity to log files and cooklist, these informations
   1.114 -can be displayed throught a nice web interface so developers can have a quick
   1.115 -overview of the last build results. Tazbb package provide a PHP web interface,
   1.116 -CSS style and images installed by default in <code>/var/lib/tazbb/web</code>,
   1.117 -a symlink is created in <code>/var/www/vhosts</code> by the package, it provide
   1.118 +Tazbb logs all its activity to log files and a cooklist. This information
   1.119 +can be displayed through a nice web interface so developers can have a quick
   1.120 +overview of the last build results. The Tazbb package provides a PHP web interface,
   1.121 +CSS stylesheets and images installed by default in <code>/var/lib/tazbb/web</code>.
   1.122 +A symlink is created in <code>/var/www/vhosts</code> by a package, it provides
   1.123  easy access to the generated log files through a virtual host or you can use:
   1.124  http://localhost/vhosts/bb
   1.125  </p>
   1.126 @@ -122,7 +123,7 @@
   1.127  Mercurial offers a powerful mechanism to perform automated actions in response
   1.128  to events that occur in a repository. The name Mercurial uses for one of these
   1.129  actions is a hook. So Tazbb can be run each time a commit is done in the wok
   1.130 -throught a simple hook in the .hgrc file of the repository. Example :
   1.131 +through a simple hook in the .hgrc file of the repository. Example:
   1.132  </p>
   1.133  <pre class="script">
   1.134  [hooks]
   1.135 @@ -132,12 +133,12 @@
   1.136  <a name="cron"></a>
   1.137  <h3>Cron Job</h3>
   1.138  <p>
   1.139 -Tazbb can be run by a cron tab, so each new commit in the wok will cook the
   1.140 -correct package ech time you want, cron can also be used to refresh the report
   1.141 +Tazbb can also be run by a cron tab, so each new commit in the wok will cook the
   1.142 +correct package each time you want. Cron can also be used to refresh the report
   1.143  or run a full cook. If the last cook is not yet finished or if tazbb has been
   1.144 -run by hand and is still running, it will exit due to a lock file in /var/lock.
   1.145 -Example of cron job's to cook commit each 2 hour and cook all missing, modified
   1.146 -or unbuilt packages each night :
   1.147 +run by hand (and is still running), it will exit due to a lock file in /var/lock.
   1.148 +Example of a cron job to 'tazbb cook commit' every 2 hours and cook all missing, modified
   1.149 +or unbuilt packages each night:
   1.150  </p>
   1.151  <pre class="script">
   1.152  */2 * * * * /usr/bin/tazbb cook-commit

     2.1 --- a/en/doc/cookbook/build-host.html	Sat Jun 20 21:12:52 2009 +0000
     2.2 +++ b/en/doc/cookbook/build-host.html	Sun Jun 21 20:14:32 2009 +0000
     2.3 @@ -56,11 +56,10 @@
     2.4  <a name="tazdev"></a>
     2.5  <h3>Using tazdev</h3>
     2.6  <p>
     2.7 -To help maintain the mirror, flavors and other services, some tazdev
     2.8 -is used. It is mostly all configured for the cooking version. Usage :
     2.9 +To help maintain the mirror, flavors and other services, the tazdev command
    2.10 +is used. It is mostly configured for the cooking version. Usage:
    2.11  </p>
    2.12 -<pre>
    2.13 - $ tazdev usage
    2.14 +<pre> $ tazdev usage
    2.15  </pre>
    2.16  
    2.17  <a name="undigest-pkgs"></a>
    2.18 @@ -100,31 +99,28 @@
    2.19  <p>
    2.20  Everything is cooked in a chroot environment, the default path for the build
    2.21  wok is $CHROOT/home/slitaz/wok. Some changes can be made directly in this wok: the
    2.22 -real Hg is copied in the chroot by tazbb (Build Bot). To chroot in cooking :
    2.23 +real Hg is copied in the chroot by tazbb (Build Bot). To chroot in cooking:
    2.24  </p>
    2.25 -<pre>
    2.26 - # tazdev chroot
    2.27 +<pre> # tazdev chroot
    2.28  </pre>
    2.29  <p>
    2.30 -Cook all last commited packages or cook everything with 'cook-all', note
    2.31 +Cook all the last commited packages or cook everything with 'cook-all', note
    2.32  that comparison it not required if you know which packages to cook. If you
    2.33 -want to force a cook of some package by tazbb you can clean then with tazwok.
    2.34 -By default cook only last commit :
    2.35 +want to force the cooking of some packages by tazbb, you can then clean with tazwok.
    2.36 +By default tazbb cooks only last the commit:
    2.37  </p>
    2.38 -<pre>
    2.39 - /# tazbb cook-commit
    2.40 +<pre> /# tazbb cook-commit
    2.41  </pre>
    2.42  <p>
    2.43 -If needed (tazbb does it automaticaly) you can remove all the old packages
    2.44 +If needed (tazbb does this automatically), you can remove all the old packages
    2.45  and then rebuild the lists manually:
    2.46  </p>
    2.47 -<pre>
    2.48 - /# tazbb clean-up
    2.49 +<pre> /# tazbb clean-up
    2.50   /# tazwok gen-list --text
    2.51   /# exit
    2.52  </pre>
    2.53  <p>
    2.54 -If you have write access to the mirror you can make a dry-push to check
    2.55 +If you have write access to the mirror, you can make a dry-push to check
    2.56  and then upload; push will also remove any old packages on the mirror.
    2.57  </p>
    2.58  
    2.59 @@ -134,8 +130,7 @@
    2.60  Packages for the stable release are also built in a chroot environment like
    2.61  the Cooking packages:
    2.62  </p>
    2.63 -<pre>
    2.64 - # tazdev chroot stable
    2.65 +<pre> # tazdev chroot stable
    2.66  </pre>
    2.67  
    2.68  <a name="mirror-up"></a>
    2.69 @@ -143,8 +138,7 @@
    2.70  <p>
    2.71  Mirror maintainers can upload by hand with tazdev (-dp for a dry push):
    2.72  </p>
    2.73 -<pre>
    2.74 - # tazdev -p $USER
    2.75 +<pre> # tazdev -p $USER
    2.76  </pre>
    2.77  
    2.78  <a name="website-up"></a>
    2.79 @@ -153,8 +147,7 @@
    2.80  The Website and packages web interface are updated nightly by cron and can
    2.81  also be updated by hand (used on the day of release for example):
    2.82  </p>
    2.83 -<pre>
    2.84 - # tazdev update-www
    2.85 +<pre> # tazdev update-www
    2.86  </pre>
    2.87  
    2.88  <!-- End of content -->