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