cookutils view README @ rev 20
Explain receipt variable in README and small fix to CGI
| author | Christophe Lincoln <pankso@slitaz.org> |
|---|---|
| date | Thu May 05 22:27:09 2011 +0200 (2011-05-05) |
| parents | 2c9e9e81dd35 |
| children | 0eb341935f31 |
line source
1 SliTaz Cookutils
2 ================================================================================
5 The SliTaz Cookutils provide tools and utils to build SliTaz packages.
8 cook
9 ----
10 The cook tool should be used in a chroot environment, simply use the command
11 'tazdev gen-chroot' to build one. You can also build package directly but
12 build deps will not be handled correctly since cook will install missing
13 packages to perform a build and then remove them only if there wasn't
14 installed before, this way we can keep a clean build environment.
16 We use standard SliTaz path to work such as /home/slitaz/wok, if you work on
17 cooking from stable or want to keep a clean system: create a chroot.
19 Cook features:
21 * Setup a build env
22 * Check and install missing build deps
23 * Compile and generate the package
24 * Remove installed build deps
25 * Provide a log for each cook
26 * Clean a package in the wok
28 Cook does not:
30 * Depends on Hg but can use it to manage a wok
31 * Do complex work about compiling the all system from source
32 * Check build deps for you, use: BUILD_DEPENDS
33 If all deps are also build deps do: BUILD_DEPENDS="$DEPENDS"
34 * The work of a Build Bot, unix philosophy: one tool for one task
35 * Cook a package if you receipt is crappy :-)
37 Cook variables used in receipt:
39 * $src : Path to package source: wok/pkg/source
40 * $stuff : Path to package stuff: wok/pkg/stuff
41 * $fs : Path to package file system: wok/pkg/taz/*/fs
42 * $install : Path to all installed files by the package
43 Old style is _pkg and cook is compatible
45 Cook also manage packages list so they can be used for a personnal packages
46 repository or sent to the official mirror. We create and use:
48 * packages.list Simple list of package-version
49 * packages.md5 MD5sum list of all packages
50 * packages.desc Packages with name, version, category, desc
51 * packages.equiv Equivalent paclages list
52 * files.list.lzma A files provides by all packages
55 cooker
56 ------
57 The Cooker is a Build Bot who automate the build process but dont do the diner
58 for you! We need quality receipt to cook succefully and the goal is not to have
59 a bloated script so please Keep It Short and Simple.
61 Cmdline tool : /usr/bin/cooker
62 Web interface : /var/www/cgi-bin/cooker
63 Cache folder : /home/slitaz/cache
65 The web interface consist in one CGI script, 2 xHTML files and a CSS style.
66 Cook log can are produced by cook and the cooker just act as a fronted to
67 check them in a nice way.
70 ================================================================================