# HG changeset patch # User Paul Issott # Date 1304721669 -3600 # Node ID a491bec2d20aa3e7a423acfbde66fa344dcfd00e # Parent 302a81b24e6ba6686a4174d62008cf90fa4f1aaa Tiny edits diff -r 302a81b24e6b -r a491bec2d20a README --- a/README Fri May 06 21:43:14 2011 +0200 +++ b/README Fri May 06 23:41:09 2011 +0100 @@ -7,13 +7,13 @@ Cook -------------------------------------------------------------------------------- -The cook tool should be used in a chroot environment, simply use the command -'tazdev gen-chroot' to build one. You can also build package directly but +The cook tool should be used in a chroot environment: simply use the command +'tazdev gen-chroot' to build one. You can also build packages directly but build deps will not be handled correctly since cook will install missing -packages to perform a build and then remove them only if there wasn't +packages to perform a build and then remove them only if they were not installed before, this way we can keep a clean build environment. -We use standard SliTaz path to work such as /home/slitaz/wok, if you work on +We use standard SliTaz paths to work such as /home/slitaz/wok, if you work on cooking from stable or want to keep a clean system: create a chroot. Cook features: @@ -28,12 +28,12 @@ Cook does not: - * Depends on Hg but can use it to manage a wok - * Do complex work about compiling the all system from source + * Depend on Hg but can use it to manage a wok + * Do complex work like compiling the whole system from source * Check build deps for you, use: BUILD_DEPENDS If all deps are also build deps do: BUILD_DEPENDS="$DEPENDS" * The work of a Build Bot, unix philosophy: one tool for one task - * Cook a package if you receipt is crappy :-) + * Cook a package if your receipt is crappy :-) Cook variables used in receipt: @@ -43,56 +43,56 @@ * $install : Path to all installed files by the package Old style is $_pkg and cook is compatible -Cook also manage packages list so they can be used for a personnal packages +Cook also manages packages lists so they can be used for a personal packages repository or sent to the official mirror. We create and use: - * packages.list Simple list of package-version + * packages.list Simple list of package-versions * packages.md5 MD5sum list of all packages * packages.desc Packages with name, version, category, desc - * packages.equiv Equivalent paclages list - * files.list.lzma A files provides by all packages + * packages.equiv Equivalent packages list + * files.list.lzma A list of files provided by all packages Cooker -------------------------------------------------------------------------------- -The Cooker is a Build Bot who automate the build process but dont do the diner -for you! We need quality receipt to cook succefully and the goal is not to have +The Cooker is a Build Bot which automates the build process but doesn't make the dinner +for you! We need quality receipts to cook succesfully and the goal is not to have a bloated script so please Keep It Short and Simple. Cmdline tool : /usr/bin/cooker Web interface : /var/www/cgi-bin/cooker Cache folder : /home/slitaz/cache -The web interface consist in one CGI script and one CSS style. Cook log can -are produced by cook and the cooker just act as a fronted to check them in -a nice way. Web interface also hightligh success and error, can show receipt +The web interface consists of one CGI script and one CSS style. Cook logs can +be produced by cook and the cooker just acts as a fronted to check them in +a nice way. A web interface also highlights success and error and can show receipts and the cooker logs such as the last ordered list or commits check. Toolchain -------------------------------------------------------------------------------- -The rebuild the full SliTaz toolchain at once cook and the Cooker will use the -slitaz-toolchain package. No built-in code to manage that since it is not a -common task. The toolchain package will built all needed package in the correct -order, wich is very important. +To rebuild the full SliTaz toolchain at once - cook and the Cooker will use the +slitaz-toolchain package. No built-in code manages that since it is not a +common task. The toolchain package will build all needed packages in the correct +order, which is very important. Coding style -------------------------------------------------------------------------------- Here are the cookutils coding style notes, follow them if you want your code -include in the package. +included in the package. * In all cases: KISS - * Use tab and not space to ident - * Use name rater than $1 $2 $2 - * Variables from config file are $UPERCASE + * Use tab and not space to indent + * Use names rather than $1 $2 $3 + * Variables from config file are $UPPERCASE * Variables initialized by cook are $lowercase - * Function can be a single word or use_underline() + * Functions can be a single word or use_underline() my_function() { echo "Hello World" } * Use $(command) and not: `command` - * Cook use gettext for messages, not the cooker + * Cook uses gettext for messages, not the cooker * If you add a feature, add also the doc to explain it * Use clean case with space before case end ;; case "$pkg" in diff -r 302a81b24e6b -r a491bec2d20a cook.conf --- a/cook.conf Fri May 06 21:43:14 2011 +0200 +++ b/cook.conf Fri May 06 23:41:09 2011 +0100 @@ -4,7 +4,7 @@ # SliTaz working directory SLITAZ="/home/slitaz" -# Directories path's. +# Directory paths. WOK="$SLITAZ/wok" PKGS="$SLITAZ/packages" SRC="$SLITAZ/src" diff -r 302a81b24e6b -r a491bec2d20a cook.site --- a/cook.site Fri May 06 21:43:14 2011 +0200 +++ b/cook.site Fri May 06 23:41:09 2011 +0100 @@ -1,13 +1,13 @@ # /etc/slitaz/cook.site: Default options passed to ./configure in SliTaz # # This file is used since we can't export these variables, but configure -# handle CONFIG_SITE and will source this file automaticaly if set. +# handles CONFIG_SITE and will source this file automatically if set. # # If you want to use your own cook.site, you can use: # export CONFIG_SITE=config.site in compile_rules of a receipt. # -# Some old configure use "${prefix}" instead of "${datarootdir}". +# Some old configure(s) use "${prefix}" instead of "${datarootdir}". if echo "$localedir" | grep -q \${prefix}; then localedir=$( echo "$localedir" | sed 's/${prefix}/${datarootdir}/') fi