A utility belt to make the Chicken hacker's life easier.
chicken-belt currently includes three programs:
- chicken-select, chicken-build
- These programs can be used to manage a repository of Chicken installations pointed to by the environment variable CHICKENS (~/chickens by default) referred to as coop. Each installation resides in a sub-directory of CHICKENS.
- This program helps with hatching new eggs.
This program is used to select a Chicken installation from your coop. It will present you with a list of available Chickens indexed by number. The currently selected Chicken (if any) is highlighted by a leading arrow (->). Selecting an installation by index will create a symlink for its directory to $CHICKENS/use-this. Alternatively you can pass the name of a Chicken version as an argument to chicken-select in order to select it (available since version 0.0.8). For convenience, place $CHICKENS/use-this/bin in your PATH to have the currently selected Chicken readily available.
- verbose mode; displays additional information about the Chickens in the coop
This program is used to conveniently build a Chicken from source and install it to your coop. The only required argument is the name for the Chicken installation. It will be used as the sub-directory name in your coop and must be given as the last argument of the command line. The resulting path will then be set as the PREFIX when make and make install are excuted. Note that you can set any other environment variables to make by just setting them when running chicken-build. In fact, you still have to set the PLATFORM variable this way (see the example below).
- -b, --bootstrap
- build and use a bootstrap Chicken compiler, i.e. run make boot-chicken and set CHICKEN=./chicken-boot for the remainig build process.
- -c, --chicken CHICKEN_NAME
- use $CHICKENS/CHICKEN_NAME/bin/chicken for compiling; when passed together with -b, it will be used for make boot-chicken only (the latter is possible since version 0.0.10)
- -n, --no-spotless
- don't run make spotless before building
- -t, --test
- test the build after installation via make check (available since version 0.0.10)
- -d, --debug
- make a debug build, i.e. set DEBUGBUILD=1
- -h, --help
- show help
tar zxf chicken-4.7.0.tar.gz cd chicken-4.7.0 PLATFORM=linux chicken-build -b 4.7.0
This will build Chicken 4.7.0 for Linux using a bootstrap compiler. The result will be installed to $CHICKEN/4.7.0, i.e. ~/chickens/4.7.0 by default. The build sequence executed by this chicken-build incantation is:
make PLATFORM=linux spotless make PLATFORM=linux boot-chicken make PLATFORM=linux spotless make PLATFORM=linux CHICKEN=./chicken-boot PREFIX=$CHICKENS/4.7.0 make PLATFORM=linux CHICKEN=./chicken-boot PREFIX=$CHICKENS/4.7.0 install
Alternatively, without bootstrap compiler:
PLATFORM=linux chicken-build 4.7.0
make PLATFORM=linux spotless make PLATFORM=linux PREFIX=$CHICKENS/4.7.0 make PLATFORM=linux PREFIX=$CHICKENS/4.7.0 install
If you want to update a version that you have previously installed with chicken-build, all you have to do is run chicken-build in the new directory with the name of the build you want to update. You will be asked if you want to purge the previous installation. It's safe to answer yes here, since it will only purge the old installation if the new version has been built successfully.
The chicken-hatch program helps you to hatch new eggs. The only mandatory command line option is the egg's name, everything else will be prompted for. The functionality is currently very limited but it will hopefully be improved in the near future. This program has been included in chicken-belt since version 0.0.6.
chicken-hatch [OPTIONS] egg-name
If you don't know what categories are available or which license to choose, you might want to invoke chicken-hatch without any options. It will then prompt you interactively for the needed information.
- -c, --category
- the egg's category
- -l, --license
- the license the egg can be copied and used under
- -h, --help
- show help
Copyright (c) 2011-2018, Christian Kellermann, Moritz Heidkamp All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.