cookutils rev 38
Tiny edits
author | Paul Issott <paul@slitaz.org> |
---|---|
date | Fri May 06 23:41:09 2011 +0100 (2011-05-06) |
parents | 302a81b24e6b |
children | e1a3c5900648 |
files | README cook.conf cook.site |
line diff
1.1 --- a/README Fri May 06 21:43:14 2011 +0200 1.2 +++ b/README Fri May 06 23:41:09 2011 +0100 1.3 @@ -7,13 +7,13 @@ 1.4 1.5 Cook 1.6 -------------------------------------------------------------------------------- 1.7 -The cook tool should be used in a chroot environment, simply use the command 1.8 -'tazdev gen-chroot' to build one. You can also build package directly but 1.9 +The cook tool should be used in a chroot environment: simply use the command 1.10 +'tazdev gen-chroot' to build one. You can also build packages directly but 1.11 build deps will not be handled correctly since cook will install missing 1.12 -packages to perform a build and then remove them only if there wasn't 1.13 +packages to perform a build and then remove them only if they were not 1.14 installed before, this way we can keep a clean build environment. 1.15 1.16 -We use standard SliTaz path to work such as /home/slitaz/wok, if you work on 1.17 +We use standard SliTaz paths to work such as /home/slitaz/wok, if you work on 1.18 cooking from stable or want to keep a clean system: create a chroot. 1.19 1.20 Cook features: 1.21 @@ -28,12 +28,12 @@ 1.22 1.23 Cook does not: 1.24 1.25 - * Depends on Hg but can use it to manage a wok 1.26 - * Do complex work about compiling the all system from source 1.27 + * Depend on Hg but can use it to manage a wok 1.28 + * Do complex work like compiling the whole system from source 1.29 * Check build deps for you, use: BUILD_DEPENDS 1.30 If all deps are also build deps do: BUILD_DEPENDS="$DEPENDS" 1.31 * The work of a Build Bot, unix philosophy: one tool for one task 1.32 - * Cook a package if you receipt is crappy :-) 1.33 + * Cook a package if your receipt is crappy :-) 1.34 1.35 Cook variables used in receipt: 1.36 1.37 @@ -43,56 +43,56 @@ 1.38 * $install : Path to all installed files by the package 1.39 Old style is $_pkg and cook is compatible 1.40 1.41 -Cook also manage packages list so they can be used for a personnal packages 1.42 +Cook also manages packages lists so they can be used for a personal packages 1.43 repository or sent to the official mirror. We create and use: 1.44 1.45 - * packages.list Simple list of package-version 1.46 + * packages.list Simple list of package-versions 1.47 * packages.md5 MD5sum list of all packages 1.48 * packages.desc Packages with name, version, category, desc 1.49 - * packages.equiv Equivalent paclages list 1.50 - * files.list.lzma A files provides by all packages 1.51 + * packages.equiv Equivalent packages list 1.52 + * files.list.lzma A list of files provided by all packages 1.53 1.54 1.55 Cooker 1.56 -------------------------------------------------------------------------------- 1.57 -The Cooker is a Build Bot who automate the build process but dont do the diner 1.58 -for you! We need quality receipt to cook succefully and the goal is not to have 1.59 +The Cooker is a Build Bot which automates the build process but doesn't make the dinner 1.60 +for you! We need quality receipts to cook succesfully and the goal is not to have 1.61 a bloated script so please Keep It Short and Simple. 1.62 1.63 Cmdline tool : /usr/bin/cooker 1.64 Web interface : /var/www/cgi-bin/cooker 1.65 Cache folder : /home/slitaz/cache 1.66 1.67 -The web interface consist in one CGI script and one CSS style. Cook log can 1.68 -are produced by cook and the cooker just act as a fronted to check them in 1.69 -a nice way. Web interface also hightligh success and error, can show receipt 1.70 +The web interface consists of one CGI script and one CSS style. Cook logs can 1.71 +be produced by cook and the cooker just acts as a fronted to check them in 1.72 +a nice way. A web interface also highlights success and error and can show receipts 1.73 and the cooker logs such as the last ordered list or commits check. 1.74 1.75 1.76 Toolchain 1.77 -------------------------------------------------------------------------------- 1.78 -The rebuild the full SliTaz toolchain at once cook and the Cooker will use the 1.79 -slitaz-toolchain package. No built-in code to manage that since it is not a 1.80 -common task. The toolchain package will built all needed package in the correct 1.81 -order, wich is very important. 1.82 +To rebuild the full SliTaz toolchain at once - cook and the Cooker will use the 1.83 +slitaz-toolchain package. No built-in code manages that since it is not a 1.84 +common task. The toolchain package will build all needed packages in the correct 1.85 +order, which is very important. 1.86 1.87 1.88 Coding style 1.89 -------------------------------------------------------------------------------- 1.90 Here are the cookutils coding style notes, follow them if you want your code 1.91 -include in the package. 1.92 +included in the package. 1.93 1.94 * In all cases: KISS 1.95 - * Use tab and not space to ident 1.96 - * Use name rater than $1 $2 $2 1.97 - * Variables from config file are $UPERCASE 1.98 + * Use tab and not space to indent 1.99 + * Use names rather than $1 $2 $3 1.100 + * Variables from config file are $UPPERCASE 1.101 * Variables initialized by cook are $lowercase 1.102 - * Function can be a single word or use_underline() 1.103 + * Functions can be a single word or use_underline() 1.104 my_function() { 1.105 echo "Hello World" 1.106 } 1.107 * Use $(command) and not: `command` 1.108 - * Cook use gettext for messages, not the cooker 1.109 + * Cook uses gettext for messages, not the cooker 1.110 * If you add a feature, add also the doc to explain it 1.111 * Use clean case with space before case end ;; 1.112 case "$pkg" in
2.1 --- a/cook.conf Fri May 06 21:43:14 2011 +0200 2.2 +++ b/cook.conf Fri May 06 23:41:09 2011 +0100 2.3 @@ -4,7 +4,7 @@ 2.4 # SliTaz working directory 2.5 SLITAZ="/home/slitaz" 2.6 2.7 -# Directories path's. 2.8 +# Directory paths. 2.9 WOK="$SLITAZ/wok" 2.10 PKGS="$SLITAZ/packages" 2.11 SRC="$SLITAZ/src"
3.1 --- a/cook.site Fri May 06 21:43:14 2011 +0200 3.2 +++ b/cook.site Fri May 06 23:41:09 2011 +0100 3.3 @@ -1,13 +1,13 @@ 3.4 # /etc/slitaz/cook.site: Default options passed to ./configure in SliTaz 3.5 # 3.6 # This file is used since we can't export these variables, but configure 3.7 -# handle CONFIG_SITE and will source this file automaticaly if set. 3.8 +# handles CONFIG_SITE and will source this file automatically if set. 3.9 # 3.10 # If you want to use your own cook.site, you can use: 3.11 # export CONFIG_SITE=config.site in compile_rules of a receipt. 3.12 # 3.13 3.14 -# Some old configure use "${prefix}" instead of "${datarootdir}". 3.15 +# Some old configure(s) use "${prefix}" instead of "${datarootdir}". 3.16 if echo "$localedir" | grep -q \${prefix}; then 3.17 localedir=$( echo "$localedir" | sed 's/${prefix}/${datarootdir}/') 3.18 fi