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