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