cookutils annotate doc/cookutils.en.html @ rev 197

Update docs and tiny edits
author Paul Issott <paul@slitaz.org>
date Sat May 21 18:17:58 2011 +0100 (2011-05-21)
parents 51706736c5f8
children 77037ae33127
rev   line source
pankso@19 1 <!DOCTYPE html>
pankso@19 2 <html xmlns="http://www.w3.org/1999/xhtml">
pankso@19 3 <head>
pankso@19 4 <title>Cookutils Documentation</title>
pankso@19 5 <meta charset="utf-8" />
pankso@19 6 <link rel="stylesheet" type="text/css" href="style.css" />
pankso@19 7 </head>
pankso@19 8 <body>
pankso@19 9
pankso@19 10 <div id="header">
pankso@19 11 <h1>Cookutils Documentation</h1>
pankso@19 12 </div>
pankso@19 13
pankso@19 14 <!-- Start content -->
pankso@19 15 <div id="content">
pankso@19 16
pankso@19 17 <h2>SliTaz Cook &amp; Cooker</h2>
pankso@19 18
pankso@19 19 <p>
paul@53 20 The SliTaz Cookutils provide tools and utils to help build SliTaz packages. They
pankso@19 21 are easy to use and learn, fast and light. You will be able to create SliTaz
paul@53 22 packages in a few commands. The cookutils provide the 'cook' utility and the
pankso@19 23 <a href="#cooker">Cooker</a>.
pankso@19 24 </p>
pankso@19 25 <p>
paul@53 26 Cook lets you compile and create a package, provide a log file and check the
pankso@19 27 receipt/package quality. The Cooker is a build bot with more automation
paul@179 28 and can be used as a frontend to cook since it provides a CGI/web interface
paul@53 29 which lets you view cook logs in a nice and colored way. Cook and the Cooker
paul@179 30 use the same DB files and wok, they both share <a href="#blocked">blocked</a>
paul@53 31 and broken packages as well as any activity.
pankso@19 32 </p>
pankso@19 33
pankso@27 34 <h3>Cook usage</h3>
pankso@27 35 <p>
paul@53 36 Cook provides a small built-in help usage that you can display with the
paul@53 37 command 'usage'. It also has some options to perform special tasks on
paul@174 38 a package before cooking it or afterwards. To get help and usage:
pankso@27 39 </p>
pankso@27 40 <pre>
pankso@27 41 # cook usage
pankso@27 42 </pre>
pankso@27 43
paul@53 44 <h3>Howto</h3>
pankso@19 45 <p>
paul@53 46 The first thing you will have to do before building packages is setup
paul@53 47 your environment. The 2 recommended ways of working: cook directly on host
pankso@19 48 or cook in chroot to protect your host. In the case you want to work in a
paul@53 49 chroot you can install and use Tazdev to create one and chroot into it:
pankso@19 50 </p>
pankso@19 51 <pre>
pankso@19 52 # tazdev gen-chroot &amp;&amp; tazdev chroot
pankso@19 53 </pre>
pankso@27 54 <p>
paul@53 55 By default Tazdev creates a chroot in /home/slitaz/cooking/chroot but you
paul@53 56 can specify a custom path in the argument. The chroot location is not
pankso@40 57 important, when you will be in the chroot you will use standard SliTaz
paul@53 58 paths such as /home/slitaz/wok for the wok directory or /home/slitaz/log
paul@174 59 for all the cook logs. As usual you can display tazdev help usage with:
pankso@40 60 tazdev usage.
pankso@40 61 </p>
pankso@40 62 <p>
paul@53 63 When you use a chroot there are 2 special directories mounted with the bind
pankso@40 64 option: src and packages. The sources for all packages are stored by default
pankso@40 65 in /home/slitaz/src, this directory is mounted into the chroot so the utils
paul@53 66 can use them. This method lets you share sources between many chroots such
pankso@40 67 as one for cooking and one for stable. The packages directory default
pankso@40 68 location is: /home/slitaz/[version]/packages so they are not in the chroot
paul@53 69 and are safe in case the chroot is removed by error.
pankso@27 70 </p>
pankso@19 71
pankso@19 72 <h3>Getting started</h3>
pankso@19 73 <p>
paul@53 74 So you have decided the way you want to work, so lets prepare the cook environment.
paul@53 75 Cook uses the cook.conf configuration file, if you want to use custom paths for
paul@53 76 SliTaz directories and files, you'll have to modify it. The setup will create
paul@53 77 some directories and files to keep trace of activity and errors, all files
pankso@19 78 are pure plain text files that you can open in a text editor. To prepare
paul@53 79 your environment:
pankso@19 80 </p>
pankso@19 81 <pre>
pankso@19 82 # cook setup
pankso@19 83 </pre>
pankso@27 84 <p>
paul@53 85 The setup command has a --wok option which lets you clone a SliTaz wok while
paul@179 86 setting up your cook environment. Even if you are not yet an official developer
paul@53 87 you can clone it and use existing packages as an example to create your own.
pankso@27 88 To setup and clone the wok:
pankso@27 89 </p>
pankso@27 90 <pre>
pankso@27 91 # cook setup --wok
pankso@27 92 </pre>
pankso@19 93
pankso@19 94 <h3>Test your environment</h3>
pankso@19 95 <p>
paul@53 96 Cook provides a test command which will create a package and cook it. This lets
paul@174 97 you see if your environment is working and it provides an example package with
paul@53 98 a receipt. The dummy package is named 'cooktest' and can be removed after
paul@174 99 testing. To cook the test package:
pankso@19 100 </p>
pankso@19 101 <pre>
pankso@19 102 # cook test
pankso@19 103 </pre>
pankso@19 104
pankso@19 105 <h3>Create and cook</h3>
pankso@19 106 <p>
paul@174 107 If your environment is setup correctly you can start creating and compiling
paul@197 108 SliTaz packages from your wok. To create a new package with an empty receipt
paul@197 109 (you can also create a receipt interactively):
pankso@19 110 </p>
pankso@19 111 <pre>
pankso@19 112 # cook new pkgname
paul@197 113 # cook new pkgname --interactive
pankso@19 114 </pre>
pankso@19 115 <p>
paul@53 116 If you have just created a new package, you'll have to edit the receipt with your
paul@174 117 favorite text editor. When the receipt is ready or if you have an existing
paul@174 118 package, you can cook it:
pankso@19 119 </p>
pankso@19 120 <pre>
pankso@19 121 # cook pkgname
pankso@19 122 </pre>
pankso@19 123 <p>
paul@174 124 If all went well you will find your package in the $SLITAZ/packages
paul@53 125 directory and any produced files in $SLITAZ/wok/pkgname.
pankso@39 126 </p>
pankso@39 127
pankso@39 128 <h3>Cook and install</h3>
pankso@39 129 <p>
pankso@39 130 If you want to cook and install the package in one command:
pankso@19 131 </p>
pankso@19 132 <pre>
pankso@19 133 # cook pkgname --install
pankso@19 134 </pre>
pankso@19 135
pankso@39 136 <h3>Get sources</h3>
pankso@39 137 <p>
paul@53 138 If you want or need to download only the source of a package without
paul@53 139 building it, you can use the option --getsrc as below:
pankso@39 140 </p>
pankso@39 141 <pre>
pankso@39 142 # cook pkgname --getsrc
pankso@39 143 </pre>
pankso@39 144
pankso@19 145 <h3>Clean packages</h3>
pankso@19 146 <p>
paul@53 147 After compilation and packaging there are several files in the wok that take up
pankso@19 148 disk space. To clean a single package:
pankso@19 149 </p>
pankso@19 150 <pre>
pankso@19 151 # cook pkgname --clean
pankso@19 152 </pre>
pankso@19 153 <p>
pankso@19 154 You can also clean the full wok at once or you can choose to keep SliTaz
pankso@19 155 related files and just remove the source:
pankso@19 156 </p>
pankso@19 157 <pre>
pankso@19 158 # cook clean-wok
pankso@19 159 # cook clean-src
pankso@19 160 </pre>
pankso@19 161
pankso@69 162 <h3>Search</h3>
pankso@69 163 <p>
paul@89 164 Cook provides a simple search function to quickly find a package in the
paul@89 165 wok. It uses grep and so supports regular expressions:
pankso@69 166 </p>
pankso@69 167 <pre>
pankso@69 168 # cook search busybox
pankso@69 169 </pre>
pankso@69 170
paul@53 171 <h3>Packages list</h3>
pankso@19 172 <p>
paul@53 173 Cook can list packages in the wok and also create a suitable packages list
paul@175 174 for Tazpkg. This lets you create a local packages repository quite easily
paul@53 175 and is used to create the official SliTaz packages list found on the mirrors.
paul@53 176 To list the current wok used by cook (you don't need to be root):
pankso@19 177 </p>
pankso@19 178 <pre>
pankso@19 179 $ cook list-wok
pankso@19 180 </pre>
pankso@19 181 <p>
paul@53 182 To create a packages list:
pankso@19 183 </p>
pankso@19 184 <pre>
pankso@19 185 # cook pkglist
pankso@19 186 </pre>
pankso@19 187
pankso@19 188 <a name="cooker"></a>
pankso@19 189 <h3>The Cooker</h3>
pankso@19 190 <p>
paul@53 191 The Cooker is a Build Bot, its first function is to check for commits in a wok,
pankso@19 192 create an ordered cooklist and cook all modified packages. It can also be
paul@53 193 used as a frontend to cook since they both use the same files. The Cooker can
paul@53 194 also be used to cook a big list of packages at once such as all the packages
paul@53 195 in a flavor. The Cooker provides a nice CGI/Web interface that works by
paul@53 196 default on any SliTaz system since it provides CGI support via the Busybox httpd
pankso@19 197 web server.
pankso@19 198 </p>
pankso@27 199 <p>
paul@53 200 The Cooker provides a small built-in help usage and short command switch.
pankso@31 201 For example to display usage you can use:
pankso@27 202 </p>
pankso@27 203 <pre>
pankso@31 204 # cooker usage
pankso@31 205 # cooker -u
pankso@27 206 </pre>
pankso@19 207
pankso@19 208 <h3>Cooker setup</h3>
pankso@19 209 <p>
paul@53 210 Like cook, the Cooker needs a working environment before starting to use it.
paul@53 211 The main difference with the cook environment is that the Cooker needs 2 woks.
paul@53 212 One Hg and clean wok as a reference and one build wok. In this way it is easy
paul@53 213 to compare both woks and get modifications. If you already have a cook
paul@53 214 environment, you must move your wok before setting up the Cooker or it
pankso@31 215 will complain. Setup will also install a set of development packages that
pankso@31 216 can be configured in the cook.conf configuration file and the variable
pankso@31 217 SETUP_PKGS. To setup your cooker environment:
pankso@19 218 </p>
pankso@19 219 <pre>
pankso@31 220 # cooker setup
pankso@19 221 </pre>
pankso@19 222 <p>
paul@174 223 If all went well you now have 2 woks, base development packages installed
paul@53 224 and all needed files created. The default behavior is to check for commits,
pankso@19 225 you can run a test:
pankso@19 226 </p>
pankso@19 227 <pre>
pankso@19 228 # cooker
pankso@19 229 </pre>
pankso@19 230
pankso@19 231 <h3>Cooker cook</h3>
pankso@19 232 <p>
paul@53 233 Again, 2 ways to work now: make changes in the clean Hg wok and launch the
paul@53 234 cooker without any arguments or cook packages manually. The cooker lets you
paul@53 235 cook a single package or all packages of a category or a flavor. You can also
pankso@19 236 try to build all unbuilt packages, but be aware the Cooker was not designed
paul@174 237 to handle thousands of packages.
pankso@19 238 </p>
pankso@19 239 <p>
paul@53 240 To cook a single package which is the same as 'cook pkgname' but with more
pankso@19 241 logs:
pankso@19 242 </p>
pankso@19 243 <pre>
pankso@31 244 # cooker pkg pkgname
pankso@19 245 </pre>
pankso@19 246 <p>
pankso@19 247 To cook more than one package at once you have different kind of choices.
paul@53 248 You can use an existing package such as used for Live flavors, you can also
paul@53 249 use a custom list using the package names listed line by line. Finally you can
paul@53 250 build all packages of a category.
pankso@19 251 </p>
pankso@19 252 <pre>
pankso@31 253 # cooker flavor [name]
pankso@31 254 # cooker list [/path/to/cooklist]
pankso@31 255 # cooker cat [category]
pankso@19 256 </pre>
pankso@79 257 <p>
paul@174 258 The Cooker lets you also recook a specific Hg revision. It's useful in
paul@89 259 production so that if the Build Bot was interrupted while cooking commits, you
pankso@79 260 can then cook packages manually:
pankso@79 261 </p>
pankso@79 262 <pre>
pankso@79 263 # cooker rev 9496
pankso@79 264 </pre>
pankso@19 265
pankso@49 266 <a name="blocked"></a>
pankso@49 267 <h3>Blocked packages</h3>
pankso@49 268 <p>
paul@53 269 Cook and the Cooker handle a file with a list of blocked package so they will
paul@53 270 not cook when commits happen or if a cooklist is used. This is very useful
pankso@49 271 for a Cooker Build Bot in production. When you block or unblock a package
pankso@49 272 you can add a note to the cooknotes. Blocking packages example:
pankso@49 273 </p>
pankso@49 274 <pre>
pankso@49 275 # cook pkgname --block
pankso@49 276 # cooker block pkgname
pankso@49 277 # cooker -n "Blocked pkgname note"
pankso@49 278 </pre>
pankso@49 279 <p>
pankso@49 280 The list of blocked packages are also displayed on the Cooker web interface.
pankso@49 281 To unblock a package you have to use the unblock command or cook --unblock
pankso@49 282 option:
pankso@49 283 </p>
pankso@49 284 <pre>
pankso@49 285 # cook pkgname --unblock
pankso@49 286 # cooker unblock pkgname
pankso@49 287 </pre>
pankso@49 288
pankso@19 289 <h3>Cooker CGI/Web</h3>
pankso@19 290 <p>
paul@53 291 To let you view log files in a nice way, keep trace of activity and help find
pankso@27 292 errors, you can use the Cooker Web interface located by default in the folder
paul@53 293 /var/www/cgi-bin/cooker. If you don't use a chroot and the Busybox httpd
pankso@27 294 web server is running, the web interface will work without configuration and
pankso@27 295 should be reachable at: <a href="http://localhost/cgi-bin/cooker/cooker.cgi">
pankso@19 296 http://localhost/cgi-bin/cooker/cooker.cgi</a>
pankso@19 297 </p>
pankso@19 298 <p>
pankso@19 299 If you used a chroot environment, you should also install cookutils on your
pankso@19 300 host and modify the SLITAZ path variable. A standard working way is to have
pankso@19 301 a chroot in:
pankso@19 302 </p>
pankso@19 303 <pre>
pankso@19 304 /home/slitaz/cooking/chroot
pankso@19 305 </pre>
pankso@19 306 <p>
paul@53 307 With /etc/slitaz/cook.conf modified as below:
pankso@19 308 </p>
pankso@19 309 <pre>
pankso@19 310 SLITAZ="/home/slitaz/cooking/chroot/home/slitaz"
pankso@19 311 </pre>
pankso@19 312 <p>
pankso@19 313 Note: It's not obligatory to install the cookutils on your host to use the
pankso@19 314 web interface, you can also copy the cooker.cgi and style.css files for
paul@132 315 example into your ~/Public directory and use a custom cook.conf with it. The
paul@53 316 advantage of installing cookutils on the host is to get regular updates via
paul@53 317 the Tazpkg packages manager. Say you have cloned or downloaded the cookutils:
pankso@19 318 </p>
pankso@19 319 <pre>
pankso@27 320 $ cp -a cookutils/web ~/Public/cgi-bin/cooker
pankso@27 321 $ cp -f cookutils/cook.conf ~/Public/cgi-bin/cooker
pankso@19 322 </pre>
pankso@19 323 <p>
paul@53 324 Edit the configuration file: ~/Public/cgi-bin/cooker/cook.conf to set your
paul@53 325 SLITAZ path and you're all done!
pankso@19 326 </p>
pankso@19 327
pankso@24 328 <h3>Cooknotes</h3>
pankso@24 329 <p>
paul@53 330 The cooknotes feature lets you write small personal notes about packaging
paul@53 331 and is useful for collaboration. The cooknotes was coded to let the SliTaz
paul@53 332 Cooker bot maintainers share notes between themselves and other contributors.
paul@53 333 The Cooker can block a package's build or recook packages manually, for example
paul@53 334 it's nice to make a note if a package is blocked so that the maintainer knows why
pankso@24 335 admin did that. Cooknotes are displayed on the web interface and can be
paul@53 336 checked from a cmdline:
pankso@24 337 </p>
pankso@24 338 <pre>
pankso@31 339 # cooker note "Blocked pkgname due to heavy CPU load"
pankso@31 340 # cooker notes
pankso@24 341 </pre>
pankso@19 342
pankso@59 343 <h3>Cooker as a Build Bot</h3>
pankso@59 344 <p>
paul@62 345 The Cooker is designed to be a Built Bot for SliTaz, this means it monitors
paul@62 346 2 woks, updates the Hg wok, gets the differences and cooks all packages that
pankso@84 347 have been committed. The safer and cleaner way to run the Cooker as a Build
pankso@84 348 Bot with cron is to use a chroot environment, but it can run directly on the
pankso@84 349 host if you want.
pankso@84 350 </p>
pankso@84 351 <p>
pankso@84 352 To run The Cooker automatically you must use cron from the chroot and add a
paul@62 353 single line to root crontabs in /var/spool/cron/crontabs. Say you would like
paul@62 354 to run the Cooker every 2 hours:
pankso@59 355 </p>
pankso@59 356 <pre>
pankso@163 357 * */2 * * * /usr/bin/cooker
pankso@163 358 </pre>
pankso@163 359
pankso@163 360 <h3>Cooker BB started at boot</h3>
pankso@163 361 <p>
paul@168 362 The Cooker environment and cron task can automatically be started at boot time.
paul@168 363 You must have the cookutils-daemon installed on the host and use a standard SliTaz
paul@174 364 installation to make it work properly (cooking goes in /home/slitaz/cooking). The
paul@174 365 daemon script will mount any virtual filesystems if needed as well as source and
paul@174 366 packages. Source files are in /home/slitaz/src and bound into the chroot
paul@174 367 so you can share package's sources between several versions (stable, cooking,
paul@168 368 undigest). If the package is not yet installed:
pankso@166 369 </p>
pankso@166 370 <pre>
pankso@166 371 # tazpkg get-install cookutils-daemon
pankso@166 372 </pre>
pankso@166 373 <p>
pankso@166 374 To start the daemon you must have a cron file definition for
paul@168 375 root in the chroot, the daemon script works like all other system daemons
pankso@166 376 and can be handled with:
pankso@163 377 </p>
pankso@163 378 <pre>
pankso@163 379 # /etc/init.d/cooker [start|stop|restart]
pankso@59 380 </pre>
pankso@59 381
pankso@19 382 <!-- End content -->
pankso@19 383 </div>
pankso@19 384
pankso@19 385 <div id="footer">
pankso@19 386 Copyright &copy; 2011 SliTaz contributors
pankso@19 387 </div>
pankso@19 388
pankso@19 389 </body>
pankso@19 390 </html>
pankso@19 391