cookutils diff README @ rev 620

cook: kvers set from installed/linux-api-headers/receipt if no wok/linux/receipt
author Richard Dunbar <mojo@slitaz.org>
date Thu Dec 05 22:23:26 2013 +0000 (2013-12-05)
parents a8797a6edd21
children e599d64a084b
line diff
     1.1 --- a/README	Sat Jun 16 11:14:23 2012 +0100
     1.2 +++ b/README	Thu Dec 05 22:23:26 2013 +0000
     1.3 @@ -18,10 +18,10 @@
     1.4  
     1.5  Cook features:
     1.6  
     1.7 -    * Setup a build env
     1.8 -    * Check and install missing build deps
     1.9 +    * Setup a build environment
    1.10 +    * Check and install missing build dependencies
    1.11      * Compile and generate the package
    1.12 -    * Remove installed build deps
    1.13 +    * Remove installed build dependencies
    1.14      * Provide a log for each cook
    1.15      * Clean one or all packages in the wok
    1.16      * Check for receipt and package quality
    1.17 @@ -31,7 +31,7 @@
    1.18  
    1.19      * Depend on Hg but can use it to manage a wok
    1.20      * Do complex work like compiling the whole system from source in
    1.21 -      one command (but it can rebuild the full system step by step).
    1.22 +      one command (but it can rebuild the full system step by step)
    1.23      * Check build deps for you, use: BUILD_DEPENDS
    1.24      * The work of a Build Bot, unix philosophy: one tool for one task
    1.25      * Cook a package if your receipt is crappy :-)
    1.26 @@ -54,12 +54,12 @@
    1.27  Cook also manages packages lists so they can be used for a personal packages
    1.28  repository or sent to the official mirror. We create and use:
    1.29  
    1.30 -    * packages.list    Simple list of package-versions
    1.31 -    * packages.md5     MD5sum list of all packages
    1.32 -    * packages.txt     List of packages with version, desc and sizes
    1.33 -    * packages.desc    Packages with name, version, category, desc
    1.34 -    * packages.equiv   Equivalent packages list
    1.35 -    * files.list.lzma  A list of files provided by all packages
    1.36 +    * packages.list   : Simple list of package-versions
    1.37 +    * packages.md5    : MD5sum list of all packages
    1.38 +    * packages.txt    : List of packages with version, description and sizes
    1.39 +    * packages.desc   : Packages with name, version, category, description
    1.40 +    * packages.equiv  : Equivalent packages list
    1.41 +    * files.list.lzma : A list of files provided by all packages
    1.42  
    1.43  
    1.44  Cooker
    1.45 @@ -77,7 +77,7 @@
    1.46  a nice way. A web interface also highlights success and error and can show
    1.47  receipts and the cooker logs such as the last ordered list or commits check.
    1.48  
    1.49 -Database files in the cache folder
    1.50 +Database files in the cache folder:
    1.51  
    1.52      * activity   : Activity information for the web interface
    1.53      * blocked    : List of manually blocked packages
    1.54 @@ -86,7 +86,7 @@
    1.55      * cooklist   : Cooklist for unbuilt packages or custom commands
    1.56      * cooknotes  : All the notes added with 'cooker -n "My note"
    1.57      * installed* : Lists used to compare installed packages before and after
    1.58 -		   a package is cooked so we can remove them
    1.59 +                   a package is cooked so we can remove them
    1.60  
    1.61  The Cooker web interface can by highly customized through the CSS style and via
    1.62  an optional header.html file that must be in the same directory as the CGI
    1.63 @@ -121,27 +121,28 @@
    1.64  
    1.65  Cross compiling
    1.66  --------------------------------------------------------------------------------
    1.67 -Cookutils lets you cross compile a package for a specific architecture. Say you want
    1.68 -to build ARM binaries from a standard i486 machine. Cookutils provides helpers
    1.69 -for the ARM platform, but the first thing to do is compile a cross toolchain and
    1.70 -modify the main cook.conf variables to use a correct ARCH, CFLAGS and BUILD_SYSTEM
    1.71 +Cookutils lets you cross compile a package for a specific architecture. Say you
    1.72 +want to build ARM binaries from a standard i486 machine. Cookutils provides
    1.73 +helpers for the ARM platform, but the first thing to do is compile a cross
    1.74 +toolchain and modify the main cook.conf variables to use a correct ARCH, CFLAGS
    1.75 +and BUILD_SYSTEM
    1.76  
    1.77 -Cook handles HOST_ARCH and CROSS_* receipt variables. Some packages won't build or
    1.78 -are not packaged for an architecture and so cross compiling will fail if the
    1.79 +Cook handles HOST_ARCH and CROSS_* receipt variables. Some packages won't build
    1.80 +or are not packaged for an architecture and so cross compiling will fail if the
    1.81  package receipt has not been reviewed and includes HOST_ARCH. Here is an example
    1.82  and a list of cross variables:
    1.83  
    1.84  HOST_ARCH="i486 arm"
    1.85  CROSS_BUGS="Bugs description"
    1.86  
    1.87 -Before cross compiling, cook will automatically add cross-tools path to PATH, set
    1.88 -CC, AR, LD, etc and also export CROSS_COMPILE.
    1.89 +Before cross compiling, cook will automatically add cross-tools path to PATH,
    1.90 +set CC, AR, LD, etc and also export CROSS_COMPILE.
    1.91  
    1.92  
    1.93  Toolchain
    1.94  --------------------------------------------------------------------------------
    1.95  To rebuild the full SliTaz toolchain at once - cook and the Cooker will use the
    1.96 -slitaz-toolchain package. No built-in code manages that since it is not a
    1.97 +slitaz-toolchain package. No built-in code manages that since it is not a 
    1.98  common task. The toolchain package will build all needed packages in the correct
    1.99  order, which is very important.
   1.100  
   1.101 @@ -166,8 +167,8 @@
   1.102      * If you add a feature, add also the doc to explain it
   1.103      * Use clean case with space before case end ;;
   1.104        case "$pkg" in
   1.105 -	    a) echo "Hello World" ;;
   1.106 -	    *) continue ;;
   1.107 +        a) echo "Hello World" ;;
   1.108 +        *) continue ;;
   1.109        esac
   1.110      * Make commands and options as short as possible
   1.111      * Think to log everything to help debug