README in autobuild-0.4 vs README in autobuild-0.5

- old
+ new

@@ -107,10 +107,11 @@ == Autobuild configuration (<tt>autobuild</tt>) === Misc options *update*:: if false, do not update the packages that are already imported (default: true). You can also use the <tt>--no-update</tt> on the command line + === Directories (<tt>autobuild/srcdir</tt>, <tt>autobuild/prefix</tt> and <tt>autobuild/logdir</tt>) *srcdir*:: the path where programs are to be imported. See <b>Packages configuration</b> for more information on how this option is used. *prefix*:: the path where programs are to be installed. See <b>Packages configuration</b> for more information on how this option is used. @@ -142,34 +143,31 @@ LD_LIBRARY_PATH="" PKG_CONFIG_PATH="" === Mail (<tt>autobuild/mail</tt>) -If you want to receive a mail when the build has finished (on success and failures), set -at least the +to+ option, like this: +Use this options if you want to receive a mail when the build has finished (on success and failures) autobuild: - mail: - from: autobuild@mymachine.rubyrules.org - to: myself+autobuild@rubyrules.org - smtp: localhost + mail: true -Other options are: -*from*:: what to set in the <tt>From:</tt> field, default is <tt>autobuild@hostname</tt> +Valid options are: +*to*:: the mail destination, default is <tt>user@hostname</tt> (for instance sylvain@localhost for a user 'sylvain') +*from*:: the mail source, default is <tt>user@hostname</tt> *smtp*:: the stmp server to use. Default is +localhost+ +*port*:: the port the server is running on. Default is the smtp port (25) All log files relative to the current build are attached to the mail. - == Configuring packages (<tt>packages/*</tt>) === The <tt>packages/config</tt> section If you want to add common options in each package, just set it them here. Note that the options -are /merged/ in the package config. It neither replaces the values in the package nor be replaced -by them. The merging strategy depends on the way the <tt>common</tt> is specified: -* if it is an array, the package option is converted to an array and the common option is appended -* if it is a string, the package option is converted to a string and the common option is appended +are /merged/ in the package config. It neither replaces the values in the package nor the package +options replaces them. The merging strategy depends on the way the option is specified in this common section: +* if it is an array, the package option is converted to an array and the common options are appended +* if it is a string, the package option is converted to a string and the common option are appended with a space inserted between the two * if it is a boolean value, it is <em>overriden</em> by the package value * any other values are forbidden To ease the config file writing, all options that accept arrays also accept a string when there @@ -229,10 +227,26 @@ source: [ $my_home_repository, /trunk/foo ] *svnup*:: options to add to svn up. Defaults to '' *svnco*:: options to add to svn co. Defaults to '' +=== Tar (<tt>type: tar</tt>) +This importer gets a tarball file, which may be on a remote server, and un-tars +it. For now, it cannot determine itself what is the directory included in the tarball, +so you should set the srcdir: appropriately. + +For instance, a tarball with one directory <tt>package-0.1</tt> in it will +need a <tt>srcdir</tt> option of <tt>package-0.1</tt>. If you do +not set +srcdir+, autobuild will untar the package in the global srcdir +(as intended) but will search for <tt>$global_srcdir/package</tt> + +*source*:: the source URL. For now, http, ftp and file URLs are supported +*cachedir*:: the directory where the local copy of the file should be saved + (for http and ftp URLs only) + + + == Available package types (<tt>packages/</tt><em>name</em><tt>/type</tt>) === Source only (<tt>type: import</tt>) Use +import+ if you need the package sources but don't need to build it. You just need to set up the importer and +srcdir+. +prefix+ is ignored. @@ -273,49 +287,18 @@ programs: make: gnumake ==== Other options -*builddir*:: the directory where the build takes place. For now, it has to be a relative path, - which is added to the import dir. The default value is "build" +*builddir*:: the directory where the build takes place. For now, it has to be a relative path, + which will be considered relative to the source directory. *configureflags*:: array of options to add to the +configure+ command line configureflags: [ --with-bar-source=$srcdir/$bar_srcdir ] depends: bar = Running autobuild in daemon mode The <tt>--daemon</tt> command line options makes autobuild go into daemon mode. -= Changes -== 0.3 to 0.4 -* added support to split import and build. For instance - - whole_tree: - type: import - import: cvs - source: [ a, repository ] - - package1: - type: autotools - srcdir: whole_tree/package1 - depends: whole_tree - - package2: - type: autotools - srcdir: whole_tree/package2 - depends: whole_tree - - Now works well - -* the <tt>autotools</tt> package has now an <tt>autogen</tt> options, which gives a name for the script - to run to create the autoconf environment -* renamed 'genomflags' -> 'genflags' -* variable interpolation checks for environment variables -* bugfixes -== 0.2 to 0.3 -* added support for patching source code. Add patch: [ patches ] to the package configuration -* renamed autobuild-config, common-config and clean-log to autobuild, common and clean_log. Autobuild - warns if it finds one the previous spelling but ignores it anyway - = Copyright and license Author:: Sylvain Joyeux <sylvain.joyeux@m4x.org> Copyright:: Copyright (c) 2005 Sylvain Joyeux License:: GPL