Home

PDF version

1. 29 DISTFILES vial in 5 Il ieee OZ DISTFILES is set to the name of the archive to download This is appended to items in MASTER_SITES to form the URL Sl versionl range 1 int LASTPATCH 1 52 PATCHFILES 6 1 00 versionl Lines 32 and 33 specify the list of patch file names The Python function range is used this returns a list of numbers in the specified range up to and excluding the upper number Note the user of int to turn the patch number in LASTPATCH into an int type all Aap variables are strings for three patch files this could also have been typed but when the number of patches grows this mechanism is easier The example only works up to patch number 009 To make it work for numbers from 100 up to 999 versionl range 1 10 version2 range 10 100 version3 range 100 int LASTPATCH 1 PATCHFILES Ol WOSweesaioal 61 08 versigaz 6 1 8 Versioias 34 gt gt gt automatically inserted by aap makesum lt lt lt 30 do checksum 36 checksum S DISTDIR vim 6 1 tar bz2 md5 7f d0 915adc7c0dab8 97728842 68b030 37 checksum SPATCHDISTDIR 6 1 001 md5 97bdbe371953b9d25f006f8b58b53532 38 checksum SPATCHDISTDIR 6 1 002 md5 56455248658f019dcf3e2a56a470080 50 checksum SPATCHDISTDIR 6 1 003 md5 0e000edba66562473a5f1e9 b5b269bb8 40 gt gt gt end lt lt lt Chapter 11 A Ported Application 34 A A P Recipe Exec
2. attr val is an optional attribute that apply to the generated dependencies Use the scope attribute to specify a user scope to be used before other scopes except the local scope in the generated dependencies The target will be added to SINSTALL_DLL Use the installvar option to select another variable name Use installvar when installing the target is not wanted The target and intermediate files will be added to SCLEANFILES The source files will be added to DISTFILES except the ones with a nodist attribute Can only be used at the recipe level do action fname Execute an action The commands executed may depend on the types of the first input file and or the output file See Chapter 28 Customizing Filetype Detection and Actions Attributes just after the action except the options mentioned below are passed as variables to the build commands The name of the attribute is used as the name of the variable Prepending var_ is optional do build target prog foo c options The filetype attribute can be used to override the output filetype used to select the action to be executed Example filetype 2610 onile fileryss lildtoolexs SOlojecirs When this option is not used the filetype of the target is used The filetype of source files must be given with the source file The scope attribute has a special meaning define the user scope from which variables are obtained first Variables in this
3. ext SCVSUSER_AAP cvs a a p sf net cvsroot a a p You can see why this is specified in the recipe you wouldn t want to type this for commiting each change Distributing Your Project With CVS This is a short how to that explains how to start distributing a set of files and directories using CVS 1 Copy the files you want to distribute to a separate directory Mostly you have various files in your project for your own use that you don t want to distribute These can be backup files and snippets of code that you want to keep for later Since the cvs command below imports all files it can find you need to have a directory tree with exactly those files you want to store in CVS Best is to to make a copy of the project On Unix cp r projectdir tempdir Then delete all files you don t want to distribute Be especially careful to delete AAPDIR directories and hidden files starting with a dot It s better to delete too much than too few you can always add files later 2 Import the project to the CVS repository Move to the newly created directory tempdir in the example above Import the whole tree into CVS with a single command Example cd tempdir cvs d ext myname cvs sf net cvsroot myproject import mymodule myproject start Careful This will create at least one new directory mymodule which you can t delete with CVS commands This will create the module mymodule and put all the files and directories in it If t
4. 1 2 matches foo big foo big 1 2 and skips foo 1 2 The version specifications can be concatenated this creates an and relation Example foo gt 1 2 lt 1 4 versions 1 2 to 1 4 inclusive foo gt 1 2 1 8 versions 1 2 and above excluding 1 8 xv gt 3 10 versions above 3 10 accepts xv 3 10a The can be followed by parenthesis containing a list of specifications This excludes the versions matching the specifications in the parenthesis Example foo gt 1 1 gt 1 3 lt 1 5 versions 1 1 and higher but not versions 1 3 to 1 5 foo gt 6 1 6 1 a z version 6 1 and later but not 6 1a 6 11rc3 etc When a dependency is not met the newest version that meets the description is used For systems that do not allow specifying dependencies like this in a binary pacakge the specific package version that exists when generating the package is used Dependencies For Various Steps The various variables used to specify dependencies DEPEND_FETCH Required for fetching files Also for computing checksums DEPEND_EXTRACT Required for unpacking archives Required for building but not necessarily for running these are not included il in the binary package items may also appear in DEPEND_RUN DEPEND_TEST Required for testing only don t include items that are already in DEPEND_RUN DEPEND_RUN Required for running these will also be included in the generated binary package DEPENDS Used for DEPEND_BUILD and DEPE
5. RANLIB RANLIBFLAGS RCP RECIPEVERSION RSYNC SBINDIR SCP SHLINK SHLINKFLAGS SOURCE STRIP STRIPFLAGS TAR TARGET Aap conf user conf user conf user user Aap user conf user user conf user conf user Chapter 35 Common Variables A A P Recipe Executive FreeBSD4_9 STABLE Systems that do not support name and version yield what Python s os name yields usually the same as SOSTYPE except for MS Windows and MS DOS This name is usually incorporated in BDIR as well as build OSNAME Type of operating system used posix Unix like Linux BSD mswin MS Windows 98 XP msdos MS DOS not MS Windows os2 OS 2 mac Macintosh OS X gives posix java Java OS riscos Risc OS ce MS Windows CE Graphical editor to be used for the edit action The default value comes from the PAINTER environment variable Directory normally used for the top directory to install to When empty it defaults to usr local Use a single slash to install in the root directory Also see DESTDIR Program to run on created static library Default is not set When the ranlib action is invoked it will search for the ranlib program and set the RANLIB variable Arguments for RANLIB The default is not set Remote copy program to use for rcp The default is not set which means rcp p is used May also include arguments Version of A A P the recipe was wr
6. I Tutorial 1 Getting Started 2 Compiling a Program 3 Publishing a Web Site 4 Distributing a Program 5 Building Variants 6 Using Python 7 Version Control with CVS Filetypes and Actions 9 More Than One Recipe 10 Commands in a Pipe 11 A Ported Application IT User Manual 12 How it all works 13 Dependencies Rules and Actions 14 Variants 15 Publishing 16 Fetching 17 Installing 18 Version Control A A P Recipe Executive A A P Recipe Executive 19 Using CVS 20 Issue Tracking 21 Using Python 22 Porting an Application 23 Automatic Configuration 24 Using Autoconf 25 Automatic Package Install 26 Debugging a Recipe 27 Differences from make 28 Customizing Filetype Detection and Actions 29 Customizing Automatic Depedencies 30 _Customizing Default Tools 31 Adding A Language Module III Reference Manual 32 Aap Command Line Arguments 33 Recipe Syntax 34 Variables and Scopes 35 Common Variables 36 Assignments 37 Attributes 38 Filetype Detection 39 Standard Modules 40 Standard Tools 41 A A P Python functions 42 A A P Commands IV Appendixes A License List of Tables 2 1 items in a dependency 12 1 Special characters in the print command 17 1 Install targets 17 2 Settings for the install target 33 1 Notation 35 1 Naming scheme for variables 35 2 Standard Variables 37 1 Virtual Targets 37 2 Sticky attributes 37 3 supported check attribute v
7. command block Define a rule to build files matching the pattern tpat from a file matching spat Example rule html header part part footer part cat source gt target There can be several tpat patterns the rule is used if one of them matches There can be several spat patterns the rule is used if they all exist or no better rule is found When commands is missing this only defines that tpat depends on spat Can only be used at the recipe level A rule is used in the recipe where it is defined and in its siblings unless an option is used to specify otherwise options global use this rule in all places local use this rule only for targets in this recipe default default rule redefining it will not cause a message old only use the rule when the matching source file exists useful for rules that generate source code Alphabetical list of Commands 174 A A P Recipe Executive attributes can be used to set attributes for when applying the rule The skip attribute on tpat can be used to skip certain matches target and source can be used in commands for the actual file names match is what the in the pattern matched Alternative instead of matching the file name with a pattern _ action uses filetypes to specify commands On non Unix systems the pattern should contain only lower case letters and forward slashes because the name it is compared with is made lower case and backslas
8. if ok print finding include files python EOF start of the Python block include glob include c EOF end of the Python block Useful Python Items A list of Python functions defined by Aap can be found in the reference manual Chapter 41 A A P Python functions VAR os environ get VAR default Obtain environment variable VAR If it is not set use default Python Block 76 A A P Recipe Executive os environ PATH mypath Set an environment variable tiles alas EXT Obtain a list of files matching ext Aap will take care of turning the list that glob returns into a string using quotes where needed The difference with using ext directly is that the expansion is done right here not later when files is used The catch with using glob here is that when a file name contains a wildcard character it may be expanded again So long as that expansion fails or matches the same file name it is still OK but it becomes rather unpredictable Use wildescapeQ when needed choice raw_input Enter the value Prompt the user to enter a value tempfile tempfname Get a file name to use for temporary files The file will not exist See tempfnameQ If you create it you need to make sure it is deleted afterwards Example tempfile tempfname try print gt Stempfile start of file print gt gt Stempfile this variable may not exist and cause an error
9. tryout build and install for trying out reference generate or update the cross reference database fetch obtain the latest version of each file update fetch and build the default targets checkout checkout and lock from version control system commit commit changes to VCS without unlocking checkin checkin and unlock to VCS unlock unlock files from a VCS add add new files to VCS remove remove deleted files from VCS revise like checkin remove tag add a tag to the current version prepare prepare for publishing generated docs but no exe publish distribute all files for the current version Block Assignment 137 A A P Recipe Executive finally always executed last using aap finally is uncommon The targets marked with added automatically will be added by Aap if they are not present This is done for the toplevel and each child recipe These specific targets may have multiple build commands They are all executed to update the virtual target Normally there is up to one target in each child recipe Note that virtual targets are not related to a specific directory Make sure no other item in this recipe or any child recipe has the same name as the virtual target to avoid confusion Specifically using a directory test while there also is a virtual target test Name the directory testdir to avoid confusion The comment attribute can be used for targets that are to be specified at the command line aap comm
10. 6 1 SLASTPATCH 7 AINTAINER Bram vim org 8 9 CATEGORIES editors 10 PORTCOMMENT Vim Vi IMproved the text editor wal PORTDESCR lt lt EQE 12 This is the description for the Vim package L5 A very nice editor backwards compatible to Vi 14 You can find all info on http www vim org 115 EOF 16 17 recipe fetch http www a a p org ports vim main aap 18 Ug WRKSRC vim6l 20 BUILDCMD make Chapter 11 A Ported Application 32 A A P Recipe Executive Zl TESTCMD make test 22 INSTALLCMD make install DESTDIR PKGDIR 29 PREFIX asic Leal 24 25 MASTER_SITES ftp ftp vim org pub vim 26 ftp ftp us vim org pub vim 27 BATCH SITES MASTER_SITES patches 28 BY DISTFILES un a Ore a OZA 30 Sil versionl range 1 int LASTPATCH 1 32 PATCHFILES 6 1 00 versionl Ss 34 gt gt gt automatically inserted by aap makesum lt lt lt SO do checksum 36 checksum SDISTDIR vim 6 1 tar bz2 md5 7fd0f915adc7cOdab89772884268b030 37 checksum SPATCHDISTDIR 6 1 001 md5 97bdbe371953b9d25f006f8b58b53532 38 checksum SPATCHDISTDIR 6 1 002 md5 56455248658f019dcf3e2a56a470080 39 checksum SPATCHDISTDIR 6 1 003 md5 0e000edba66562473a5f1e9 b5b269bb8 40 gt gt gt end lt lt lt Well that is the longest example we have had so far Let s go through it from top to bottom il A A P port recipe for Vim 6 1 plus a few pat
11. OBSOLETE use gt Sit Aap A single lt OBSOLETE use lt pipe Aap A single OBSOLETE use l Chapter 36 Assignments Assignment overview var value assign var value append assign if not set yet var value assign only when not set yet var value assign evaluate when used var value append evaluate when used var value assign only when not set evaluate when used Chapter 36 Assignments 134 A A P Recipe Executive Assignment with or appends the argument as a separate item This is actually done by inserting a space But when the variable wasn t set yet and when it is empty it works like a normal assignment VAR something is equal to Chis globals G cate ao VARU e Q VAR _no VAR something tslses Q VAR something Assignment with only does the assignment when the variable wasn t set yet A variable that was set to an empty string also counts as being set Thus when using aap VAR the empty value overrules the value set with VAR something is equal to Qif not globals has_key _no VAR VAR something When using or variables in the argument are not evaluated at the time of assignment but this is done when the variable is used The expansion is done in the scope where it is used thus the result may depend on when and where the variable is used VNR 1 TT SVAR VAR 2 Sjoueaioe STI prints 2 A variab
12. SCVSROOT all fetch fetch fetch cvs SCVSROOT mymodule Executing this recipe will use the fetch target The_ fetch command takes care of checking out the whole module mymodule from the CVS repository with the specified name Note that this toplevel recipe cannot be obtained from CVS itself that has a chicken egg problem Fetching The child recipe mymodule main aap may be totally unaware of coming from a CVS repository If this is the case you can build and install with the recipe but not fetch the files or send updates back into CVS You need to use the toplevel recipe above to obtain the latest updates of the files This will then update all the files in the module However the toplevel recipe itself will never be fetched To be able to fetch only some of the files of the module the recipe must be made aware of which files are coming from CVS This is done by using an fetch attribute with a URL like specification for the CVS server fetch cvs servername dir Since CVS remembers the name of the server leaving out the server name and just using cvs is sufficient Example soles 100 versilom e header common h attr fetch cvs source Sheader program myprogram source If you now do aap fetch with this recipe the files foo c version c and common h will be updated from the CVS repository The target myprogram isn t updated of course Note When none of the used recipes specifi
13. attr val directory Version control command also see Chapter 18 Version Control Apply the add command to all files in the directory that have been given the commit attribute in the recipe and child recipes but do not exist in the repository options 1 local don t do current directory recursively r recursive do handle arguments recursively When no directory argument is given the current directory is used It is inspected recursively unless the local option was given When directory arguments are given each directory is inspected Recursively when the recursive option was given When no commit attribute is specified here it will be obtained from any node asroot command Execute shell command command in a separate shell with super user privileges Only the first time the root password will have to be entered Each executed command must be confirmed by the user for safety The command will be executed in the current directory of the recipe Variables in command will be expanded no attributes shell quoting stdin and stdout are redirected this cannot be used for interactive commands On non Unix systems and when running Aap as root this command is equivalent to_ system When the user types n to refuse executing the command sysresult will be set to a non zero value If the command is executed successfully sysresult is set to zero When the command fails an error message is gene
14. gtk c Two Choices 15 A A P Recipe Executive 18 Ug DEFINE DGUI Gui 20 Zl program Target Source The variant command in line 12 uses the Gui variable to select one of console motif or gtk Together with the earlier variant command this offers six alternatives release with console debug with console release with motif etc To build debug with gtk use this command aap Build debug Gui gtk In line 11 an optional assignment is used This assignment is skipped if the Gui variable already has a value Thus if Gui was given a value on the command line as in the example above it will keep this value Otherwise it will get the value motif gt Environment variables Environment variables are not used for variables in the recipe like make does When you happen to have a Gui environment variable this will not influence the variant in the recipe This is especially useful if you are not aware of what environment variables are set and or which variables are used in the recipe If you intentionally want to use an environment variable this can be specified with a Python expression see the next chapter In line 15 17 and 19 the append assignment is used This appends the argument to an existing variable A space is inserted if the value was not empty For the variant motif the result of line 15 is that Source becomes main c version c gui
15. it will be installed as myprog If you need to keep the path use the keepdir attribute on the file name INSTALL_INCLUDE sys myheader h keepdir As an alternative to keepdir there is the installdir attribute which explicitly sets the relative path of the file to be installed Files with an installdir attribute are installed in SDESTDIRSPREFIX targetDIR installdir The above setting could also be done as INSTALL_INCLUDE sys myheader h installdir sys The advantage of installdir over keepdir is that the relative paths from toplevel recipe to file and from install directory to the desired install location need not be the same For instance INSTALL_INCLUDE api 2 2 c myheader h installdir sys The above mentioned mode variable is used to set the mode bits of the file after installing If this is not wanted use the keepmode attribute Example INSTALL_DATA myscript sh keepmode To use another mode for a specific file add the mode 0555 attribute INSTALL_DATA myscript sh mode 0750 Installing to a remote machine should work although setting the file mode may not always work properly depending on the transfer method used Keep in mind that installation is done from the top directory In a child recipe that is located in another directory you need to specify the path to the file to install relative to the top directory Using the TOPDIR variable and rc style expans
16. resulting in a program file The target attribute is needed to specify the output file SoM Build the file s resulting in object file s The target attribute may be used to specify the output file When target is not specified the action may use a default usually src2obj fname See here ida Unpack an archive Requires the program for unpacking to be available Unpacks in the current directory Run the preprocessor on the file The target attribute can be used to specify the output file When preproc itis missing the output file name is formed from the input file name with src2obj fname sufname None and then appending i reference Run a cross referencer creating or updating a symbol database strip Strip symbols from a program Used to make it smaller after installing Examples do view COPYRIGHT filetype text do edit configargs xml do email edit bugreport do build target myprog main c version c do compile foo cpp Default Actions These are defined in the default aap recipe action edit default Uses the environment variable VISUAL or EDITOR Falls back to vi for Posix systems or notepad otherwise You can set the Aap variable SEDITOR to the editor program to be used The line 999 attribute can be used to specify a line number to jump to The byte 999 attribute can be used to jump to a character position in the file action edit gif jpeg png Uses the environment variable
17. A A P Recipe Executive source filel force file2 file3 for item in var2dictlist source if item get force sprint forced item item name See_expand2dictlistQ for expanding wildcards var2list var Turns var into a list of items var must be a string or a variable Attributes are discarded Delayed evaluation is taken care of Example source filel file2 file3 for fname in var2list source sys prog fname See_expand2list for expanding wildcards var2string var Does delayed evaluation of var when necessary Variables that should be expanded when used use the ExpandVar class and cannot be used directly The unexpanded value is accessible with var val Illustration bar aaa foo Sbar bar bbb porine SHTO STOO print Unexpanded foo val print Expanded var2string foo Output foo bbb Unexpanded bar Expanded bbb This also takes care of changing a Python list and other variable types to a string A None value is turned into an empty string wildescape expr Return the string expr with wildcard characters escaped so that expanding wildcards will result in expr This puts the characters and inside Example tiles alos images attr asdf wildescape files Equivalent to attr asdf images While developing Aap some functions have been renamed The old names are still available to keep old recipes from working
18. DMD DLINKFLAGS ofStarget source Defining a rule is optional The_ rule command selects the source and target based on a match of the file name with a pattern This is useful when a list of source files is defined without telling how they are to be turned into object files This is the way the rule is defined in the D module Actions Rules and Routes 113 A A P Recipe Executive rule global default SSOBJSUF buildcheck DMD DFLAGS d do compile target target source The global option is needed to make the rule available everywhere otherwise it would only work in the module recipe The default option allows overruling this rule without getting a warning The_ route command is used to tell Aap how to turn a source file into an object file This is used for the program dll and_ lib commands For the D language it s simply a matter of invoking the compile action for other languages it may consist of several steps with intermediate results route default d object libobject dllobject compile Actions Rules and Routes 114 Reference Manual Table of Contents 32 Aap Command Line Arguments 33 Recipe Syntax 34 Variables and Scopes 35 Common Variables 36 Assignments 37 Attributes 38 Filetype Detection 39 Standard Modules 40 Standard Tools 41 A A P Python functions 42 A A P Commands Chapter 32 Aap Command Line Arguments Three Kinds Of Arguments aap option
19. If there is a request for a password just hit enter mostly there is no password The fetch command takes care of obtaining the latest version of the items mentioned as arguments Usually the argument is one module in this example it is Exec That CVS needs to be used is specified with the fetch attribute This is a kind of URL starting with cvs and then the CVS root specification In the example the CVSROOT variable was used This is not required it just makes the recipe easier to understand If the software has been updated you can get the latest version by running aap again CVS will take care of obtaining the changed files Note that all this only works when you have the cvs command installed When it cannot be found Aap will ask you want Aap to install it for you Whether this works depends on your system Getting Past A Firewall Firewalls may block the use of a CVS connection Some servers have setup another way to connect so that firewalls will not cause problems This uses port 80 normally used for http connections Here is the above example using a different pserver address CVSROOT pserver anonymoustcvs pserver sf net 80 cvsroot a a p auly fetch fetch cvs CVSROOT Exec This doesn t always work through a proxy though If you have problems connecting to the CVS server try reading the information at this link Downloading Checkout 21 A A P Recipe Executive Uploading Checkin You are
20. In action the done variable is used with the _recipe scope prepended thus a done variable in the scope of the commands that invoked this action will not be used Note that the async attribute of the do command may cause the sys command to work asynchronously That is done because the async attribute is turned into the async variable for the_ action commands If you don t want a specific sys command to work asynchronously reset async action view foo tt async async sys foo_prepare asyne tt sys foo Ssource Specifying Actions 103 A A P Recipe Executive However since two consecutive_ sys commands are executed together this should do the same thing action view foo sys foo_prepare sys foo Ssource Quite often the program to be used depends on whether it is available on the system For example viewing HTML files can be done with netscape mozilla konquerer or another browser We don t want to search the system for all kinds of programs when starting it would make the startup time quite long And we don t want to search each time the action is invoked the result of the first search can be used This construct can be used to achieve this BROWSER action view html Qif not _recipe BROWSER progsearch _recipe BROWSER netscape mozilla konquerer sys _recipe BROWSER source The generic form form progsearch is progsearch varname progname The _recipe scope needs to be used for variab
21. Returns a dictionary with the attributes of name If name is unknown or has no attributes an empty dictionary is returned Example attr logical yes foobar print foobar attributes get_attr foobar get_html_images files add_dir 1 Returns a list of the images used in HTML files The argument files can be a Python list of file names e g what glob returns or an Aap list of files white separated Only images with a relative path and no URL are included and each name is included only once Since the image file names are relative to the HTML file name the directory of the HTML file is prepended to the image file name If this is not wanted set the add_dir argument to zero The returned file names are then as they appear in the HTML files This function is useful to make a list of image files that needs to be uploaded to a web server Example Files index html burp html contact html Files get_html_images Files Note that this function is not perfect it only works for relative file names ignores Javascript and PHP etc get_var_attr expr attr_name expr is handled as a list of items with attributes For each item the attribute attr_name is obtained If the item in expr does not specify an attribute it is obtained from the node attributes previously added with_ attr If none of the items has an attribute attr_name the function returns None if two items have a different value for attribute attr_
22. The searchpath argument can be used to search for the target in a series of directories Each item in searchpath is prepended to the target name unless it is an absolute path The updating stops when a path plus target is found that can be successfully updated When this appears at the top level a dependency or rule for the target to be used must already have been specified there is no look ahead When the target exists and no dependency or rule applies the file is considered updated usetool toolname Specify a specific tool to be used When used in the toplevel recipe the tool becomes the default tool Can also be used in a child recipe See Chapter 30 Customizing Default Tools for more info variant varname value commands Define build variants The varname is the name of a variable that selects one of the possible value items The last value item can be a star This item will be used when the value of varname does not match one of the other values When the variable varname is not set or has an empty value the first entry is used The value of BDIR is changed by appending a dash and the value of varname The value is modified to avoid using an illegal filename See the User manual_Chapter 14 Variants for examples Can only be used at the recipe level verscont action attr val fname Version control command also see_Chapter 18 Version Control Perform the version control action on the fil
23. The value does not change while Aap is running it is the time when Aap was started Also see GMTIME and DATESTR TOPDIR Aap Ina child recipe The directory of the child recipe relative to the toplevel recipe When using child subdir main aap in the toplevel recipe TOPDIR will be subdir in the child recipe In the toplevel recipe TOPDIR is empty UNZIP conf Unzip program to use for zip archives Default value is unzip USECXXLD Aap When set to yes the default for the build program becomes CXX instead of CC Only used when LD is not set The compile action for C files sets this variable to yes The default value is no VERSIONSTR Aap Version of A A P being used as a string e g 0 100 Also see SAAPVERSION YACC conf Program to turn a yacc file into C The default value is empty When the yacc action is invoked Aap will search for yacc and bison and set YACC to the found program Y ACCFLAGS user Flags for Y ACC The default value is not set Y ACCPP Aap Program to turn a yacc file into C The default value is empty When the yaccpp action is invoked Aap will search for bison and yacc and set YACC to the found program YACCPPFLAGS user Flags for Y ACCPP The default value is not set bar Aap A single OBSOLETE use l br Aap A line break OBSOLETE use BR Sempty Aap Empty Can be used to get leading white space with print OBSOLETE use Set Aap A single gt
24. This may not be what you expect When there is no update target it is automatically generated It will invoke the fetch target and the default target s of the recipe To do something similar manually update fetch STarget The Fetch Attribute The fetch attribute is used to specify a list of locations where the file can be fetched from The word at the start defines the method used to fetch the file ftp from ftp server http from http www server scp secure copy The Fetch Attribute 58 A A P Recipe Executive rep remote copy aka insecure copy rsync remote sync file local file system from CVS repository For a module that was already checked out the part after cvs may be ee empty CVS will then use the same server CVSROOT as when the checkout was done other user defined These kinds of locations can be used ftp ftp server name full path file ftp ftp server name relative path file http www server name path file scp host name path path file rcp host name path path file rsync host name path path file cvs METHOD USER PASSWORD HOSTNAME PORT path to repository file user dir file file etc fstab For a local file there are two possibilities using file or file They both have the same meaning file is preferred because the double slash is usually used before a machine name method machine path A file is always local thus leaving out machine is the logic
25. This prints an empty line The bla is omitted because the rc style expansion has zero items When concatenating variables and using rc style expansion the attributes of the last variable overrule the identical attributes of a previous one vl foo check 1 v2 bar check 2 wy Sewl sy Is equivalent to RC style expansion 122 A A P Recipe Executive vv foobar check 1 check 2 When using rc style expansion quotes will not be kept as they are but removed and re inserted where used or necessary Example FOO file 1 c tod 8 gorra Velie S Sour as Results in dir file 1 c dir foo c Variable Indexing To get one item out of a variable that is a list of items use an index number in square brackets Parenthesis or curly braces must be used around the variable name and the index The first item is indexed with zero Example BAR beer coffee cola print BAR 0 BAR_ONE BAR 2 print SBAR_ONE Results in beer cola Using an index for which no item exists gives an empty result When MESSAGE includes warning a message is printed about this Using Scopes A dot is considered part of the variable name It separates the scope name from the variable name within that scope However a trailing dot is not part of the variable name so that this works aora Sresti t print the result In Python code you need to explicitly specify the scope name When no scope name i
26. Version If you now change the value of Version change one of the_ print commands or add one foo txt will be rebuilt To simplify this xcommands can be used to check the build commands after expanding variables thus you don t need to specify Version foo txt buildcheck xcommands However this only works when all VAR in the commands can be expanded and variables used in Python commands are not expanded To avoid checking the build commands use an empty buildcheck This is useful when you only want the target to exist and don t care about the command used to create it objects buildcheck sprint empty gt objects Sometimes you might change the build commands in a recipe which would normally mean the target should be updated but you are sure that this isn t necessary and want to avoid executing the build commands You Build Command Signature 50 A A P Recipe Executive can tell Aap to ignore the buildcheck once with the contents option Chapter 14 Variants You might first want to read the tutorial for a few examples of using variants Here is an example how build variants can be specified This will be used to explain how it works variant Opt some OPTIMIZE 2 much OPTIMIZE 6 OPTIMIZE 1 Opt is the name of a variable It is used to select one of the variants Each possible value is listed in the following line and further lines with the same indent In the example these
27. When you switch to another server you need to change the publish attribute The next time you invoke Aap for publishing it will automatically upload all the files to the new server Using Another Method 55 A A P Recipe Executive If you didn t actually change to another server but the URL used for the server changed invoke Aap once with the contents argument aap publish contents This will cause only files that changed to be published It avoids that all the files with a changed publish attribute are published again It will still upload files that you changed since the last upload and newly added files But be careful files that you once uploaded deleted from the list of files and now added will NOT be uploaded Distributing Generated Files When publishing a new version of an application you might want to include a number of generated files This reduces the number of tools someone needs to use when installing the application For example the configure script that autoconf produces from configure in can be included To avoid these generated results to be generated again when the user runs aap explicitly specify a signature file to be used and distribute this signature file together with the generated files For example suppose you have a directory with these files you created main aap prog c Additionally there is the file version c that is generated by the main aap recipe It contains the date of last
28. an offer in accord with Subsection b above The source code for a work means the preferred form of the work for making modifications to it For an executable work complete source code means all the source code for all modules it contains plus any associated interface definition files plus the scripts used to control compilation and installation of the executable However as a special exception the source code distributed need not include anything that is normally distributed in either source or binary form with the major components compiler kernel and so on of the operating system on which the executable runs unless that component itself accompanies the executable If distribution of executable or object code is made by offering access to copy from a designated place then offering equivalent access to copy the source code from the same place counts as distribution of the source code even though third parties are not compelled to copy the source along with the object code 4 You may not copy modify sublicense or distribute the Program except as expressly provided under this License Any attempt otherwise to copy modify sublicense or distribute the Program is void and will automatically terminate your rights under this License However parties who have received copies or rights from you under this License will not have their licenses terminated so long as such Appendixes 187 A A P Recipe Executive parties remain
29. automatically unless AUTODEPEND is no This is skipped if SKIPRUNTIME is yes The pre rundepend and post rundepend are still done they should check SKIPRUNTIME themselves aap rundepend will _not_ cause previous steps to be updated installtest Test if the installed package works This is empty by default specify a do installtest target to actually do something Note that when SKIPRUNTIME is yes the dependencies have not been verified and running the application might not work uninstall clean Uninstall the binary package Not implemented yet Execute pkg_delete or equivalent Does not depend on other steps Delete all generated unpacked patched and CVS files Does not delete the downloaded files Does not depend on other steps Does not clean packages this one depends on distclean Delete everything except the toplevel recipe After this all steps must be redone Does not depend on other steps Does not clean packages this one depends on makesum Generates a do checksum dependency that checks if the fetched files were not corrupted If the recipe already contained a do checksum dependency that was generated it is replaced Otherwise a new one is appended Do not change the markers before and after the do checksum dependency otherwise you end up with two of these when doing aap makesum again Does not depend on other steps The files must already be present You can use aap fetc
30. free software which everyone can redistribute and change under these terms To do so attach the following notices to the program It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty and each file should have at least the copyright line and a pointer to where the full notice is found lt one line to give the program s name and a brief idea of what it does gt Copyright C lt year gt lt name of author gt This program is free software you can redistribute it and or modify it under the terms of the GNU General Public License as published by the Free Software Foundation either version 2 of the License or at your option any later version This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE See the GNU General Public License for more details You should have received a copy of the GNU General Public License along with this program if not write to the Free Software Foundation Inc 59 Temple Place Suite 330 Boston MA 02111 1307 USA Also add information on how to contact you by electronic and paper mail If the program is interactive make it output a short notice like this when it starts in an interactive mode Gnomovision version 69 Copyright C year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY for details type
31. from files directories are renamed or when renaming isn t possible copied and deleted options c continue when an item with a wildcard does not have matches continue with the next item e exist Dr y HA don t overwrite an existing file or directory exists T f before overwriting a local file prompt for confirmation currently doesn t work i interactive for remote files m mkdir create destination directory when needed q quiet don t report moved files pass Do nothing Useful to define a target with build commands to avoid a dependency is added automatically ales pass popdir Change back to directory on top of the directory stack undoing a previous_ pushdir It is an error if the directory stack is empty more popdir than pushdir used Alphabetical list of Commands 169 A A P Recipe Executive print redir text Print the arguments on stdout Without arguments a line feed is produced var items are expanded otherwise the arguments are produced literally including quotes orita o results in hello Leading white space is skipped but white space in between arguments is kept To produce leading white space write the first space as an escaped character sorta SH indented text results in indented text When used in a pipe the st din variable holds the input See here for redir Seelog for writing a message to the log file without echoing produce what option target
32. is not available Cleaning Up Currently Aap does not delete the files downloaded and generated while installing a package This is useful especially when something fails so that you can read the log file AAPDIR log and or do part of the installation manually But this does mean disk space is used In the comments produced while installing the package you can see which directory is used for the files This depends on the system and environment variables It should be one of these HOME aap packages HOME aap packages HOMEDRIVE HOMEPA TH aap packages C aap packages It is fairly safe to delete the packages directory and everything it contains In case you are really low on disk space you might want to check the Aap install directory for any programs that you no longer want to use This is only relevant on MS Windows Chapter 26 Debugging a Recipe The log file shows what happened while A A P was executing Often you can figure out what went wrong by looking at the messages Installing a Specific Package 95 A A P Recipe Executive The log file is named AAPDIR log It is located in the directory of the main recipe If you executed aap again and now want to see the previous log it is named AAPDIR log1 Older logs are AAPDIR log2 AAPDIR log3 etc This goes up to AAPDIR log9 Messages The kind of messages given can be changed with the MESSAGE variable It is a comma separated list of message types for
33. scp user ftp foo org public_html file Files That s all You just need to specify the files you want to publish and the URL that says how and where to upload them to Now aap publish will find out which files have changed and upload them aap publish Aap Uploading home mool www foo index html to scp user ftp foo org public_html index html Aap scp home mool www vim index html user ftp foo org public_html index html Aap Uploaded home mool www vim index html to scp user ftp foo org public_html index html Kinds of things you can build 10 A A P Recipe Executive The first time you execute the recipe all files will be uploaded Aap will create the images directory for you If you had already uploaded the files and want to avoid doing it again first run the recipe with aap publish touch Aap will compute the signatures of the files as they are now and remember them Only files that are changed will be uploaded from now on The_ attr command uses its first argument as an attribute and further arguments as file names It will attach the attribute to each of the files In this case the publish attribute is added which specifies the URL where to upload a file to In the example the scp protocol is used which is a good method for uploading files to a public server ftp can be used as well but this means your password will go over the internet which is not safe The special item file is rep
34. the default is LIBOBJSUF Otherwise the suffix attribute must be specified to avoid that the source and target have the same file name attributes are optional attributes that apply to the generated dependencies Use the scope attribute to specify a user scope to be used before other scopes except the local scope in the generated dependencies The targets and any intermediate files will be added to _recipe CLEANFILES The source files will be added to _recipe DISTFILES except the ones with a nodist attribute Can only be used at the recipe level touch option name Update timestamp of file or directory name options f force create the file when it doesn t exist create the file when it doesn t exist don t update timestamp when the file already exists e exist If name doesn t exist and force and exist are not present the command fails If name doesn t exist and force or exist is present an empty file will be created If name does exist and exist is present nothing happens A directory attribute can be used to specify a non existing name is to be created as a directory There is no check if an existing name actually is a directory A mode attribute can be used to specify the mode with which a new file or directory is to be created The value is in the usual octal form e g 0644 tree dirname option command block Inspect the directory tree dirname and invoke the command
35. the type of the target is undefined It is also possible to specify an action for turning a file of one filetype into another filetype This is like a_ rule command but using filetypes instead of patterns action action out filetype in filetyp commands Actually specifying an action with one filetype is like using default for the out filetype Several variables are set and can be used by the commands fname The first file name of the_ do command source All the file names of the do command filetype The detected or specified filetype for the input targettype The detected or specified filetype for the output action The name of the action for which the commands are executed Furthermore all attributes of the action are turned into variables Thus when do action arg x file is used arg is set to x Example for using an optional arg attribute action view foo sys fooviewer arg source In Python code check if the edit attribute is specified action email default when subject and or to is missing editing is required Mie more ciloloaila ger Ysulojece ox mot ciloloails qee Vico e edit 1 if globals get edit do edit fname sys mail s subject to lt Sfname Specifying Actions 102 A A P Recipe Executive action and ftype can also be a comma separated list of filetypes There can t be any white space though Examples action view html xml php Sve TSTS re
36. to bugs foobar org edit remove Stmpfile The foobar version command is used to obtain the actual version of the foobar program being used Replace foobar with the actual name of your program When a web form is to be filled in give the user hints about what information to fill in certain fields and start a browser on the right location Example Cp ON do view async http www foo org bugreport tmpfile tempfname print gt Stmpfile use this information in the bug report sprint gt gt Stmpfile program version SVERSION print gt gt Stmpfil system type os name do view remove Stmpfile Obviously this is a bit primitive the user has to copy text from the text viewer to the browser Try using a better method filling fields of the form directly if you can Bug Fixing Once a bug has been fixed the developer needs to update the related bug report The tracker target is the standard way for a developer to get to the place where the status of the bug report can be changed Since trackers work in many different ways the recipe has to specify the commands Example Chapter 20 Issue Tracking 72 A A P Recipe Executive tracker do view async http www foo org tracker assigned_to SUSER This is very primitive The developer still has to locate the bug report and change the status and add remarks The above example at least lists the bug reports for the current user Chapter
37. version c CPPFLAGS 1 util _top Core_obj src2obj Source e o ICA Ole WIN E S alils tods Cors 093 Variables in a child recipe are local to that recipe The CPPFLAGS variable that is changed in line 4 will remain unchanged in the parent recipe and other children That is desired here since finding header files in util is only needed for source files used in this recipe The Core_obj variable we do want to be available in the parent recipe That is done by prepending the _top scope name The generic way to use a scope is scopename variablenamej Several scope names are defined such as _recipe for the current recipe and _top for the toplevel recipe The full list of scope names can be found in the reference manual chapter Chapter 34 Variables and Scopes Recipe Syntax and Semantics When a variable is used without a scope name it is looked up in the local scope and surrounding scopes Thus the variables from the parent recipe are also available in the child But when assigning to a variable without a scope it is always set in the local scope only To make the variable appear in another scope you must give the scope name The value of Core_ob J is set with a Python expression The_src2objQ function takes a list of source file names and transforms them into object file names This takes care of changing the files in Source to prepend BDIR and change the file suffix to OBJSUF It also takes care of usi
38. 148 A A P Recipe Executive Attempt to install the BSD port name This includes the directory in which the port lives e g devel templ The BSD port system will take care of dependencies This may result in many more ports to be installed than the one you asked for target is passed to the make command for the port When target is all the port is build but not installed When target is install it will be build and installed When needed the user will be asked to enter the root password The make command is run in a separate root shell every command must be confirmed for security reasons Returns non zero for success do_Debian_pkg name target Attempt to install the Debian package name This is the name that apt get uses When not on a Debian system or when apt get cannot be found the function returns with a zero value The Debian apt get will take care of dependencies This may result in many more packages to be installed than the one you asked for target specifies what to do When target is install the package will be installed When needed the user will be asked to enter the root password The make command is run in a separate root shell every command must be confirmed for security reasons Returns a non zero number for success expand2dictlist expr Turns a variable with a string value into a list of dictionaries Each dictionary has a name entry for the item itself and other en
39. Aap provides there are several alternatives First of all you could use INSTALL_DATA and set DATADIR to the installation directory This works if you are otherwise not using INSTALL_DATA If you have several different directories you could use this scheme INSTALL _ITEM1 filel txt file2 txt INSTALL_DIR1 somewhere TINS MEAN II SS lo A INSTALL_DIR2 elsewhere iosta locals install_files _no INSTALL_DIR1 _no INSTALL_ITEM1 0644 install_files _no INSTALL_DIR2 _no INSTALL_ITEM2 0644 nimsrelll local e f uninstall_files _no INSTALL DIR1 _no INSTALL_ITEM1 funinstall_files _no INSTALL _DIR2 _no INSTALL_ITEM2 In the Python reference chapter you can find explanations for install_files and_uninstall_files You could also add a command to set the protection flags of the installed files chmod SINSTALL_DIR1 INSTALL_ITEM1 Uninstall 64 A A P Recipe Executive Chapter 18 Version Control This is about using Aap with a Version Control System VCS The generic form of version control commands is CONTA CAC comence decires well ss LS sas The commands use the commit attribute of a file to obtain the kind of version control system and its location For example attr foo c commit cvs ext S CVSUSER_AAP cvs a a p sf net cvsroot a a p For CVS it is also possible to only specify the method CVS will then u
40. Constant josiecinlZ Note the attributes are added internally When using print var this only shows the attributes given by an assignment not the ones added with_ attr buildcheck argument Doesn t do anything Placeholder for variables that are used but don t show up in build commands so that they will be included in the buildcheck cat redir fname Concatenate the arguments and write the result to stdout Files are read like text files The argument can be used to get the output of a previous pipe command When redirecting to a file this output file is created before the arguments are read thus you cannot use the same file for input See here for redir cd dir Change directory to dir When dir is it goes back to the previous directory it is an error if there was no previous cd command in the current command block When multiple arguments are given they are concatenated with path separators inserted where needed This is similar to doing acd for each argument except that each argument but the first one is as handled as a relative path gece Jemo usr local brm Is equivalent to sec IO gecl wsr local Alphabetical list of Commands 159 A A P Recipe Executive seel lola If the target directory does not exist this command fails Use_mkdir first if needed note mkdir does not contatenate its arguments Note that at the start of each command block Aap changes directory to the directory
41. SG 2 SC i queemS S prices 18 13 Six inel var S gt Write this in the file try aap Executing it results in aap f try aap tie 2 green price 13 lt incl vat gt Line Syntax Aap parses the recipe into a sequence of lines A line is a sequence of characters terminated by a newline You can escape the newline with a backslash to continue a logical line over more than one physical line as follows One line A longer line that continues over three physical lines Be G NH FE You can always use backslash continuations to continue lines in Aap Indentation does not matter In many constructions Aap also supports Python style line continuations where a line is continued by increasing the indentation of subsequent physical lines The above example would look different with Python style continuation One line A longer line that continues over three physical lines Hs OG NO EF As you can see the block of lines with an increased amount of indentation is considered to belong to the line above it Python style line continuations are supported in all Aap constructions except when the command cannot be recognized if the linebreak comes early For example in dependencies the colon separating the targets from the sources cannot be in a continuation line This does not work myprog mysource sprint This Does Not Work It is also not possible to split a dependency by indent when it does not
42. Table 17 1 Install targets High level Target install platform install shared install local Lower level Targets install exec install sbin install lib install dll install Itlib install conf install platform local install data install man install info install include install shared local Install these Files This is for installing platform dependent files Install programs generally produced through program command Install programs for system administration These may have additional security considerations hence a separate target Install static libraries from the Lib command Install shared libraries from the 411 command Install shared libtool libraries from the 1t1 ib command These require special treatment by the libtool program hence a separate target Install platform specific configuration files such as pkg config files A catch all for things that don t fit anywhere else This is for installing files shared between platforms Install data for the package This would typically include translation files examples if they re not in the manpage and images used by the package Install manpages Install GNU style info pages Installs header files also known as includes A catch all for things that don t fit anywhere else this is an optional target that you can define for extra installing without changing the other instal
43. The tools will convert this to the argument the compiler actually uses Directory used to install in a different root directory Useful for a fake install Also see PREFIX Names of directories that should be distributed as a whole If there is one file in this directory that should not be distributed use DISTFILES Names of files that are used as a source in the recipe and should be distributed The program command adds files to this Extra arguments to compile a C program into a dynamic shared object file The default is currently fPIC but since that only works with gcc 1t will soon be changed Extra arguments to compile a C program into a dynamic shared object file The default is currently fPIC but since that only works with gcc it will soon be changed Sub directory to install shared dynamic library files into Default value lib Mode to use for installed shared dynamic library files Default value 0755 readable and executable for everybody writable for the user Suffix for an object file to be included in a dynamic shared library Default o for Unix obj for MS Windows Prefix for a dynamic shared library Default lib for Unix empty for others Suffix for a dynamic shared library Default dll for MS Windows so for Unix Editor to be used for the edit action The default value comes from the VISUAL or EDITOR environment variable When these are not defined it fal
44. a line by itself The Python commands may have any indent White space before and after terminator is allowod and a comment after terminator is also allowed terminator can contain any characters except white space quit See_exit recipe fetch URL Location of this recipe The fetch attribute is used like with_ child a list of locations The first URL that works is used When aap was started with the fetch argument fetch the recipe and restart reading it Using the fetch or update target causes this as well The commands before_ recipe have already been executed thus this may cause a difference from executing the new recipe directly The values of Alphabetical list of Commands 172 A A P Recipe Executive variables are restored to the values before executing the recipe Fetching a specific recipe is done only once per session remove attr val fname Version control command also see_Chapter 18 Version Control Remove the files from the repository The file may still exist locally Implies a commit of the file removeall option attr val directory Version control command also see_Chapter 18 Version Control Apply the remove command to all files in the directory that exist in the repository but do hot have been given a commit attribute in the recipe and child recipes Careful Only use this command when it is certain that all files that should be in the VCS are expli
45. a system command Execute a system command Run a system command asynchronously Execute a system command and catch the output Execute a system command to figure out dependencies Execute one of a number of commands Pipe commands assign EEE r gt e CD 7 lt 3 syseval Assign stdin to a variable List or concatenate files Print a message Write a message to the log file Echo stdin to stdout and also write it in a file Evaluate a Python expression Execute a system command and catch the output File system commands COPY MOVE symlink chmod del delete Copy files Rename or move a file Create a symbolic link Change the protection bits of a file Delete files Delete files Chapter 42 A A P Commands 156 A A P Recipe Executive deldir Delete directories mkdir Create a directory touch Create a file and or update its timestamp tree Execute commands for a directory tree cd Change directory chdir Change directory pushdir Change directory and remember the previous one popdir Change to an older directory Various zattr Attach attributes to items attribute Attach attributes to items buildcheck Add a string to the build command signature exit Stop execution uit Stop execution ass Do nothing variant Define build variants python Execute Python commands conf Do a configuration check progsearch Search for an executable progr
46. adds its target to the SINSTALL_LTLIB variable The installexec action will strip the program by default if the strip program can be found If you don t want this add the nostrip attribute to the program or set STRIP to an empty value You can also overrule the default actions by one of your own The install _files function can be useful then See the default aap recipe for examples Destination Directories All the install targets prepend a path to the directory they install into The directory mentioned above is appended DESTDIR Normally empty which means that the root directory is used Set this when you don t want to Destination Directories 62 A A P Recipe Executive install to the local machine but still pretend to install in the root Examples dummyroot scp foo org Yes you can do remote installing this way Although not everything that works locally will work remotely PREFIX Default is usr local on Unix This specifies where to install to The installed program is aware of being installed here PREFIX may be put in configuration files The variables are concatenated For example programs are installed in DESTDIR PREFIX EXECDIR Slashes are added in between where needed The directories that are used are automatically created when needed Note that uninstall does not delete the directories When installing the path to a file is normally removed Thus when you produced a program results myprog
47. all tests for the language will fail Example conf language C conf header mainoptions headername itemoptions Check for C or C header file s headername Uses current value of INCLUDE Defines HAVE_headername if headername is available mainptions oneof first of the items that works is used at least one is required required all items are required to exist itemoptions header text included in the test program language ie CEA Examples conf header X11 Shell h conf header oneof sys time h times h conf function mainoptions functionname itemoptions Check Vion Gor Cor Suncom es eruncteronname Uses the current value of SLIBS Defines HAVE_functionname if functionname is available Options see conf header Example conf function bcopy Port Description 86 A A P Recipe Executive conf type mainoptions typename itemoptions Check for C or C type s typename Uses the current value of SLIBS Defines HAVE_typename if type typename is available Options see conf header Additional itemoption fallback type definition to use for the type when it is not available Example conf type size_t fallback unsigned long conf lib mainoptions libname funcname itemoptions Check for library libraries by testing if funcname exists when using the libname library Uses the current value of SLIBS and appends llibname if the test succee
48. and invokes the execute command with the build target The reason to use the build target is that without it the all target would be built again and result in an endless loop This is the resulting output Building with trial license for language chinese DEFINE DTRIAL DCHINESE Building with trial license for language bulgarian DEFINE DTRIAL DBULGARIAN Building with trial license for language english DEFINE DTRIAL DENGLISH Building with demo license for language chinese DEFINE DDEMO DCHINESE Building with demo license for language bulgarian DEFINE DDEMO DBULGARIAN Building with demo license for language english DEFINE DDEMO DENGLISH Building with full license for language chinese DEFINE DFULL DCHINESE Building with full license for language bulgarian DEFINE DFULL DBULGARIAN Building with full license for language english DEFINE DFULL DENGLISH Chapter 15 Publishing Publishing means distributing the files of your project This is a generic mechanism You can use it to maintain a web site or to release a new version of your application Chapter 15 Publishing 53 A A P Recipe Executive The most straightforward way to publish a file is with the publish command attr publish ftp ftp my org upload file myfile publish myfile This uses the publish attribute on each of the files When the publish attribute is missing the commit attribute is used If bo
49. are some and much is used to accept any value it must be the last one The first value mentioned is the default when the variable isn t set You can now start Aap with various arguments to specify the kind of optimizing you want to use aap Opt some will set OPTIMIZE to 2 aap Opt much will set OPTIMIZE to 6 aap Opt other will set OPTIMIZE to 1 aap will set OPTIMIZE to 2 N Note that when Opt is not given a value the first entry is used resulting in OPTIMI when it is set to a value that isn t mentioned the last entry is used E being set to 2 But The BDIR Variable The BDIR variable will be adjusted for the variant used CAREFUL this means that using BDIR before variant commands will use a different value that might not always be what you want Inside the_ variant command the value of BDIR has already been adjusted When a target that is being build starts with SBDIR and BDIR doesn t exist it is created Actually this happens when an item in the path is build or starts with build SBDIR is relative to the recipe When using child dir main aap the child recipe will use a different build directory dir BDIR Note that when building the same source file twice from recipes that are in different directories you will get two results Best is to always build a target from the same recipe that mak
50. attr publish scp user ftp foo org public_html file Files als Svtiles publish Files publishall o rule html start part _title part header part _body part footer part cat source gt Starget Using rule to Generate Several HTML Files 12 A A P Recipe Executive Notice that is now used three times in the rule command It stands for the same word every time After writing this recipe you can forget what changes you made to what file A A P will take care of generating and uploading those HTML files that are affected For example if you change header part all the HTML files are generated and uploaded If you change index_title part only index html will be done There is one catch You must create an empty xxx html file the first time otherwise it will not be found with html And you have to be careful not to have other xxx html files in this directory You might want to explicitly specify all the HTML files instead of using wildcards The same problem with wildcards happens for the image files There is a solution for this use the get html images function You can find an example in the section called Publishing images for HTML files A similar recipe is actually used to update the A A P website It s a bit more complicated because not all pages use the same header Chapter 4 Distributing a Program Open source software needs to be distributed This chapter gives a simple example
51. attr val source Specify that target has filetype what and is build from source Aap will add dependencies to invoke the actions that will accomplish the task of building target For specific types of targets separate commands are available You don t need to specify the mandatory options then For building a normal program use_ program for building a shared library use_dll for building a static library use_lib for building a libtool library use_Jtlib The building is split up in two parts 1 Dependencies are added to compile the source files into files specified with the objecttype option The routes specified with_ route are used to decide which actions to invoke These route commands must precede the produce command Each step in the route becomes a separate dependency so that intermediate results are produced This is similar to what the totype command does 2 The second step is to build the target from the objecttype files This invokes the action defined with buildaction using what as the target filetype The what filetype is declared when necessary to avoid a warning for defining an action for an unknown filetype When the basename of target does not contain a dot the targetsuffix option will be appended and targetprefix prepended The original name becomes an alias name for the target so that this works ais os lose oros Clelinik Seleasialeoyore seas OD E 1D produce snack snacko
52. be recognized as redirection execute pass name argument Execute recipe name right away This works like executing aap on name The recipe is executed in a new scope This is used as the toplevel scope unless the pass option is used The fetch attribute is supported like with_ include Optional arguments may be given like on the command line This is useful for specifying targets and variable values f recipe is ignored Example TESTPROG myprog execute test aap testl test2 The following command line options are also used for the executed recipe Thus when Aap was started with the nobuild argument this will also be applied to recipes executed with execute All other command line arguments are not passed on C contents k continue F force n nobuild a nocache N nofetch recipe s silent S stop t touch v verbose This command is useful when a recipe does not contain dependencies that interfere with sources and targets in the current recipe For example to build a command the current recipe depends on For example when the program mytool is required and it doesn t exist yet execute a recipe to build and install it Alphabetical list of Commands 165 A A P Recipe Executive Qir MO Jaro aach ho S execute mytool aap install sys mytool See the program pathQ function Another example build two v
53. block for each selected file and or directory In the command block name has the name of the selected item Example tree headers filename log delete name Alphabetical list of Commands 179 A A P Recipe Executive This deletes all log files below the headers directory possibly including headers log and headers sub log The dirname itself is not part of the selected items options filename pattern Select files where this Python re pattern matches the whole filename dirname pattern Select directories where this Python re pattern matches the whole filename Exclude files and directories where this Python re pattern matches the reject pattern basename the last component in the path Directories are still entered For example when the pattern is CVS a file CVS Entries can still be included a Do not enter directories where this Python re pattern matches the basename skipdir pattern the last component in the path Include only files that match the pattern in the file contents Does not apply to contents pattern directories When neither the filename nor dirname is given all files are selected as if filename was used When the system ignores case for filenames the patterns will ignore case differences for filename dirname and reject The pattern for contents is used with matching case The pattern for filename dirname and reject must match the wh
54. command program object build lib libobject buildlib Itlib Itobject buildltlib The Production Commands 43 A A P Recipe Executive Attributes for the Production Commands The production commands understand a wide variety of attributes Let us return to the generic form of a production command command targets sources There are four places attributes can be inserted in this command as follows we have split the command across several lines for clarity 1 command command attributes 2 targets per target attributes 3 source global attributes 4 sources per source attributes There is one commonly used command attribute installvar The production commands add their targets to the variable named in this attribute This defaults to the normal variable as listed in Table 17 2 Assigning an empty value through installvar prevents a target from being installed at all This is useful for internal helper programs and libraries used during the build process 7 Note You should use installvar INSTALL _LTLIB for program targets that have filetype Itprogram since they need to be installed as if they are libtool libraries not programs o Warning It is a bad idea excepting Itprograms which belong in INSTALL_LTLIB to add targets to the wrong install variable since the install action that gets called for it will be wrong then as well A slightly les
55. command After reading the recipe execute command May appear several times all the commands are executed Commands to be executed can be specified on the command line This is useful for example to fetch individual files A Sc meine aja e E commie common la Since the recipe is first read and all child recipes the attributes that are given to main c will be used for fetching The commands are executed before updating targets When no target is specified nothing is built only the specified commands are executed But the toplevel commands in the recipe are always executed before executing the command arguments Keep in mind that the shell must not change the argument use single quotes to avoid VAR to be expanded by the shell aap A SS ORO changed file The file file is considered changed no matter whether it was really changed Targets build from file will also be considered changed recursively Similar to the recipe command changed file 6 contents Only take action when file contents was changed not when build commands or attributes changed For normal dependencies the buildcheck is ignored This means that the build commands can be changed without causing them to be executed The commands are executed anyway when one of the sources is out of date For publishing the publish attribute is ignored The file is still published when its contents changed since the last time it was published to any destin
56. directory is not empty options c continue when an item with a wildcard does not have matches continue with the next item don t fail when a directory doesn t exist still fails when it exists but is not a f force directory or could not be deleted q quiet don t report deleted directories delrule option tpat spat Delete an existing rule Can be used when one of the default rules would be used when this is not wanted options q quiet don t complain when there is no matching rule Also see_ clearrules d11 option target attr val source Specify that target is a shared dynamic library build from source Dependencies will be added to compile source into an object file and combine the object files together into target When the basename of target does not contain a dot DLLPRE will be prepended and DLLSUF will be appended The original name becomes an alias name for the target so that this works aliz it loe a llll Tos 1098 AU AO AS On Unix this builds libfoo so and libbar so Alphabetical list of Commands 163 A A P Recipe Executive See_ produce for the most important options The default values used for dll are DLLSUF for targetsuffix DLLPRE for targetprefix SDLLOBJSUF for objectsuffix dllobject for objecttype INSTALL_DLL for installvar and builddll for buildaction In addition the onestep option explained for command can be used
57. example look at cvs_command in the VersContCvs py file of the Aap sources A second function that is to be defined is method_list It should return a list of the files that are currently in a specified directory in the repository Return an empty list if there are no files The function will be called with these arguments recdict a dictionary with references to all variable scopes for expert users only the name of the repository defined with the commit attribute with the scheme part name removed the dictionary holding attributes for the specified repository e g for commit foo Somme digt arg blah it is in Python syntax name foo arg blah dirname name of the directory to be listed recursive boolean indicating whether recursive listing is to be done For an example look at cvs_list in the VersContCvs py file of the Aap sources Using Subversion 67 A A P Recipe Executive Chapter 19 Using CVS A common way to distribute sources and working together on them is using CVS This requires a certain way of working The basics are explained here For more information on CVS see http www cvshome org Obtaining A Module The idea is to hide the details from a user that wants to obtain the module This requires making a toplevel recipe that contains the instructions Here is an example CVSROOT pserver anonymous cvs sf net cvsroot myproject child mymodule main aap fetch cvs
58. executed This means that when you put back an old version of a file rebuilding will take place even though the timestamp of the source might be older than the target Another check can be specified with check name where name is the kind of check Example foo txt foo db check time sys db_extract Ssource gt target The default check is md5 This is specified with the DEFAULTCHECK variable You can set this variable to time or newer to use timestamps instead of md5 signatures The value of SDEFAULTCHECK is used when a node does not have a check attribute Table 37 3 supported check attribute values time Build the target when the timestamp of the source differs from the last time the target was built Build the target if its timestamp is older than the timestamp of the source This is what the good old newer E make program uses Build the target if the md5 checksum of the source differs from the last time the target was built This ma is the default Like md5 but ignore changes in comments and amount of white space Appropriate for C camas programs Slows down computations considerably none Don t check time or contents only existence Used for directories When mixing newer with other methods the build rules are executed if the target is older than the source with the newer check or when one of the signatures for the other items differs The AAPDIR sign file is normally stored in the dire
59. import name Read a module stored in the main Aap directory or elsewhere This happens in a special scope does not change directory and has no effect on the recipe containing the import command except that the actions filetypes and routes defined in the module become available globally This is the easiest way to add additional language support to Aap See_Chapter 31 Adding A Language Module The recipe s read have the name of the module with aap appended Thus for import java the java aap recipe is used The directories searched for module recipes depend on the platform The first module that is found is used further directories are not searched For Unix systems three directories are used aap modules Alphabetical list of Commands 166 A A P Recipe Executive usr local share aap modules The modules directory of the Aap installation For other systems these directories are used SHOME aap modules SHOMEDRIVE SHOMEPATH aap modules c aap modules The modules directory of the Aap installation HOME HOMEDRIVE and SHOMEPATH are environment variables not Aap variables Additionally recipes in the modules2 subdirectory are loaded This can be used to do additional settings without modifying a distributed module All found recipes are loaded ignoring wether a recipe was already found The same list of directories is used as mentioned above with modules replaced wit
60. is placed on the A A P website so that every Aap user can find it without typing a URL You need to e mail this recipe to the maintainer of the A A P website webmaster AT a a p org Chose the package name carefully because it must be unique Mostly it is the name of the command that was to be executed such as scp or cvs If there is only one recipe it must take care of all systems This is useful for a Python module for example Or when you want to redirect to another site where the recipes for this specific package are stored Here is an example dll alingieeulils execute generic aap fetch http www foo org recipes file Sbuildtarget This recipe redirects everything to another recipe which is downloaded from the URL specified with the fetch attribute Note that the all and install targets are supported all is used to build the package as the current user and install to install it possibly requiring root privileges Adding Support For a Package 92 A A P Recipe Executive Installing on MS Windows For MS Windows you often have a different method to install a package Especially when the command to be installed is available as one executable program Here is an example for the scp command Package recipe for SCP on MS Windows Maintainer Bram Moolenaar lt Bram a a p org gt Last Update 2003 May 1 install We use the scp command from PuTTY it appears to work well For info
61. it s used as the file name WARNING Using_ sysdepend probably makes your recipe non portable syseval stderr redir command Execute shell command command and write its output to stdout Only stdout of the command is captured by default When stderr is just after the command name stderr is also captured Example syseval hostname assign HOSTNAME When used in a pipe the stdin is passed to the command Example print Svar syseval sort assign var Leading and trailing blanks including line breaks are removed Thus the last line never ends in a newline character See_here for redir Note the difference with the sys command redirection in_sys is handled by the shell for_ syseval it is handled by Aap When executing the command fails the result is empty The exit value of the command is available in exit WARNING Using_ syseval probably makes your recipe non portable syspath path arg Use path as a colon separated list of command names use the first command that works When s appears in path it is replaced with the arguments If it does not appear the arguments are appended Other appearences of in path are removed thereby reducing to and to while avoiding their special meaning Don t forget that path must be one argument use quotes around it to include white space Example syspath vim vi emacs foobar txt Output is not logged Alphabetical list of Comman
62. make certain that everyone understands that there is no warranty for this free software If the software is modified by someone else and passed on we want its recipients to know that what they have is not the original so that any problems introduced by others will not reflect on the original authors reputations Finally any free program is threatened constantly by software patents We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses in effect making the program proprietary To prevent this we have made it clear that any patent must be licensed for everyone s free use or not licensed at all The precise terms and conditions for copying distribution and modification follow GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING DISTRIBUTION AND MODIFICATION 0 This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License The Program below refers to any such program or work and a work based on the Program means either the Program or any derivative work under copyright law that is to say a work containing the Program or a portion of it either verbatim or with modifications and or translated into another language Hereinafter translation is included without limitation in the term modification Each licensee is addressed as you Activities other
63. met abort without doing anything if something is known to fail fetchdepend handle dependencies for fetch and checksum fetch get the required files checksum check if the files have correct checksums extractdepend handle dependencies for extract and patch extract unpack archives patch apply patches builddepend handle dependencies for configuring and building config do pre building configuration build build testdepend handle dependencies for testing test check if building was done properly package create a binary package install install the binary package rundepend handle runtime dependencies installtest test if the package fully works and was installed properly For each step a dependency with build commands is added The purpose of each step is further explained below Meaning of dependency The term dependency is ambiguous here You should be able to guess from the context whether it is used for a dependency of one software package on another package or a dependency of a target file on a source file You can do part of the work by starting Aap with one of the step names The steps before it will also be executed if necessary For example aap package will do all the steps necessary to generate the binary package but not install it If your port requires non standard stuff you can specify your own build commands You can replace the normal step prepend something to it and append something to it d
64. modification To avoid it being generated again include the mysign file in the distribution The files to be distributed are mysign main aap prog c version c In the main aap recipe the signfile attribute is used for the dependency that generates version c version c signfile mysign prog c print char timestamp STIMESTR gt Starget The result is that version c will only be generated when prog c has changed When the signfile attribute would not have been used version c would have been generated after unpacking the distributed files Copying All Files At Once The finally target is always executed after the other targets have been successfully built Here is an example that uses the finally target to copy all files that need to be uploaded with one command Source html all remote Source virtual remember CFile rule remote _recipe CFile source Distributing Generated Files 56 A A P Recipe Executive Fama if _recipe CFile scopy _recipe CFile ftp my org www Warning When the_ copy command fails aap doesn t know the targets were not made properly and won t do it again next time Using the publish attribute works better Publishing images for HTML files When publishing HTML files you most likely also want to publish the image files referenced by them You can use a wildcard to select the images files but this may include images that are not actually use
65. of how you can upload your files and make it easy for others to download and install your program Downloading To make it easy for others to obtain the latest version of your program you give them a recipe That is all they need In the recipe you describe how to download the files and compile the program Here is an example 11 Origin ftp ftp mysite org pub theprog 2 3 recipe fetch Origin main aap 4 5 Source main c 6 version c 7 Header common h 8 9 attr fetch SOrigin file Source Header 10 11 program theprog Source The first line specifies the location where all the files can be found It is good idea to specify this only once If you would use the text all over the recipe it is more difficult to read and it would be more work when the URL changes Line 3 specifies where this recipe can be obtained After obtaining this recipe once it can be updated with a simple command aap refresh Aap Updating recipe main aap Aap Attempting download of ftp ftp mysite org pub theprog main aap Aap Downloaded ftp ftp mysite org pub theprog main aap to home mool aap cache 98092140 aap Aap Copied file from cache main aap Chapter 4 Distributing a Program 13 A A P Recipe Executive The messages from Aap are a bit verbose This is just in case the downloading is very slow you will have some idea of what is going on Lines 5 to 7 define the source files This is not different fr
66. of the variable The three variables that only differ by case each have a different value Aap also complains that there is nothing to build just like in the_ hello world example If you want text directly after the variable s value for example to append an extension to the value of a variable the text may be impossible to distinguish from a variable name In these cases you must put parenthesis around the variable name so that Aap knows where it ends all ig MakeName Make sprint MakeName file f can be in a variable name print MakeName txt can be in a variable name print MakeName more is not in a variable name aap f try aap Makefile Make txt Make more Variables and Assignments A A P Recipe Executive All Aap commands except the assignment start with a colon That makes them easy to recognize Some characters in the expression have a special meaning The_ print command also handles a few arguments in a special way To avoid the special meaning use the x form where x is the special character For example to print a literal dollar use See_the user manual for a complete list Comments Someone who sees this recipe would like to know what it s for This requires adding comments These start with a character and extend until the end of the line like in a Makefile and Python script It is also possible to associate a comment with a specific item A A P recipe for compilin
67. perl and python DEPENDS perl python require perl or python Parenthesis can be used to group items Parenthesis must be used when combining or and and relations Example DEPENDS foo bar foobar E NC OO Visalie or A OO DEPENDS foo bar foobar Illegal DEPENDS foo bar foobar a MESS ame circle oa ere Vroni When a dependency is not met the first alternative will be installed thus the order of or alternatives is significant Each item is in one of these formats name version_revision a specific version and revision name any version name regexp a version specified with a regular expression shell style name gt version_revision any version at or above a specific version and revision name gt version_revision any version above a specific version and revision name lt version_revision any version at or below a specific version and revision name lt version_revision Dependency Format 80 A A P Recipe Executive any version below a specific version and revision name version_revision any version but a specific version and revision In the above _revision can be left out to ignore the revision number It actually works as if there is a wildcard at the end of each item name can contain wildcards When a part is following it is appended at the position of the wildcard or at 9 if it comes first foo matches foo big foo big 1 2 and foo 1 2 foo
68. scope overrule variables in the recipe or other scopes Only variables in the local scope come first scope s_opti DEFINE DFOOBAR do build scope s_opti foo c The remove attribute can be used to delete all the arguments after the action was executed This also happens when the action failed This can be used when the argument is a temporary file Example remove tmp tempfname print gt tmp Buy more Spam do email remove to everybody world org subject Spam tmp See_ action for defining actions eval redir python expression Alphabetical list of Commands 164 A A P Recipe Executive in Filter stdin using a Python expression See_here for redir When not used after evaluate the Python expression The Python expression is evaluated as specified in the argument The stdin variable holds the value of the input as a string it must be present when_ eval is used after I See_var2string for information about using Aap variables in the Python expression The expression must result in the filtered string or something that can be converted to a string with strQ This becomes stdout The result may be empty Examples aorta Sito seval resso s PS Y sica gt EE eval os name assign OSNAME pr Note that the expression must not contain a preceded by white space it will be recognized as a pipe Also there must be no gt preceded by white space 1t will
69. stable version is released The user has the choice of installing CVS for himself or for everybody on the system Aap has a build in function for this ask_prefix When the user is root it will return 1 and usr local without asking assuming the super user will want to install for everybody why else would he be doing this as root Normal users will be asked to make a choice Select where to install cvs 1 become root and install in usr local 2 become root and install in specified location 3 install in your home directory home mool 4 install in a specified location a abort choice It is obvious what the choices will do The cvs recipe then continues to obtain the sources using update get tar to allow using a cached file The archive is unpacked with tar and configure is run before invoking make This is the standard way how most Unix programs are build There is one extra step While testing the recipe it was discovered that the configuration makes a mistake and defines HAVE_GSSAPI but that doesn t work The recipe modifes config h to fix this This is not a nice solution but it makes the building work This kind of porting would actually better be done in a separate recipe And by reporting the problem to the maintainers of the CVS configure script When the recipe is invoked with the install target the choice to install as root or not is used This was stored in Installi
70. the filetype of filename on stdout When the type could not be detected the result is the string None Chapter 38 Filetype Detection 140 A A P Recipe Executive The I ruledir argument can be used to specify a directory to load afd Aap Filetype Detection files from These add rules for filetype detection These are the default directories which are always scanned usr local share aap afd aap afd The f rulefile argument can be used to specify a file to load rules from Detection Detection is done in this order early Python items check the file name extensions match the regular expressions with the file name check the first line in the file for a matching script name later Python items Nh UN When on a non Posix system the file name is forced to be lower case so that case differences are ignored The rules must use lower case names for this to work properly Rules with an upper case letter will only match on a Posix system this can be used for H to be recognized as cpp only on systems that make a difference between h and H The Python Module The ft_detect function can be called to detect the type of file fname from Filetype import ft_detect type ft_detect fname A string with the detected filetype is returned If the type is not recognized ft_detect returns the None value To ignore extra suffixes like in gz add an extra non zero argument type ft_det
71. the scope of the command block that invoked the current command block with an_ update command or because of a dependency Then the scope of the command block that invoked that command block and so on This excludes the toplevel 2 The recipe in which the command block was defined its parent and so on This goes on until and including the toplevel This is used both for reading a variable and assigning a new value It is an error when assigning a new value to a variable that does not exist For the commands of an action the sequence is slightly different Variable Indexing 124 A A P Recipe Executive 1 Invoking command blocks That is the scope of the command block that invoked the action with a do command Then the scope of the command block that invoked that command block and so on This excludes the toplevel 2 The recipe in which the do command was invoked its parent and so on This goes on until and including the toplevel 3 The recipe in which the action was defined its parent and so on This goes on until the toplevel The _no scope is used for a variable in recipe commands without a specified scope Thus these two are equivalent sprint foobar poime Sn ole But in Python commands a variable without a specified scope is always in the local scope You must use _no to get the same effect foo Sbar a Eiaeia Moart sum local oi us seoas foo bar finds bar in local scope only foo _no bar i Esas Wio
72. then PREFIX is not prepended DESTDIR is always prepended Note that only the tails of the filenames in sources are used thus installing foo bar txt into the tmp directory results in tmp bar txt mode is normally a string with octal digits e g 0644 Example Files test foo txt test bar txt Dir usr local share imstalll lecal s Gimsta rides ino Dive ine illes VOGAL For uninstalling see_uninstall filesO parentdir arg Prepend PARENTDIR to every item in arg This makes items with a path relative to the parent recipe relative to the current recipe Example ImgFiles parentdir ImgNames Can only be used in a child recipe Also see_childdir and_var_abspath program_path name path None pathext None skip None Returns the path for program name This uses the PATH environment variable or os defpath if it isn t set Additionally the directory where Aap is installed and the bin subdirectory are searched This finds tools supplied with Aap and installed packages This is not done when the optional path argument is supplied On MS Windows and OS 2 also checks with extensions added This uses the PATHEXT Alphabetical list of Python functions 151 A A P Recipe Executive environment variable if set The separator used is if there is one the system dependent separator non otherwise Otherwise the extnsions exe com bat cmd are used When name include
73. to produce the final product depending on settings in the recipe In particular you may need to chose to link a program with the compiler or through libtool depending on whether your program links to any libtool libraries or not The alternatives are listed in the table below as well To select an alternative form to build the final product set the filetype of the target to a specific value e g program myProgram filetype ltprogram source c This example uses the 1t program alternative build command to build the program myProgram Object Build Command Type Command Build Alternatives normal Uses the C compiler to link all the objects into a program Uses LIBS and LDFLAGS ltprogram Uses libtool to link all the objects into a program Uses LIBS and LDFLAGS but also adds LTLIBS and LT_RPATH if defined normal Uses the ar utility to link all the objects into a static library Uses ARFLAGS normal Uses the C compiler to link the objects into a dynamic shared f library The object files are different from regular library objects and a dllobjegt Duncan use a different extension Uses SHLINK and LDFLAGS as well as SHLINKFLAGS normal Uses the libtool utility to link the objects together Uses LDFLAGS In case you do want to have Aap figure out how to turn source files in to objects and then combine them into a target but the target is not one of the types mentioned above you can use the produce
74. upload all the files URL scp user ftp mysite org pub theprog files attr publish S URL Source Header main aap Now you can use aap publish to upload your source files as well Chapter 5 Building Variants A A P provides a way to build two variants of the same application You just need to specify what is different about them A A P will then take care of putting the resulting files in a different directory so that you don t have to recompile everything when you toggle between two variants For the details see variant in the reference manual One Choice Quite often you want to compile an application for release with maximal optimizing But the optimizer confuses the debugger thus when stepping through the program to locate a problem you want to recompile without optimizing Here is an example Uploading 14 A A P Recipe Executive 1 Source main c version c gui c 2 3 variant Build 4 release 5 OPTIMIZE 4 6 Target myprog 7 debug 8 DEBUG yes 9 Target myprogd 10 1111 program Target Source Write this recipe as main aap and run Aap without arguments This will build myprog and use a directory for the object files that ends in release The release variant is the first one mentioned that makes it the default choice The first argument for the variant command is Build This is the name of the variable that specifies what variant will be selected The names of the alte
75. use the debug debug form the tool will convert it to what the compiler actually uses To enable symbolic debug information set the the SDEBUG to yes For other language independent debugging switches like enabling profiling hooks use DFLAGS If this variable is set to yes an import library will be created when building a dll on the Windows platform 144 A A P Recipe Executive Adds support for GNU libtool so that you can use it to build shared libraries in a portable manner Automatically imported if you use a_ Itlib command qt Adds support for the Qt library Chapter 40 Standard Tools A tool has been made for several compilers on different platforms Tools can be selected for use by the usetool and toolsearch commands The following tools are distributed with Aap bec Adds support for the Borland C compiler tools dmd Support for the Digital Mars D compiler The onestep option is supported for this compiler Also if the_ dll target is used it will check for existence of DllMain If it isn t found it will be added Export definitions are delegated to the programmer through using either def files or the export attribute recommended Note that DMD currently supports dll s only for the Win32 platform In addition to using the variables in the D module the tool uses the DEBUG and the OPTIMIZE variables if set If SOPTIMIZE is set to a value larger than 0 the O switch is pas
76. used for MS Windows Arguments for CXXSHLINK Default value shared for Unix not used for MS Windows 129 DATADIR Aap DATAMODE Aap DATESTR Aap DEBUG user DEFAULTCHECK Aap DEFER_ACTION_NAME Aap DEFINE user DESTDIR user DISTDIRS Aap DISTFILES auto DLLCFLAGS user DLLCXXFLAGS user DLLDIR Aap DLLMODE Aap DLLOBJSUF Aap DLLPRE conf DLLSUF conf EDITOR conf EXECDIR Aap EXECMODE Aap EXESUF conf Chapter 35 Common Variables A A P Recipe Executive Sub directory to install data files into Default value share Mode to use for installed data files Default value 0644 read write for the user readable for the group and others Date as a string in the form 2002 Month 11 This does not change while Aap is running Also see TIMESTR and GMTIME The kind of debugging to be done yes means debugging is enabled The variable is not set by default For an example see_the tutorial Check to use when none is speficied Defaults to md5 can be set to time or newer time means that a file is outdated when its timestamp is different from when it was last used newer means a target is outdated when one of the source files has a more recent timestamp Also see the_check attribute Only available in the commands of an action the name the action to which the work should be deferred Preprocessor symbols Used in the same place as CPPELAGS Form DNAME or DNAME value
77. which the message is displayed Other messages are still written in the log file name display message for all everything error errors Aap cannot continue warning warnings things that are wrong but Aap can still continue note notes warnings about things that are probably OK depend dependencies the reasoning about what to build info general info file copy delete up downloads extra extra info why something was done system system shell commands that are executed result the result of system shell commands changedir changing directories The command line arguments v and s can be used to make the most often used selections Aap argument MESSAGE value nothing error warning system info V all verbose all s error silent error Other values can be assigned at the command line For example to only see error and dependency messages aap MESS AGE error depend other arguments Don t forget that excluding error means that no error messages are displayed No matter what messages are displayed all messages are written in the log file This can be used afterwards to see what actually happened Chapter 27 Differences from make An Aap recipe has the same structure as a Makefile But there are many differences The most important and unexpected ones are mentioned here Messages 96 A A P Recipe Executive Build if file does not exist In a Makefile a dependency with only a target is not execut
78. with checking if target is set In rare cases it isn t set and needs to be derived from source Since the object file suffixes have been defined see_above calling src2obj Q takes care of this fname is the first item in source When a D file has been compiled into an object file it needs to be build in a special way To accomplish this the buildaction attribute of the target is set to d_build This action is also defined in the D module The check for D_COMPILE_ACTION takes care of invoking the action that was defined by a tool The first tool found with_ toolsearch will set this variable It can later be changed with a_ usetool command When D_COMPILE_ACTION is not set the default command to compile a D file is executed with_ sys This happens when no appropriate tool could be found Often this is used for Unix where the compile command is the same for various compilers The user may set m_d DMD to the name of the compiler to be used and set DFLAGS to additional arguments What could be added here is using DINCLUDE and DDEFINE like what INCLUDE and DEFINE do for C A compiler may also use DEBUG and SOPTIMIZE Note that these can t be directly used as an argument but must be translated The other actions defined in the module are similar You can see in the example for the D module how the build action is defined saction d_build default CN OSA DS UI INC win lt do D_BUILD_ACTION target target source else sys
79. with tlib termcap with tlib termlib The user can now copy one of the example lines to his config arg file Example select specific terminal library with tlib termcap Comment lines can be used they must start with a Note a comment after an argument doesn t work it will be seen as an argument When updating to a new version of the program the same config arg file can still be used A diff between the old and the new config txt will show what configure arguments have changed Chapter 24 Using Autoconf 88 A A P Recipe Executive Variants And Configure config aap and config h are put in BDIR because they depend on the current system They might also depend on the variant to be built In that case the_ variant statement must be before the use of BDIR However if the variant is selected by running configure the variant must come later config aap and config h are then updated when selecting another variant For the program to find config h in BDIR you must add an option to the C compiler And you have to notify the compiler that the file exists so that it will be included INCLUDE I BDIR DEFINE DHAVE_CONFIG_H non The config cache config log and config status files are also moved to BDIR This means they are not available when running configure again This may be a bit slower since the cache isn t used but it is much more reliable And you can vie
80. 0 BUILDCMD make Bal TESTCMD make test The assignments in lines 19 to 21 specify how building is to be done WRKSRC is the directory below which the source files are unpacked The default is PORTNAME PORTVERSION The archive used for Vim uses vim61 instead thus this needs to be specified The CMD variables set the commands to be used to build the application The default is to use Aap Since Vim uses make this needs to be specified 22 INSTALLCMD make install DESTDIR PKGDIR 23 PREFIX usr local Installing a port is done by creating a binary package and installing that package This makes it possible to copy the package to another system and install it there without the need to compile from sources Lines 22 and 23 specify how to do a fake install with Vim This copies all the files that are to be installed to a specific directory so that it is easy to include them in the package PREFIX specifies below which directory Vim installs its files 25 MASTER_SITES ftp ftp vim org pub vim 26 ftp ftp us vim org pub vim 27 PATCH SITES MASTER_SITES patches MASTER_SITES and PATCH_SITES specify the sites where the Vim files can be downloaded from The first is for the archives the second for the patches Note the use of in line 27 this causes patches to be appended to each item in MASTER_SITES instead of appending it once at the end of the whole list
81. 21 Using Python Python commands can be used where Aap commands are not sufficient This includes flow control selecting the commands to be executed and repeating commands Using Python Lines Single lines of Python code can be included in the recipe by prepending This is most often used for flow control Este os parha sel are loca Aa scopy File usr local bin You can write multiple Python commands just prefix a E to every line Do remember that the amount of indent is used to form command blocks The indent that is used excludes the character When there is a non white character after the the is removed When there is white space after the it is replaced with a space Generally you don t need to worry about this if the indenting looks right it probably is The main advantage of using single Python lines is that they can be mixed freely with Aap recipe command lines You can use Python lines both at the recipe level and in build commands Again just make sure the indent indicates command blocks To learn using Python start at the Python web site _http www python org doc Using Aap variables in Python You can use all the Aap variables in Python code You don t use the Python syntax does not use a dollar for variables When using a scope name as in _recipe var the variable otherwise looks the same as in Aap commands But when omitting a scope name it works differently While var in Aap searche
82. A A P Recipe Executive A A P Recipe Executive Table of Contents a CA O 1 Bram Ol A 1 A RCE ELEL i 1 1 PEIRA A ita vec tis ewaves Wee atelanesonbiaasonti NE E Alsons ONE ONO E T 3 Chapter 1 Getting Started ninoy ceases sects ited EE EEN sedans Goon Gat een eee 3 Install A A PEAR RE ARTERIES 3 Chapter 2 Compiling Pro ri Den diiniita careers 4 A Hello2world COr SOmts 32 o NR 4 Using Aap to Compile hello Mensen i eie eE eroare nso EE EEEE a EE e aR OE ESE E S eio 4 Other things to do with hello world esseesssesssessssesssesssesseesstessesstesseessesssessssesssssseesseesseessesseesseessessee 5 Several Source Filesi oriita aA e AE EE E a e ee a 5 Variables and Assisiments ns seie a a eaea a an a ee aa a a i Aeeiiaea 6 SOMATA TMS fn AA A A A T N AS 7 Depend encie se a 7 Compiling Multiple Pr gra mS eir oeer iei Re E e e EE E a eria iia oi eik 9 Kinds of things yOu can build liiic cots ce iioii a E EE a E e idas N n 10 Chapter 3 Publishing a Web Sites sis inaenea e sche E via E E SR A O A EA ARE E e sabes 10 Uploading The Files ara en ie ie acu Aaa 10 Generating A HTML Ple caidas d sacle REE EE E T AEE EN 11 Using rule to Generate Several HTML Files ceccceecceeececsneeeseceeaneceaceceeeeeeeeseaaeceeaaeneaeeeeeeeees 12 Chapter 4 Distributing a Programi iiei iee eecceeccecsseceseceesceceeeeceeeeecaeeesaeceeaaeceaeeceeeeeeeeeesaecseaeeneaeeceeeeees 13 Donde A 13 Uploading isene Cate cn eee ecw kat debs N L eM
83. BDIR attribute is set to BDIR before the second variant command It does not yet have the selected GUI appended there The list of directories used is now directory contains files build SYS release main build SYS debug main build SYS release console version gui build SYS debug console version gui build SYS release motif version gui motif build SYS debug motif version gui motif build S YS release gtk version gui gtk build S YS debug gtk version gui gtk Building multiple variants at once If you want to build all the variants that are possible use a few lines of Python code Here is an example Building multiple variants at once 52 Wo 09 1 cy Ol PES Gey DS ay SS Xe eo 1 Gy Gal PES N ZA 22 29 24 A A P Recipe Executive variant license erial DEFINE DTRITAL demo DEFINE DDEMO WIL IL DEFINE DFULL variant language chinese DEFINE DCHINESE bulgarian DEFINE DBULGARIAN DEFINE DENGLISH punske print Building with Slicense license for language Slanguage print DEFINE SDEFINE abi g for a da jf Merely Velen sewilil js license fOr a ehis ty Viowlleeuencin emeulicla E language execute main aap build license a language c Invoking Aap without arguments builds the all target which loops over all possible variants
84. But some day these will be removed obsolete name new name aap_sufreplace sufreplace aap_abspathQ var_abspath Alphabetical list of Python functions 154 A A P Recipe Executive aap_expand __ var2string expandvar expand2string Chapter 42 A A P Commands Commands grouped by functionality Dependencies program Define the sources for an executable program lib Define the sources for a static library Itlib Define the sources for a library to be made with libtool dll Define the sources for a shared dynamically loaded library produce Generic way to build something from sources totype Use routes to turn one filetype into another rule Define build commands for files matching a pattern delrule Delete a specific rule clearrules Delete all rules update Update a target build it when it is outdated changed Mark a file as changed Recipes child Read a child recipe include Include another recipe Import Include a module from the Aap distribution execute Execute a recipe recipe Define the URL where the recipe can be obtaind from Actions action Define commands for an action do Invoke an action route Define a route of actions to turn one filetype into another filetype Define filetype detection Up and Downloading fetch Download files fetchall Download all files with a fetch attribute publish Upload the specified files publishall Upload all file
85. COME SI K mea peas ali S eE A ae Building A Target In The First Step 38 A A P Recipe Executive The execute command can also be used at the recipe level This means another recipe is executed during the first step A good example for this is building an application in different variants build the GTK version execute main aap Gui GTK myprog move myprog myprog GTK build the Motif version execute main aap Gui Motif myprog move myprog myprog Motif Using Multiple Recipes There are many ways to split up a project into multiple recipes If you are building one application you mostly build the whole application using a toplevel recipe This recipe specifies the configuration specifies variants and sets variables for choices Separate recipes are used to handle specific tasks For example you can move related sources to a sub directory and put a recipe in that directory to build those sources For this situation you use the_ child command When a project gets bigger and especially when working together with several people you may want to be able to split the project up in smaller pieces which each can be build separately To avoid replicating commands you should put the configuration variants and setting variables in a separate recipe Each recipe can use the_ include command to use this recipe You need to take care that the recipe is not included twice because commands like_ route give an error when repeated and appending to v
86. COMIMAN US ooooononccouuuononononononononononcnnnononononnnnonononononononanonononananananan nana nana na narra na nnnnns 126 Chapter 35 Common V ariablesies i ccsc3e ccccsscsdentisiaeavasceseee cd i i EE cadena nda Nevera aE a 127 Chapter 36 ASSISMMENIS tad ant de e td daa 134 ASSIQMIME al eE a e ee AIR AT A AAA tai 134 A A P Recipe Executive Table of Contents Reference Manual Block ASSIS MME NE anrr Ai ai 136 Chapter 37 ATITIDUT S epeo oeni aneen sraao E EAE ENEE EEE NEO ENE EEE EE ENE OE ro 136 SUCKA tti BUES annone n a a a e ei A raid 138 The check attributes s a ah ES EGS Se EOL EEE E E ESE EN Ees 138 Handling Circular Dependencies ocooocccnooccnoncnnonncnnonacnonocnnonononncnnnnnnnnnonnn conan e ine a E ii ea iaae 139 Chapter 38 Filetype Detection dreii eiiean ea reeds E sin Ei Dan ties dave a R a 140 The Progra nna oE RR 140 Detect OM AEE E E ETA E A E T T EE ETE EE EE ET 141 Th Python Mod A ad 141 Format Of Filetype Detection RUES sosis inneren etine oh ENE a aE EEEE E EEEE EN 141 Chapter 39 Standard M d les nsere eoa aiea eia a Ae ES e RE anaE Aa Ea AA NAN 143 Chapter 40 Standard TOOLS oeei es eE eretara TES oei DREE E EEE EE aan KE EETA KEAS AEAEE SYSS 145 Chapter 41 A A P Python functions eeeeccceesseeeseeceeceeceececeaeceeseceeaaecseaeeeeeeeceaeeesaecseaaeceeneceeneeesas 145 Python functions grouped by functionalitY oooconncnnnonicnnoccnonccnononononannnnacnnonconnconnnncnnna nono nc nano crac cona
87. CVSUSER_MYPROJECT cvs sf net cvsroot myproject File reviseall Careful Files must contain all files that you want to publish in this directory and below If Files has extra files they will be added in CVS Files missing from Files will be removed from CVS You must assign CVSUSER_MYPROJECT your user name on the CVS server Usually you do this in one of your personal A A P startup files for example aap startup main aap Using Sourceforge If you are making open source software and need to find a place to distribute it you might consider using SourceForge It s free and relatively stable They provide http access for your web pages a CVS repository and a server for downloading files There are news groups and maillists to support communication Read more about it at http sf net Since you never know what happens with a free service it s a good idea to keep all your precious work on a local system and update the files on SourceForge from there If several people are updating the SourceForge site either make sure everyone keeps copies or make backup copies at least weekly You can use A A P recipes to upload your files to the SourceForge servers To avoid having to type passwords each time use an ssh client and put your public keys in your home directory for the web pages or on your account page for the CVS server Read the SourceForge documentation for how to do this For uploading web pages you can use a recipe lik
88. Cat Stempfile finally this is executed whether there is an error or not del Stempfile Exception handling can be useful to handle situations where you know something might fail Example Crys sys links dump exec html gt exec txt except sys lynx dump nolist exec html gt exec txt This will execute the links command If this fails for some reason e g because a new version of links does not support the dump argument then the lynx command will be used Chapter 22 Porting an Application Porting an application means starting with the original sources and changing them a little bit to make the application compile and install on a specific system An Aap port recipe offers a simple way to create a port because all the standard work does not need to be specified NOTE not all features mentioned here fully work Make sure you test your port recipe before publishing it Chapter 22 Porting an Application 77 A A P Recipe Executive The Port Recipe The basic idea is that you assign values to a number of predefined variables Aap will then generate the steps for building and installing the package using the values you have specified The presence of the PORTNAME variable triggers Aap to handle the recipe as a port recipe The list of variables is in the next section This is thee list of steps performed when executing Aap without arguments in this order dependehedk early check to see 1f dependencies can be
89. E and SHOMEPATH are environment variables not Aap variables Important The tools directory must have a__ init__ py file so that it is recognized as a package The ___ init__ py file may be empty totype option targettype attribute source Specify that each item in source is to be turned into filetype targettype Dependencies will be added to turn each source file into a file of type targettype How this is done must have been defined with_ route commands before using the_ totype command Example totype footy suffix foo aaa cpp bbb y Alphabetical list of Commands 178 A A P Recipe Executive This turns the file aaa cpp into a file aaa foo with filetype footy Since aaa cpp is recognized as a file with filetype cpp this will use the route from cpp to footy bbb y is turned into bbb foo bbb y is recognized as a file with filetype yacc this will use the route from yacc to footy If the resulting targettype files are additionally to be build together into a program you can use the program command instead A more generic form is the produce command The filename of each target is made from the source file name prepending BDIR The prefix and suffix attributes of targettype are used prefix is prepended suffix replaces an existing suffix When targettype is object the default for suffix is SOBJSUF for dllobject the default is DLLOBJSUF and for libobject
90. EFIX name cvs 1 11 5 tarname S name tar gz all install There is no check for a BSD port here because BSD systems should have a Cvs command already Ask the prefix before compiling Qif not _recipe PREFIX Q_recipe use_asroot _recipe PREFIX ask _prefix cvs Qif not _recipe PREFIX error No prefix given Should use a port recipe for this Installing on MS Windows 93 A A P Recipe Executive if buildtarget all Get the sources and build the executable This can be done by an ordinary user print This will build cvs on Posix machines supdate get tar sys tar xfz tarname cd Sname sys configure prefix PREFIX The GSSAPI stuff breaks the build for me on FreeBSD a solution it can work on other systems If we can find sE COMENG jn sys make else Install the executable This may need to be don cd Sname if _recipe use_asroot eval re sub define HAVE _GSSAPI b stdin D OOE a KESA Assume the directories asroot make buildtarget else sys make buildtarget get tar virtual Starname fetch already http ftp cvshome org Sname file gt COM Note that this recipe specifically mentions the version 1 11 5 This is a bit unusual Better is to refer to the latest stable version Unfortunately for CVS the proper link is not available This means the recipe has to be updated every time a new
91. ES Use PATCH_SITES for CVS PATCHFILES The CVS DISTFILES are put in DISTDIR The CVS PATCHFILES are put in PATCHDISTDIR The directory can be overruled with a distdir dir attribute on individual patch files Files that already exist are skipped if there is a checksum error delete the file s manually checksum Check if checksums are correct The port recipe writer must add the do checksum target with checksum commands to verify that downloaded files are not corrupted Example gt gt gt automatically inserted by aap makesum lt lt lt do checksum Teheekhsunpmo DAG MDI HOO le jej tala 2341142342 34d23d 2545 Checksum SPATCHDISTDIR foo patch3 gz md5 3923858739234 af er enel eee The aap makesum command can be used to generate the lines extractdepend extract Check dependencies for extract and patch Uses DEPEND_EXTRACT unless disabled with AUTODEPEND no Unpack archives in the right place Use SEXTRACT_ONLY if defined otherwise DISTFILES or CVSDISTFILES when CVS was used Uses the extract action To extract a new type of archive add filetype detection for this type of archive define an extract action for this filetype Extraction is done in WRKDIR A subdirectory may be specified with the extractdir attribute on each archive DANS IO IGS EOS Ik Ih ue roo coch la leco extiracicir Coe patch Apply patches not applied already PATCHCMD defines the patch command def
92. ION it is always set to CVSWRKSRC also when WRKSRC was already set Directory inside WRKDIR where files obtained CVSWRKSRC CV Send p the first entry in SCVSMODULES Directory inside WRKDIR where patches are to be PATCHDIR applied Can be overruled for a specific patch witha S WRKSRC patchdir attribute BUILDDIR WRKSRC Variables 79 A A P Recipe Executive Directory inside WRKDIR where building is to be done TESTDIR Directory inside WRKDIR where testing is to be WRKSRC done INSTALLDIR Directory inside WRKDIR where INSTALLCMD SWRKSRC 1s to be done CONFIGURECMD Set to the command ne cone the iodine application Usually configure BUILDCMD Set to the command used to build the application aap Usually just make TESTCMD Set to che command used to test the application aap test Usually make test Set to the command used to do a fake install of the aap install SO application DESTDIR PKGDIR Dependency Format Dependencies on other modules are specified with the various DEPEND_ variables The format of these variables is a list of items NOTE Although you can currently specify dependencies the code for checking them has not been implemented yet Thus the user will have to figure it out by himself Items are normally white space separated which means there is an and relation between them Alternatively I can be used to indicate an or relation DEPENDS perl python require both
93. ND_RUN when empty Only the dependencies specified with DEPEND_RUN will end up in the generated binary package When using a shared library it is recommended to put a dependency on the developer version includes header files in DEPEND_BUILD and a dependency on the library itself in DEPEND_RUN The result is that when installing binary packages the header files for the library don t need to be installed Dependencies For Various Steps 81 A A P Recipe Executive The CONFLICTS variable should be set to specify modules with which this one conflits That means only one of the two packages can be installed in the same location It should still be possible to install the packages in different locations The format of CONFLICTS is identical to that of the DEPENDS_ variables NOTE Although you can currently specify dependencies and conflicts the code for checking them has not been implemented yet Thus the user will have to figure it out by himself Dependencies are automatically installed unless AUTODEPEND is no The dependencies are normally satisfied by installing a port When a satisfying port can not be found a binary package is installed The ports and packages are first searched for on the local system When not found the internet is searched The order of searching can be changed with AUTODEPEND binary only search for binary packages default locations source only search for ports default locations source path usr port
94. ONE y OE Lets see how this works cat foobar txt This is example text for the A A P tutorial Last Change 2002 Feb 29 The useful contents would start here aap Setting date in foobar txt cat foobar txt This is example text for the A A P tutorial Last Change 2002 Oct 21 The useful contents would start here The last command in the example consists of three parts First comes the cat command It reads the foobar txt file and passes it throught the pipe to the next command cat is short for concatenate This is one of the good old Unix commands that actually does much more than the name suggests In this example nothing is concatenated Below you will see examples where it does The second part of the example is the eval command This is used to read the text coming in through the pipe and modify it with a Python expression In this case the expression is a re sub function call This Python function takes three arguments A pattern a replacement string and the text to operate on All occurences of the pattern in the text are changed to the replacement string The pattern Last Change n matches a line with the date that was inserted previously The replacement string contains DATESTR which is an Aap variable that contains today s date as a string e g 2002 Oct 19 The text to operate on is stdin This is the variable that holds the text that is coming in through the pipe Chapter 10 C
95. PAINTER You can set the Aap variable PAINTER to the image editor program to be used The line 999 attribute can be used to specify a line number to jump to The byte 999 attribute can be used to jump to a character position in the file action depend The default dependency checker Works for C and C files Uses gcc when available because it is faster and more reliable Uses an internal function otherwise This attempts to handle the situation that a header file doesn t exist when it needs to be fetched or build but that is not fully implemented yet action view html xml php Uses the environment variable BROWSER Searches a list of known browsers if it s not set Default Actions 101 A A P Recipe Executive action email default Uses the environment variable MAILER Falls back to mail action build default default Does sys CC LDFLAGS CFLAGS o target source LIBS action compile object c cpp Does sys CC CPPFLAGS CFLAGS c o target source action preproc default c cpp Does sys CC CPPFLAGS E source gt target Specifying Actions Applications for an action filetype pair can be specified with this command action action in filetype commands This associates the commands with action action and filetype in filetype The commands are A A P commands just like what is used in the build commands in a dependency The in filetype is used for the source of the action
96. Python commands system commands or a mix of both to do the dependency checking Automatic dependency checking 47 A A P Recipe Executive More about customizing dependency checking in_Chapter 29 Customizing Automatic Depedencies Attributes Overruling Variables Most variables like CFLAGS and BDIR are used for all source files Sometimes it is useful to use a different value for a group of files This is done with an attribute that starts with var_ What follows is the name of the variable to be overruled Thus attribute var_XYZ overrules variable XYZ The overruling is done for dependencies rules actions The attributes of all the sources are used In case the same attribute is used twice the last one wins Another method is to use an add_ attribute This works like var_ but instead of overruling the variable value it is appended This is useful for variables that are a list of items such as DEFINE Example attr thefile c add_DEFINE DEXTRA yes The value of the attribute is only appended when it does not appear yet to avoid adding it two or more times Another method is to define a scope name This scope is then used to find variables before searching other scopes but after using the local scope For example to specify that the s_opt scope is to be used when compiling filter c a PTIMIZE 0 DEBUG yes ZO zci co 2 Melno E ELITS VoraLOn E attr scope s_opt filter c s_op
97. Recipe Executive Defining a Compile Action The lower half of foo aap specifies the compile action for the foo filetype action compile foo sys foocomp source o target The action command has two arguments The first one specifies the kind of action that is being defined In this case compile This action is used to make an object file from a source file The second argument specifies the type of source file this action is used for in this case foo Below the action line the build commands are specified In this case just one there could be more The sys command invokes an exteral program foocomp and passes the arguments In an action source is expanded to the source of the action and target to the target These are obtained from the do command that invokes the action Example do compile target srcZobj main foo gt main foo This do command invokes the compile action specified with its first argument The target is specified as an attribute to the action the source is the following argument main foo When executing the do command the filetype of main foo is detected to be foo resulting in the compile action for foo to be invoked In the build command of the action source and target are replaced resulting in saya LOOCCMIOS mam tos O SireZoloy masia too Note that in many cases target is passed implicitly from a dependency and does not appear in the do command argument Anothe
98. TY 11 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE THERE IS NO WARRANTY FOR THE PROGRAM TO THE EXTENT PERMITTED BY APPLICABLE LAW EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND OR OTHER PARTIES PROVIDE THE PROGRAM AS IS WITHOUT WARRANTY OF ANY KIND EITHER EXPRESSED OR IMPLIED INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU SHOULD THE PROGRAM PROVE DEFECTIVE YOU ASSUME THE COST OF ALL NECESSARY SERVICING REPAIR OR CORRECTION 12 INNO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER OR ANY OTHER PARTY WHO MAY MODIFY AND OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE BE LIABLE TO YOU FOR DAMAGES INCLUDING ANY GENERAL SPECIAL INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES Appendixes 189 A A P Recipe Executive END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program and you want it to be of the greatest possible use to the public the best way to achieve this is to make it
99. UERO An advantage of using a different suffix for every type of object file is that all types can be generated in the same directory If the compiler or linker does not support using different suffixes but the various object files are different the user must make sure that the object files are put in different build directories This can be done by specifying an attribute on the source files to use a different build directory Object File Suffixes 111 A A P Recipe Executive Doa CoG One uses SBDIR z 500 2 1008 el labs ro DslR Celelet Sillon TOD ena lam M sN Sian illo Searching For Tools When there is only one compiler that always uses the same type of arguments you can simply invoke it directly from the actions in the module Otherwise Aap can search for tools that are currently installed The working of tools is explained in Chapter 30 Customizing Default Tools As an example let s look at how Aap searches for C compilers Qif osname mswin toolsearch msvc mingw gcc icc bcc elif osname os2 toolsearch icc gcc msvc The_ toolsearch command is used with a list of tools that need to be checked for The first tool for which the exists function returns True is then used This works by setting variables to the name of the action to be used For example the msvc tool sets C_COMPILE_ACTION to compile_msvc The list of tools to be searched depends on the platform Note that the msvc to
100. UF for targetsuffix nothing for targetprefix SOBJSUF for objectsuffix object for objecttype INSTALL_EXEC for installvar and build for buildaction In addition onestep can be used to make A A P build the program without creating intermediate object files if it is supported by the tools see Chapter 40 Standard Tools This solution might be faster for very fast compilers attr val is an optional attribute that apply to the generated dependencies Use the scope attribute to specify a user scope to be used before other scopes but after the local scope in the generated dependencies The target will be added to SINSTALL_EXEC Use the installvar option to select another variable name Use installvar when installing the target is not wanted The target and intermediate files will be added to _recipe CLEANFILES The source files will be added to _recipe DISTFILES except the ones with a nodist attribute Can only be used at the recipe level progsearch varname progname Check if an executable progname exists in PATH If not check further arguments The first one found is assigned to variable varname If none of the progname could be found varname will be set to an empty string Example Alphabetical list of Commands 171 A A P Recipe Executive progsearch BROWSER netscape opera if BROWSER sys SBROWSER readme html proxy protocol address Specify a proxy server Examples am
101. about PuTTY see http www chiark greenend org uk sgtatham putty print This will install SCP on MS Windows dir Global aap_bindir smkdir force dir fetch fetch http the earth 1li sgtatham putty latest x86 pscp exe ftp ftp chiark greenend org uk users sgtatham putty latest x86 pscp exe dir scp exe a Ublgveue Vis all te clossia e mese CO be installsc The actual work is done with one_ fetch command It specifies two locations where the program can be downloaded Specifying several locations is useful because servers may be down or unreachable from behind a firewall some companies disable access to ftp servers Note the use of Global aap_bindir This is the directory where Aap itself is located with bin added Putting the executable there avoids asking the user to make a choice This directory is always searched for executable commands it does not have to be in PATH Double quotes are used for the case the directory contains a space e g C Program Files Building and Installing on Unix For Unix things are generally a bit more complicated The best is to use the package mechanism of the system Using a BSD port was mentioned above Most systems have an equivalent mechanism When this is not available you need to fall back to compiling from sources Here is an example for cvs Package recipe for CVS on Posix Maintainer Bram Moolenaar lt Bram a a p org gt Last Update 2003 May 1 PR
102. above Skipping Configuration Running configure can take quite a bit of time And when you are not going to build anything that can be annoying For example aap comment doesn t require configure to run Variants And Configure 89 A A P Recipe Executive Also configure doesn t work on a non Unix system When you have taken care in your code to handle this you can simply skip configure This line above all the configure code should take care of this if osname posix and has_build_target The has build target function checks for a target that will do some kind of building which means configure must be run A Complete Example Using all the parts mentioned above together we have a fairly complete method to handle running autoconf and configure This code is used in the recipe that builds the Exuberant Ctags program On Unix we run configure to generate config h and config aap This is skipped if there is no building to be done e g for clean if osname posix and has_build_target config h and config aap are generated in BDIR because the ar different for each system Tell the compiler to find config h in BDIR INCLUDE ISBDIR DEFINE DHAVE_CONFIG_H Run autoconf when needed but avoid doing this always not everybody has autoconf installed Include mysign in the distribution it stores the Signature of the distributed configure script
103. ach part to be compiled separately and also want to build the complete program A convenient way to do this is putting files in separate directories and creating a recipe in each directory The recipe at the top level is called the parent Here is an example that includes two recipes in subdirectories called the children child core main aap sets Core_obj child util main aap sets Util_obj q UNE program theprog core Core_obj util Util_obj In the first two lines the child recipes are included These specify how the source files in each directory are to be compiled and assign the list of object files to Core_obj and Ut il_obj This parent recipe then defines how the object files are linked together to build the program theprog In line 4 a special mechanism is used Assume that Core_obj has the value main c version c Then core Core_obj will expand into core main c core version c Thus core is prepended to each item in Core_obj This is called rc style expansion You can remember it by thinking of the to multiply the items Chapter 9 More Than One Recipe 25 A A P Recipe Executive An important thing to notice is that the parent recipe does not need to know what files are present in the subdirectories Only the child recipes contain the list of files Thus when a file is added only one recipe needs to be changed The core main aap recipe contains the list of files in the core directory Source main c
104. action target filetype source filetype This order may seem a bit strange Remember that putting the target left of the source also happens in a dependency and an assignment There are three commands for the build action lines 6 to 8 The first one assigns the name of the object file for version c to version_obj version c was not included in the program command at the top it is compiled here explicitly in line 7 This is what makes sure version c is compiled each time prog is built The other source files will be compiled with the default rules for command Finally the do build command in line 8 invokes the build action to link all the object files together Note that the filetype for the build action is explicitly defined to program This is required for this do command to use the default action for a program target Otherwise the action would invoke itself since the filetype for target is myprog For more information about customizing filetype detection and actions see Chapter 28 Customizing Filetype Detection and Actions Chapter 9 More Than One Recipe When you are working on a project that is split up in several directories it is convenient to use one recipe for each directory There are several ways to split up the work and use a recipe from another recipe Children A large program can be split in several parts This makes it easy for several persons to work in parallel You then need to allow the files in e
105. ain Source Path The sources for a dependency are searched for in the directories specified with SRCPATH The default is BDIR which means that the sources are searched for in the current directory and in the build directory The current directory usually is the directory in which the recipe is located but a cd command may change this The srcpath attribute overrules using SRCPATH for an item Example saren benr sica side illo To avoid using SRCPATH for a source so that it is only found in the current directory make the srcpath attribute empty LODO E Sre HOOMCMESHaG poeta When setting SRCPATH to include the value of other variables you may want to use so that the value of the variable is not expanded right away but when SRCPATH is used This is especially important when appending to SRCPATH before a_variant command since it changes BDIR Example SRCPATH include Warning Using the search path means that the first encountered file will be used When old files are lying around the wrong file may be picked up Use the full path to avoid this Depending On A Directory When a target depends on the existence of a directory it can be specified this way hO OGMEG HOON OOA rE CEOL Soria SSHESUECENE ais aL 1200 The directory will be created if it doesn t exist The normal mode will be used 0777 with umask applied When a different mode is required specify it with an octal value directo
106. akes your recipe non portable sysdepend filepat pattern srcpath path command Execute shell command command It is supposed to figure out automatic dependencies When an included file cannot be found by the shell command an error message is expected that indicates which file is missing Aap will then attempt to fetch or update the file and run command again Error messages that match pattern are recognized and handled in a special way The pattern must contain one group a pattern in parenthesis which matches the file name in an error message The files where the pattern matches are then updated like_ update is invoked The command is then executed again The srcpath option is used to find the files from the error messages When it is omitted the following directories are searched 1 Directories from the INCLUDE variable 2 The first directory in the source variable 3 The current directory Alphabetical list of Commands 176 A A P Recipe Executive The repetition of executing the command and finding matching file names is repeated until there are no more matching error messages or the list of file names is the same as the previous time An example sysdepend filepat File not found depcheck source gt target Be careful to exactly match the filename with the pattern inside Leading and trailing white space is ignored When necessary to use another group use pattern to avoid
107. al thing to do Note that for an absolute path relative to the root of the file system you use either one or three slashes but not two Thus file etc fstab and file etc fstab are the file etc fstab A relative path has two or no slashes but keep in mind that moving the recipe will make it invalid You can also use file file or file file for a file in your own home directory and file jan file or file jan file for a file in the home directory of user jan In the fetch attribute the string file can be used where the path of the local target is to be inserted This is useful when several files have a common directory Similarly basename can be used when the last item in the path is to be used This removes the path from the local file name thus can be used when the remote directory is called differently and only the file name is the same Examples attr fetch ftp ftp foo org pub foo Sfile src include bar h Gets the file src include bar h from ftp ftp foo org pub foo srce include bar h attr fetch ftp ftp foo org pub foo src 2 0 include basename src include bar h Gets the file src include bar h from ftp ftp foo org pub foo src 2 0 include bar h Defining Your Own Method To add a new fetch method define a Python function with the name fetch_method where method is the word at the start The function will be called with four arguments dict a dictionary with reference
108. ally includes source When this argument is defined the action can be used in a route with a following action Example source c The target file name is the source file name with c appended Return Value The define_action function returns an Action object This can be used to overrule the get_out_types and get_in_types functions These should return a list of the currently supported output and input filetypes for the action See the default aap recipe for more examples The defer_action_name function can also be overruled It must return the name of an action to defer the work to or None Example python act derine crio Mama dense TL WWW if DEFER_ACTION_NAME do DEFER_ACTION_NAME target target source else sys me lt source gt Starget U L outtypes me intypes moo def buildme_name source name get_var_attr source buildaction if name return name return None act defer_action_name buildme_name def buildme_outtypes source intype None if intype and intype not in self intypes return return me Note that the defer_action_name function must support an optional argument source which is a string containing the source files used In the example the buildaction attributes of the source files are used to find a specific action to be used for building do_BSD_port name target Alphabetical list of Python functions
109. ally useful that you want to use it in many different projects A typical example of such a group of settings is language support for a specific programming language In order to add support for a new language say D you need to define actions set variables etc It is tedious to use include so Aap allows you to store such settings in a module A module is a recipe like any other except it is stored in the main Aap directory along with the system default aap You can read a module with the import command This works very much like the include command except 1 The recipe is read from the main Aap directory 2 Each module is imported only once Sharing Modules 27 A A P Recipe Executive Aap includes modules for standard languages and build systems It does not read these recipes by default because they add additional overhead even when you do not use the languages they specify Therefore support for the D language using libtool to build libraries and KDE support among others is included in modules that you can use when needed A full list of modules can be found in_Chapter 31 Adding A Language Module Executing a Recipe Besides child and include there is a third way to use another recipe execute This command executes a recipe This works as if Aap was run as a separate program with this recipe except that it is possible to access variables in the recipe that has the_ execute command Here is an example p
110. alues 39 1 Variables of the D module A A P Recipe Executive Tutorial Table of Contents 1 Getting Started 2 Compiling a Program 3 Publishing a Web Site 4 Distributing a Program 5 Building Variants 6 Using Python 7 Version Control with CVS 8 Filetypes and Actions 9 More Than One Recipe 10 Commands in a Pipe 11 A Ported Application Chapter 1 Getting Started Aap is a program that builds compiles and links other programs much like the venerable make 1 program However Aap uses the power of Python to make the recipes instructions on how to build a program more readable and more flexible Aap can also replace the age old autotools and make toolchain Aap does not trade power for complexity For many programs you need only list the name of the program the sources and libraries it needs and Aap does the rest A powerful module system makes adding new programming languages to Aap s repertoire fairly straightforward Aap supports C C D Qt s moc KDE s dcopidl and libtool Installation To start using Aap you must have two applications e Python version 1 5 or later e Aap Python is often installed already Try this python V If you get a Command not found error you still need to install Python Help for this can be found on the Python web site www python org download For obtaining and installing Aap look here www a a p org download html A summary for the impatient e Create a d
111. am assertpkg Check if a package is present install it when not installpkg Install a package unconditionally setool Specify what tool to use toolsearch Search for tools that can be used Alphabetical list of Commands This is the alphabetical list of all A A P commands Common arguments are explained _at the end Some commands can be used in a pipe A pipe is a sequence of commands separated by l where the output of one command is the input for the next command Example cae os 6val me swo tlre Else Steclua session loaic Unix tradition calls the output that can be redirected or piped stdout Reading input from a pipe is called stdin In the commands below redir indicates the possibility to redirect stdout action action filetype out filetype in Define the commands for an action See Chapter 28 Customizing Filetype Detection and Actions action makeme primary me moo eyes me lt Ssiomicee Seep Siena Alphabetical list of Commands 157 A A P Recipe Executive The optional primary attribute just after the action name indicates that this is the preferred action to be used for turning the specified input filetypes into the specified output filetypes See_ do for executing actions add attr val fname Version control command also see_Chapter 18 Version Control Add the files to the repository The files must exist locally Implies a commit of the files addall option
112. an C sources for dependencies Just like HASGCC does this for C Directories to find include files Used in the same place as CPPFLAGS Form Ipath The tools will convert this to the argument the compiler actually uses Sub directory to install include files into Default value include Mode to use for installed include files Default value 0644 read write for the user readable for the group and others Sub directory to install info files into Default value info Mode to use for installed info files Default value 0644 read write for the user readable for the group and others Command to execute the linker The default is empty in which case CC is used But when USECXXLD is set happens when a C file was compiled the default becomes CXX Arguments for linking before the object files The default is empty Program to turn a lex file into C The default is empty When the lex action is invoked Aap will search for flex and lex and set LEX to the found program Flags for LEX There is no default value Program to turn a lex file into C The default is empty When the lexpp action is invoked Aap will search for flex lex flex and lex and set LEX to the found program Flags for LEXPP There is no default value Sub directory to install static library files into Default value lib Mode to use for installed static library files Default value 0644 read write f
113. anges the value of BDIR See Chapter 14 Variants 4 build rules and actions Rules that define dependencies and build commands that apply to several files defined with rule commands Actions can be defined for what is not included in the default actions or to overrule the defaults actions to do a different way of building 5 explicit dependencies Dependencies and build commands that apply to specific files Use these where the automatic dependency checking doesn t work and for exceptions Common Recipe Structure 37 A A P Recipe Executive 6 high level build commands program d11 etc can be used for standard programs libraries etc This comes last so that explicitly defined dependencies for building some of the items can be used For larger projects sections can be moved to other recipes How you want to do this depends on whether these sub recipes need to be executed by themselves and who is going to maintain each recipe More about that below Building A Target In The First Step Since commands at the recipe level are executed in the first step some building may already be done Especially the update command gives you a powerful mechanism This means you can already build a target halfway the first step Note that only dependencies that have already been encountered will be used then A good use for the update command at the recipe level is to generate a recipe that you want to include Useful for automati
114. anted The target and intermediate files will be added to SCLEANFILES The source files will be added to DISTFILES Can only be used at the recipe level log text Write the arguments to the log file AAPDIR log This is like_ print but the text is not echoed The output cannot be redirected or piped since there isn t any ltlib option target attr val source Specify that target is a library build from source with the libtool program Dependencies will be added to compile each source into an object file and combine the object files together into target Very similar to_lib Using libtool requires importing the libtool module Since_ltlib will not work without it the libtool module is automatically imported See_ produce for the options The default values used for Itlib are SLTLIBSUF for targetsuffix LTLIBPRE for targetprefix LTOBJSUF for objectsuffix Itobject for objecttype INSTALL_LTLIB for installvar and buildltlib for buildaction The target will be added to SINSTALL_LTLIB Use the installvar option to select another variable name Use installvar when installing the target is not wanted The target and intermediate files will be added to SCLEANFILES The source files will be added to DISTFILES Can only be used at the recipe level mkdir option dir Create directory This fails when dir already exists and is not a directory Each argument is handled separatel
115. argets This makes it possible to specify build commands that produce several files at the same time Here is an example that compiles a file and at the same time produces a documentation file oO LOO Incl 2 coq See 238 SECC sources o SCteveqeic 01 neni Sarget 401 People used to make must be careful they might expect the build commands to be executed once for each target Aap doesn t work that way because the above example would be impossible To run commands on each target this must be explicitly specified Example cawl ehir lies for item in target_list smeek Site The variable target_list is a Python list of the target items Another such variable is source_list it is the list of source files this excludes virtual items depend_list also has the virtual items An extreme example of executing build commands for each combination of sources and targets Command block sections 46 A A P Recipe Executive SOutputFiles InputFiles Etoo sece alin wener lists sociae Stare Or A CO AS E O itone sue sin souece Jal sites SENS roorilrter DSi Sere gt gt Siting When multiple targets are used and there are no build commands this works as if each target depends on the list of sources Thus this dependency el t2 3 Gi S2 Sd Is equivalent to eL S AL EA GS ES ES LESS Thus when t1 is outdated to s1 s2 or s3 this has no consequence for t2 Automatic dependency checking When a source file includes other f
116. ariables must only be done once Aap will read a recipe only the first time it is included when you add the once argument to the include command Recipe Execution Details The two step processing of recipes is part of all the work that Aap does There are a few other steps This is what happens when Aap is run 1 Read the startup recipes these define default rules and variables These recipes are used default aap from the distribution all recipes in system and user Aap directories see below 2 Recipe processing Read the recipe main aap or the one specified with the f argument and check for obvious errors Then execute the toplevel items in the recipe Dependencies and rules are stored Also read included and child recipes and execute the toplevel items in them 3 Apply the clever stuff to add missing dependencies and rules This adds a clean rule only if the recipe didn t specify one for example 4 Target building The first of the following that exists is used targets specified on the command line items specified with_ program _ dll and_ lib the all target 5 If the finally target is specified execute its build commands Each recipe can have its own finally target they are all executed Using Multiple Recipes 39 A A P Recipe Executive The startup recipes are read from directories that depend on the system For Unix systems files in two directories are used usr local sha
117. ariants execute build aap GUI motif execute build aap GUI gtk exit Quit executing recipes When used in build commands the finally targets will still be executed But a_ guit orsexit in the commands of a finally target will quit further execution fetch attr val file Fetch the files mentioned according to their fetch or commit attribute When a file does not have these attributes or fetching fails you will get an error message An attribute that appears before the files it is applied to all files Files that exist and have a fetch attribute with value no are skipped The name can be used to update the current directory fetch fetch cvs SCVSROOT The usecache attribute can be used to use a cached version of the file This skips downloading when the file was downloaded before but may use an older version of the file nocache does the opposite never use a cached file The constant attribute can be used to skip fetching a file that already exists This is useful for a file that will never change when it includes a version number Implies usecache fetchall attr val Fetch all the files in the recipe and child recipes that have the fetch attribute Extra attributes for fetching can be specified here they overrule the attributes of the file itself filetype argument Specify filetype detection See Chapter 28 Customizing Filetype Detection and Actions
118. assignment target The order of arguments is irrelevant Options are explained in the next section Assignments take the form VAR value This works just like putting this at the top of the main recipe used But the shell used to start Aap may require escaping special characters such as spaces Putting the argument in double quotes often works but not always Targets specify what needs to be done If no target is given one of the targets in the recipe is executed see Recipe Execution Details Variables in the targets are expanded This makes it possible to build a target in a directory whose name is set in the recipe For example to build a target in BDIR aap SBDIR foo o Note you must make sure that the variable is not expanded by the shell In the example this is done by putting the argument in single quotes This works for most Unix shells To use a target with a character in the name use in place of the Options An option must appear only once except for the ones that are noted to be allowed multiple times a nocache For a remote file don t use a cached copy Download it once for this invocation Note that the file Reference Manual 115 A A P Recipe Executive may be downloaded anyway because it is not always possible to check if the cached copy is still valid Use the usecache or constant attribute on a file to use the cached version whenever possible see_ fetch c command command
119. ation or if it was never published The signatures are updated as usual unless nobuild is used as well Thus the new buildcheck and publish attribute are stored This is useful if the buildcheck or publish argument changed in a way that you know does not require building or publishing d flags debug flags Switch on debugging for flags Not implemented yet f file recipe fil Specify the main recipe to read When an URL is used the recipe is downloaded to the current directory before it is used The name is the last part of the path If it already exists the user is asked Reference Manual 116 E h A A P Recipe Executive whether it should be overwritten Example cd usr local share vim vim62 runtime aap f ftp ftp vim org pub vim runtime main aap When the file is NONE no recipe is read This is useful when only a command is to be executed Example aap f NONE c print AAP help force Force rebuilding everything That a target is already up to date is ignored Print a help message and exit Does not read a recipe I directory include directory Add a directory to search for included recipes This option may appear multiple times install package Install the package package Only works for those packages that are supported such as cvs and rep Does not read a recipe in the usual way only the specified package is installed j number jobs
120. attr check md5 SSource Watch out for unexpected results when rc style expansion is done for VAR Example VAR one two Foo SRAWINR GjLolo 1 5 Emo Would result in Foo one one tmp two one tmp two tmp because the part is expanded first thus the assignment is executed like Foo VAR one tmp two tmp The backticks for a Python expression are also recognized inside quotes Thus you need to escape the special meaning there Using Python Expressions 75 A A P Recipe Executive WOO Yehies O jee thers iile Backtick expressions can be used inside a string if you really need this DIR home foo home bar ona WDR qe Wai ales au results in home foo home bar fi le Compare this to iprint VS MDI ien ler which results in home foo fi le home bar fi le Python Block A block of Python commands is started with a python command If no terminator string is specified the python code ends where the indent is equal to or less than the python command SOULS SAME OOM cane python POS al a temas Source Source i Target foo Optionally a terminator string may be specified The indent of the Python code may then drop below the indent of the_ python command The terminator cannot contain white space A comment may follow The Python block continues until the terminator string is found in a line by itself It may be preceded and followed by white space and a comment may follow Example
121. ault cc Arguments always used for CC NOTE it s not CCFLAGS This is inconsistent used for historic reasons In a child recipe The directory of the child recipe relative to the parent recipe When using child subdir main aap CHILDDIR will be subdir in the child recipe Names of directories that the clean target should remove Names of files that the clean target should remove The program command adds files to this Names of directories that the cleanmore target should remove Names of files that the cleanmore target should remove Obsolete See C_ COMPILE ACTION and CXX COMPILE ACTION Sub directory to install configuration files into Default value etc Mode to use for installed configuration files Default value 0644 read write for the user readable for the group and others Arguments for CC when compiling sources not when linking objects These are raw arguments not always portable Use SINCLUDE and DEFINE when possible Cvs program to use No arguments are allowed May include spaces When not set cvs is used Cvs command to use This overrules CVS and may include arguments E g cvs z 9 Spaces in the program name must be escaped as expected for the shell When not set CVS is used Command for compiling C files Arguments always used for CXX Name of linker used to combine object files from C sources into a shared dynamic library Default value CXX for Unix not
122. ault patch p lt The patch file name is appended unless s appears in the string then it s replaced by the file name A patchcmd attribute on each patch file may specify a patch command that overrules PATCHCMD The patches are applied in WRKDIR PATCHDIR default WRKSRC A patchdir attribute on each patch file may overrule the value of PATCHDIR builddepend Steps 83 config build A A P Recipe Executive Check dependencies for configure and build Uses DEPEND_BUILD unless disabled with AUTODEPEND no Perform configuration Executes the command specified with CONFIGURECMD Usually autoconf imake etc May be empty Run the command specified with BUILDCMD When empty aap is used Useful values are n gmake make etc An argument may be included Example BUILDCMD make foo Done in WRKDIR BUILDDIR default WRKDIR WRKSRC testdepend test Check test dependencies Uses DEPEND_TEST check if all required items are present try to install them automatically unless disabled AUTODEPEND no This is skipped when SKIPTEST yes Check if building was done properly Executes TESTCMD When it is empty aap test is used Example TESTCMD make testall This is skipped when SKIPTEST yes Done in WRKDIR TESTDIR default WRKDIR WRKSRC package install Steps Create a package with selected files usually including the compiled program There are two methods to select files to be
123. ault mode default directory mode install exec INSTALL_ EXEC installexec EXECDIR bin EXECMODE 0755 install sbin INSTALL_SBIN installsbin SBINDIR sbin EXECMODE 0755 install lib SINSTALL_LIB installlib LIBDIR lib LIBMODE 0644 install dll SINSTALL_DLL installdll DLLDIR lib DLLMODE 0755 No default settings for libtool libraries have been added to Aap yet It seems likely that DLLDIR and DLLMODE will be used install conf INSTALL CONF installconf CONFDIR etc CONFMODE 0644 install data INSTALL_DATA installdata DATADIR share DATAMODE 0644 install man INSTALL_MAN installman MANDIR man b MANMODE 0644 install info SINSTALL_INFO installinfo SINFODIR info INFOMODE 0644 install include INSTALL_INCLUDE installinclude INCLUDEDIR include INCLUDEMODE 0644 lal A subdirectory will be added with the name PKGNAME You must set this variable to the name of your application In the rare situation that you need to install into multiple directories you may set PKGNAME to an empty string and prepend the directory name to your data files install Itlib SINSTALL_LTLIB b A subdirectory will be added that uses the extension of the file For foo 1 the directory is man1 for foo 2 it is man2 and so on The_ program command adds its target to the SINSTALL_EXEC variable The_lib command adds its target to the SINSTALL_LIB variable The_ dll command adds its target to the SINSTALL_DLL variable The_ Itlib command
124. blishing images for HTML files 57 A A P Recipe Executive Statusi SiePMcwis EXE Source main c version c Header common h tange c mmy STarget Source Status Cat SStatus do build Ssource specify where to fetch the files from attr fetch cvs pserver anonymous cvs myproject sf net cvsroot myproject Source attr fetch ftp ftp myproject org pub file Status Note that the header file common h is given a fetch attribute but it is not specified in the dependency The automatic dependency checking will notice the file is used and fetch it when it s missing When using files that include a version number in the file name fetching isn t needed since these files will never change To reduce the overhead caused by checking for changes give these files a constant attribute with a non empty non zero value Example PATCH patches fix 1 034 diff fetch SFTPDIR constant To fetch all files that have a fetch attribute start Aap with this command aap fetch When the fetch target is not specified in the recipe or its children it is automatically generated Its build commands will fetch all nodes with the fetch attribute except ones with a constant attribute set non empty non zero To do the same manually fetch fetch Source Header Status Or use the fet chal 1 command NOTE When any child recipe defines a fetch target no automatic fetching is done for any of the recipes
125. c configuration You would do something like this config aap config aap in ROSIE EXEC Ela COME LEE cion SCI a sys conf sh lt source gt Starget update config aap include config aap First a dependency is specified with build commands for the included recipe In this case the config aap in file is used as a template The command update config aap invokes building config aap If it is outdated config aap in was changed since config aap was last build the build commands are executed If config aap is up to date nothing happens Then the include config aap includes the up to date config aap recipe Nesting The Steps In the second step commands of dependencies are executed One of these commands may be execute This means another recipe is read and targets are build These are again the first and second step mentioned before but now nested inside the second step Here is an example that executes a recipe when docfile html is to be build docfile html execute docs main aap Starget This construction is useful when you do not want to read the other recipe in the first step Either because it is a large recipe that is not always needed because the recipe does not always exist or because the recipe must first be build by other commands Here is an example of using a depencency on a recipe docfile html docs main aap execute docs main aap Starget docs main aap docs main aap in REO docs AWS o
126. c motif c The motif and gtk variants each add a source file in line 15 and 17 For the console version no extra file is needed The object files for each combination of variants end up in a different directory Ultimately you get object files in each of the six directories SYS stands for the platform being used directory contains files build SYS release console main version gui build SYS debug console main version gui build SYS release motif main version gui motif build SYS debug motif main version gui motif build SYS release gtk main version gui gtk Two Choices 16 A A P Recipe Executive build S YS debug gtk main version gui gtk See the_user manual for more examples of using variants Chapter 6 Using Python In various places in the recipe Python commands and expressions can be used Python is a powerful and portable scripting language In most recipes you will only use a few Python items But where needed you can do just about anything with it Expressions Almost anywhere you have a value such as a text string you can use a Python expression instead For instance you could use a Python expression to retrieve the value of an environment variable for use in a recipe or use an expression to compute some strange value Expressions are written between backticks and must be valid Python expressions Some examples 1 myhome os environ get HOME 2 aloe UU
127. ce is version c main c Header is version h main h The_sufreplaceQ function takes three arguments The first argument is the suffix which is to be replaced The middle argument is the replacement suffix The last argument is the name of a variable that is a list of names or a Python expression In this example each name in Source ending in c will be changed to end in h Further Reading The User manual Chapter 21 Using Python has more information Documentation about Python can be found on its web site http www python org doc Chapter 7 Version Control with CVS CVS is often used for development of Open Source Software A A P provides facilities to obtain the latest version of an application and for checking in changes you made Further Reading 20 A A P Recipe Executive Downloading Checkout For downloading a whole module you only need to specify the location of the CVS server and the name of the module Here is an example that obtains the A A P Recipe Executive CVSROOT pserver anonymous cvs a a p sf net cvsroot a a p alle fetch fetch cvs CVSROOT Exec Write this recipe as main aap and run aap The directory Exec will be created and all files in the module obtained from the CVS server aap Aap CVS checkout for node Exec Aap cvs d pserver anonymous cvs a a p sf net cvsroot a a p checkout Exec cvs server Updating Exec U Exec Action py U Exec Args py
128. ceeeesaeeeesaeceeaeeneaeeceaees 107 Building in adifferent WAY Ai ead eae ea lia 107 Adding A NeW Dolina 108 Using A Specie OOl oeo i EEn noe e E a O E E a a ante unt AASS 108 Chapter 31 Adding A Language Module eee ceccccesssecesceceseeeeaeesaaecseaceceaceceeeeeeeessaeceeaeeeeaeeeeaees 109 Mo dtile Names a o trios 109 Module dE COMES eee Re eee ee 109 Parts OFA Module inicisicin iii 110 Example A tases cise ac eae vod aa RA da ties 110 Object File SU ES ci AA sa 111 Searching FOr Tool LT a a E Ea aS 112 Actions Rules and ROUES iein Ea lnea ide dei aaa detenta cada a da 113 BA cscssssciescsceecteescudacesctessescscssastocseastectessncceveseszecesscbecsedsscebedoccasssessesssessecccecbestestestessceseseess 115 Chapter 32 Aap Command Line Argument ce cccceesseceececeeeeeeeeeeaaeceeaeeceaeeceaeeesaeeeeaaeceeaeeeeaeeeeaees 115 Three Kinds Of ArgUMents stories Ee ENEE REE EENET EN 115 ODO A a n A A e i A ride 115 Chapter 33 Recipe Syntaksi rinse seid acta cet iis Meade an Sea eae 118 Chapter 34 Variables and SCOPES ccccesscesecceeseecessecesseeceececeeeecsaeeeaaecseaeeceaceceaeeeeaeeeeaaecseaeeneaeeceaees 121 Using Variables e ce e cece resale cwatie teo ea os tea doo lie o OS adas de 121 AA SO A RN 122 Variable Indexing s ae a n a EEES nE AEE E E EE A eas 123 Usm Scopes E Ea Na ET e E EO ss denies A ER dane EE Soden n aa 123 Predefined SCODES testi lili EE e 123 WISER SCOPES ia a AA A AA ad 125 Variables In Build
129. ches RECIPEVERSION 1 0 RECIPEVERSION tells Aap what version of Aap this recipe was written for If in the future the recipe format changes this line causes Aap to interpret it as Aap version 1 0 would do 4 PORTNAME vim Setting PORTNAME to the name of the port is what actually triggers Aap to read this recipe as a port recipe It makes the other settings to be used to set up a whole range of targets and build commands The result is that you can do aap install to install the application for example Note that PORTNAME does not include the version number 5 LASTPATCH 003 6 PORTVERSION 6 1 S LASTPATCH 7 MAINTAINER Bram vim org 8 S CATEGORIES editors 10 PORTCOMMENT Vim Vi IMproved the text editor eal EORIDESCR LS EOE 12 This is the description for the Vim package 13 A very nice editor backwards compatible to Vi 14 You can find all info on http www vim org 1S EOF In lines 5 to 15 a number of informative items about the port are specified These are used in various places LASTPATCH is not a standard item it is used here to only have to define the patchlevel in one place 17 recipe fetch http www a a p org ports vim main aap The recipe command specifies where to obtain the recipe itself from We have seen this before nothing special here Chapter 11 A Ported Application 33 A A P Recipe Executive I WRKSRC vim61l 2
130. cipe Executive The intention is that recipes are always encoded in UTF 8 Currently this is not fully supported yet US ASCII works in any case Table 33 1 Notation l separates alternatives O grouping a sequence of items or alternatives optional items also does grouping we mn contains literal text 1s one double quote indicates the preceding item or group can be repeated EOL an end of line optionally preceded by a comment INDENT an amount of white space at least one space INDENT2 an amount of white space at least one space more than INDENT A comment starts with and continues until the end of line It continues in the next line if the last character in the line is a backslash A comment may appear where white space may appear but not inside quotes comment continued comment another comment White space may be inserted in between items It is often ignored but does have a meaning in a few places Line continuation may be done with a backslash immediately before an end of line It is not needed for items that use extra indent to indicate that it continues on the next line The backslash can be also used for line continuation in Python commands A leading char and white space before it is removed Example python command continued python command still continued When lines are joined because a command continues in a line with more indent the line break and leading white space of the nex
131. citly mentioned and do have a commit attribute options 1 local don t do current directory recursively r recursive do handle arguments recursively When no directory argument is given the current directory is used It is inspected recursively unless the local option was given When directory arguments are given each directory is inspected Recursively when the recursive option was given When no commit attribute is specified here it will be obtained from any node reviseall fattr val Version control command also see Chapter 18 Version Control Just like using both checkinall and removeal1 on the current directory recursively route option typelist typelist attr value action filename action Specify the actions to be used to build sources with a filetype in the first typelist into targets with a filetype in the last typelist One or more steps can be defined resulting in intermediate results Each typelist is usually a single filetype name but the first and the last can also be a comma separated list of filetype names The route is defined for each combination of the mentioned filetypes The last typelist may have attributes These are passed to the final target A useful attribute is buildaction which tells the build action which special action has to be used for this item There must be an action line for each step The number of steps is the number of typelist mi
132. command program_command recipe_command route_command rule_command totype_command variant_command assignment block_assignment python_item generic_command variable_name item_list variable_name lt lt lt lt lt lt marker EOL item_list EOL INDENT marker python_line python_block python_command python EOL INDENT python_command EOL mon command_name command_argument An item_list can contain white separated items and Python style expressions item_list item simple_item attribute expression string_expr python_expr non_white_item variable_reference item white_space item simple_item attribute expression non_white_item attribute_name item_list string_expr python_expr inn mn mo min text text wait python expression non white text variable_reference expand_type variable_ext_name variable_ext_name variable_ext_name Chapter 33 Recipe Syntax 120 A A P Recipe Executive expand_type A Veet ai ced sc eet VA ed E IES variable_ext_name scope_name variable_name index variable__name ascii letter ascii letter ascii number _ attribute_name scope_name _no _stack _tree 1 _up _recipe _to
133. configure signfile mysign configure in Ems amo joicereeeim getn Maule o come e Soria Came iaa AWIEOCOMIE USING SKUSE COMEUCG WMS SERE s felse sys autoconf Filter the configure script created by autoconf to generate config aap instead of Makefile This means we can use the unmodified configure in distributed with ctags configure_aap configure cat configure eval re sub Makefile config aap stdin gt configure_aap chmod 755 configure_aap Dependency to create config aap by running the configure script The config arg file is used for configure arguments attr config virtual comment Do configuration only config SBDIR config h BDIR config aap configure_aap config arg config h in config aap in geye q COMInNC IES aap ten leal Meme Arg Move the results into BDIR This also means the cache isn t used the next time it is unreliable move force config h config aap config log config cache config status BDIR Create an empty config arg when it s missing OMA E eG 8 touch exist config arg A Complete Example 90 A A P Recipe Executive Update config aap before including it Forcefully when the reconfig target is used Qif reconfig in var2list _no TARGETARG del force config cache config status update force SBDIR config aap else update SBDIR config aap include SBDIR config aap Chapter 25 Automatic Package Install Aap provides a very p
134. ction attribute are taken along Aap assumes they can be linked together with the object files that specify the buildaction attribute If this does not do what you intend you can specify another build action to use with BUILD_ACTION Similarly BUILDDLL_ACTION and BUILDLIB_ACTION are used for building libraries Look in the distributed default aap for the details Searching For Tools 112 A A P Recipe Executive Actions Rules and Routes Actions are used to specify how files are to be compiled and build into a program or library Rules are used to specify which actions to use for files matching a pattern Routes are used to specify which actions to use to turn one filetype into another Thus these three items are closely related The most obvious thing for a language module is to define an action for compiling the language Here is an excerpt from the d module action compile object libobject dllobject default d if not _no get target target src2obj fname Use the d_build action for building and also for dll and lib attr buildaction d_build target if _no get D_COMPILE_ACTION do D_COMPILE_ACTION target target source else sys DMD DFLAGS ofStarget c source This action is specified for all kind of object files including dllobject and libobject If compiling for a library has to be done differently you should specify a separate action for libobject and or dllobject The action starts
135. ctory of the target This means it will be found even when using several recipes that produce the same target But for targets that get installed in system directories use an absolute path virtual targets and remote targets this is avoided For these targets the AAPDIR sign file is stored in the directory of the recipe that specifies how to build the target To overrule the directory where the sign file is written use the attribute signdirectory name for the target To overrule the file where the signatures are written use the attribute signfile name for the target name cannot end in sign Handling Circular Dependencies Two attributes can be used to handle circular dependencies update Can be set to no to avoid updating a source that a target depends on recursive Can be set to a number which indicates the maximum recursive depth allowed The use can best be illustrated with an example sattr recursive 3 index file out index file out update no Get the current checksum for the index file sum get_md5 index Handling Circular Dependencies 139 A A P Recipe Executive Generate the new index file from the output file system wc file out gt target Update the output file if the index file changed Qif sum get_md5 index update file out file out file in index update no Make sure index exists Qif not os path exists index print empty gt index Gene
136. d You can explicitly specify the images but if you miss one your locally tested web site won t work properly on the server A good solution is to parse the HTML files and figure out what images are used in them However only image files that can be found locally should be included not ones that are on other web sites The get html images function can be used for this as shown in an example Files index html contact html forward html Files get_html_images Files attr publish scp user ftp foo org public_html file SFiles alls pulollilsia Note that this still isn t perfect Only images in plain IMG tags will be found and only when they use a relative path name Thus images from Javascript or PHP code will not be included Chapter 16 Fetching Fetching And Updating A convention about using the update and fetch targets makes it easy for users to know how to use a recipe The main recipe for a project should be able to be used in three ways 1 Without specifying a target This should build the program in the usual way Files with a fetch attribute are obtained when they are missing 2 With the fetch target This should obtain the latest version of all the files for the program without building the program 3 With the update target This should fetch all the files for the program and then build it It s like the previous two ways combined Here is an example of a recipe that works this way Pu
137. d scheme Table 35 1 Naming scheme for variables STANDARD_VARIABLE global variable defined by Aap YourVariable global variable used in your recipe s local_variable local variable used in build commands The following table lists the predefined variables These types are used Aap set by Aap and mostly not changed by the user conf set depending on the configuration of the system may be modified by the user user set by the user auto value updated when using commands e g program may also be appended to by the user Chapter 35 Common Variables 127 Table 35 2 Standard Variables name AAP AAPSYSDIR AAPVERSION AR ARFLAGS BDIR BR BROWSER BUILD_ACTION BUILDDLL_ACTION BUILDLIB_ACTION BUNZIP2 C_COMPILE_ACTION CXX_COMPILE_ACTION CACHEPATH type Aap Aap Aap conf Aap conf user conf Aap conf conf conf conf conf conf conf conf Chapter 35 Common Variables A A P Recipe Executive description A single OBSOLETE use A single OBSOLETE use Command that was used to start Aap including the Python interpreter used Example asroot SAAP install Note that this can be a command and an argument e g fusr local bin python1 5 usr local share aap Main py List of system directories to search for startup recipes modules and tools Default value is usr local share aap although this may be different on some systems When the direct
138. ded to the list of files that the target depends on 3 Each file that the target depends on is updated In this case hello c and hello h No dependency has been specified for them and the files exist thus nothing happens 4 Aap computes signatures for hello c and hello h It also computes a signature for the build commands If one of them changed since the last time the target was built or the target was never built before the target is considered outdated and the build commands are executed 5 The second dependency is now finished BDIR hello OBJSUF is up to date Aap goes back to the first dependency 6 Aap computes a signature for BDIR helloS OBJSUF Note that this happens after the second dependency was handled it may have changed the file It also computes a signature for the build command If one of them changed since the last time the target was built or the target was never built before the target is considered outdated and the build commands are executed Now try this Append a comment to one of the lines in the hello c file This means the file is changed thus when invoking Aap it will compile hello c But the program is not built because the produced intermediate file BDIR helloS OBJSUF is still equal to what it was the last time When compiling a large program with many dependencies this mechanism avoids that adding a comment may cause a snowball effect Note some compilers include line numbers or a t
139. depends on foo and bar Thus when Aap updates the all target this dependency specifies that foo and bar need to be updated Since the all target is the default target this dependency causes both foo and bar to be updated when Aap is started without an argument You can use aap foo to build foo only The dependencies for all and bar will not be used then The two files help c and util c are used by both the foo and the bar program To avoid having to type the file names twice the Common variable is used Kinds of things you can build Not everything you want to build is a program Your recipe might need too build a library or a libtool archive In these cases _ lib dll or_ Itlib provide the same level of automation as_ program does for programs The produce command is more generic you can use this to build various kinds of things If all else fails you can use Aap like the make program and explicitly list the commands you need to build your project Chapter 3 Publishing a Web Site If you are maintaining a web site it is often a good idea to edit the files on your local system After trying out the changes you then need to upload the changed files to the web server A A P can be used to identify the files that changed and upload these files only This is called publishing Uploading The Files Here is an example of a recipe Files index html project html links html images logo png attr publish
140. ds Also appends to _conf LIBS Defines HAVE_libname if library libname is available Options see conf header Example conil RECO ECON YO pen conf write header filenam Write the HAVE_ and other symbols collected so far into filename Example conf write header SBDIR config h conf write recipe filenam Write the settings in the _conf scope into filename Example conf write recipe SBDIR config aap The _conf scope stores variables set by configure tests For example _conf LIBS the libraries that conf lib found The _conf scope is used in the tree of scopes just before the toplevel scope after all callstack and recipe tr scopes Special characters in header function and type names are changed to an underscore before defining the HAVE_ symbol Lowercase characters are changed LO Uppercase The preprocessor symbols that are gathered from the tests are available in the _conf have dictionary Example conf header sys time h Est _ Crone i have UE SS IM 1500 e print we have time else print sorry no time conf write recipe writes the variables in the _conf scope You can remove variables you do not want to be written Example saveLIBS _conf LIBS CO Mia MBS TC OM Lilo Eo ERO Ol cus _conf FOOLIB _conf LIBS _conf LIBS saveLIBS Port Description 87 A A P Recipe Executive Chapter 24 Using Autoconf The autoconf system is of
141. ds 177 A A P Recipe Executive Note on MS Windows it s not possible to detect if a command worked the first item in the path will always be used WARNING Using_ syspath probably makes your recipe non portable tag attr val fname Version control command also see_Chapter 18 Version Control Adds a tag to the current version of the files in the repository Uses the tag attribute tagall attr val Version control command also see_Chapter 18 Version Control Adds a tag to all items with a commit and tag attribute The tag should be simple name without special characters no dot or dash tee redir fname Write stdin to each file in the argument list and also write it to stdout This works like a T shaped connection in a water pipe Example zcater iler Errez Sic Torrile assem too toolsearch toolname Specify a list of tools The Python code for each tool is imported and its exist function invoked The first tool that exists becomes the default tool for the language s it supports See Chapter 30 Customizing Default Tools for more info For Unix systems three directories are used aap tools usr local share aap tools The tools directory of the Aap installation For other systems these directories are used SHOME aap tools SHOMEDRIVE SHOMEPATH aap tools c aap tools The tools directory of the Aap installation HOME HOMEDRIV
142. e don t give an error when the file doesn t exist clearrules Delete all rules Also see_ delrule commit attr val fname Version control command also see Chapter 18 Version Control Update the repository for each file that was changed This is also done for a file that didn t change it s up to the version control software to check for an unchanged file 1t might have been changed in the repository Do checkout checkin when checkout is required Don t change locking of the file Uses a logentry attribute when a log entry is to be done When there is no logentry attribute the LOGENTRY variable is used If neither is given you are prompted to enter a message Adds new files when needed Creates directories when needed CVS only one level commitall attr val Version control command also see_Chapter 18 Version Control Apply the commit command to all files in the recipe and child recipes that have the commit attribute conf checkname arg Configuration command See_Chapter 23 Automatic Configuration copy option from to Alphabetical list of Commands 161 A A P Recipe Executive Copy files or directory trees from and to may be URLs This means copy can be used to upload and download a file or even copy a file from one remote location to another Examples cony file Org e Fils clu COpy r onedir twodir COPIA OAc kup Ss scopy http vim sf net download ph
143. e Executive influence this choice Note that it is not possible to have two different buildaction attributes on the sources of the build action If you want to handle this set the BUILD_ACTION variable to the build action that can handle this If a tool needs to do building for C and C files differently set the C_BUILD_ACTION and or CXX_BUILD_ACTION variables to the action that will do the building Adding A New Tool You need to write a Python module and place it in the tools directory Copy one of the existing tool files to start with Then make changes to the functions exists Return True if the tool can be located This is mostly done by simply checking for an executable program with the program pathQ function But you might do something more complicated such as running the program with a version argument and check the output define_actions Define the actions that this tool can accomplish Each action name should be formed from the basic action name with _toolname appended Thus a compile action for the MSVC compiler uses the action name compile_msvc You can define this action for several file types The action usually supports using variables so that the user can modify them in a recipe Some variables are generic and can be used by all tools such as CFLAGS Your tool may need to translate it from the generic form to the tool specific argument For example if DEFINE contains DFOO f00 you might hav
144. e line continuation with a backslash just before the line break can also be used by the way Other things to do with hello world 5 A A P Recipe Executive Indents are very important just like in a Python script Make sure your tabstop is always set to the standard value of eight otherwise you might run into trouble when mixing tabs and spaces When you give a list of files to program Aap will determine dependencies and compile each of the source files in turn and then link them all together into an executable Variables and Assignments Sometimes it is convenient to have an abbreviation for a long list of files Aap supports this through variables just like the make command and the shell An assignment has the form variablename expression The variable name is the usual combination of letters digits and underscore It must start with a letter Upper and lower case letters can be used and case matters To see this in action write this recipe in a file with the name try aap foo one POO er ae FOO three Print SOC SHOO STOO Aap normally reads the recipe from main aap but you can tell it to read a different file if you want to Use the flag for this Now execute the recipe aap f try aap one two three Aap No target on the command line and no build rules or all target in a recipe The_ print command prints its argument You can see that a variable name preceded with a dollar is replaced by the value
145. e this Files index html download html news html images logo gif attr publish rsync myname myproject sf net home groups m my myproject htdocs file SFiles Start this recipe with the publish target If you don t have the rsync command you might want to use scp instead The effect is the same but rsync works more efficient For sourceforge set environment variable CVS_RSH to ssh Otherwise you won t be able to login Do Using Sourceforge 71 A A P Recipe Executive touch cvspass to be able to use cvs login Upload your ssh keys to your account to avoid having to type your password each time Chapter 20 Issue Tracking Bug Reporting A recipe used to install an application should offer the report target This is the standard way for a user to report a problem The recipe should then help the user with reporting a problem as much as possible An example is to send the developer an e mail Commands in the recipe are used to put useful information in the message so that the user only has to fill in his specific problem Example SORT tmpfile tempfname syseval foobar version assign Version print gt Stmpfile Using foobar version Version print gt gt Stmpfile system type os name if os name posix print gt gt Stmpfile system details os uname print gt gt tmpfile sprint gt gt Stmpfile State your problem here do email subject problem in FOOBAR
146. e to translate this to D FOO f00 You can also support specific variables for your tool For example MSVC is used to specify the name of the compiler You give it a default value in the toplevel scope but only when the user didn t do that already The toplevel scope can be obtained from the Global module Global globals use_actions scope This function is called when the actions of the tool will be used as the default actions in scope When the tool is the first one found it will be called from the startup code But the user may also use this to select a specific tool to be used in one recipe or even one dependency Using A Specific Tool The_usetool command can be used to specify a specific tool to be used in the current scope When used in the toplevel recipe the tool becomes the default tool When used in a child recipe the tool will be used in that recipe or by all actions invoked there It can also be used in build commands the tool will be used by invoked actions and dependencies Example usetool mingw update prog_A usetool msvc update prog_B Adding A New Tool 108 A A P Recipe Executive This actually works by defining the tool specific actions and defining variables such as C_COMPILE_ACTION in the current scope Chapter 31 Adding A Language Module This chapter explains how to add support for a language to Aap Both for your own setup and for a module that is to be included in an Aap release Althou
147. e value is a number and a name Possible values for the name day number specifies days hour number specifies hours min number specifies minutes sec number specifies seconds The default is 12 hour When a file becomes outdated its timestamp is obtained When it differs from when the file was last downloaded the file is downloaded again When the file changes but doesn t get a new timestamp this will not be noticed When fetching files the cached files are not used but may be updated Chapter 17 Installing This section contains details about the installation of the produced programs and other items Those other items can be libraries produced by the Lib d11 or 1t1ib commands header files for the API of a library documentation like manpages or info files and as a catch all data Caching 60 A A P Recipe Executive Usually installing is done with aap install If you do not define an install target in the recipe Aap will add one for you The default install target invokes up to 15 other install targets one for each kind of item you can install This makes it easy to customize the installation of some particular kind of item e g libtool archives The default install target invokes two or three other targets install platform install shared and optionally only if you define it in the recipe install local Each of these invokes other install targets for specific kinds of files as follows
148. ecking In When you have made changes to your local project files and want to upload them all into the CVS repository you can use this command reviseall You must make sure that _ALL_ files in the current directory and below that you want to appear in CVS have the commit attribute and no others Files that were previously not in CVS will be added cvs add file and that exist in CVS but don t have a commit attribute are removed cvs remove file Then all files are committed cvs commit file For CVS you need to mark binary files specifically otherwise checking out may result in a wrong file esp on MS Windows In Aap this is done by adding the binary attribute to binary files Example Files main c version c logo png binary To be able to commit changes you made into the CVS repository you need to specify the server name and your user name on that server Since the user name is different for everybody you must specify it in a recipe in your aap startup directory For example CVSUSER_AAP foobar The name of the variable starts with CVSUSER and is followed by the name of the project That is because you might have a different user name for each project Checking In 69 A A P Recipe Executive The method to access the server also needs to be specified For example on SourceForge the ext method is used which sends passwords over an SSH connection for security The name used for the server then becomes
149. ect fname 1 To influence the messages given add an extra dict argument The MESSAGE item will be used see its explanation in the main documenation For more info about the Filetype module see the comments at the start of Filetype py Format Of Filetype Detection Rules Blank lines and lines starting with preceded by any amount of white space are ignored These filetype detection lines are supported suffix suffix type Detection 144 A A P Recipe Executive Add detection of a filetype with a file name suffix When a file name ends in suffix it gets filetype type suffix is taken literally it is not a regular expression When type is ignore filetype detection is done on the file name with this suffix is removed For example suffix gz ignore causes foo c gz to be handled like foo c When type is remove a previously defined filetype detection for suffix is removed This can be used to remove a suffix rule and add another kind of detection instead regexp regexp type append tail Add detection of a filetype with a Python regular expression When regexp matches with the name of a file it gets filetype type When tail is given matching is done with the tail of the filename without the path When type is remove a previously defined filetype detection for regexp is removed When append isn t given the new detection is put before existing regexp detections thus overruling the
150. ectories and arguments in a variable 3 object file suffixes If the language uses different suffixes for object files for static or dynamic libraries this can be specified See_below 4 search for tools Usually there are different ways to invoke the compiler on different platforms And on one platforms various tools may be installed The_ toolsearch command is used to locate the tools See_ below 5 actions rules and routes The generic methods for compiling and building See_below Example This example is for the D language This module is included with Aap 1 Filetype recognition filetype SPNCIEI Cl Cl 2 Default values DMD dmd 3 Object file suffixes dll and lib objects are equal to normal objects _top D_LIBOBJSUF OBJSUF _top D_DLLOBJSUF OBJSUF 4 Search for tools Actions are installed for every toolchain that exists The first one found sets D_COMPILE_ ACTION and friends toolsearch dmd 5 Actions Rules and Routes do compile action compile object libobject dllobject default d if not _no get target target src2obj fname Use the d_build action for building and also for dll and lib attr buildaction d_build target Parts Of A Module 110 A A P Recipe Executive if _no get D_COMPILE_ACTION do D_COMPILE_ACTION target target source else sys DMD DFLAGS ofStarget c source rule global default SSOBJSUF buildc
151. ectory or specified directories May enter directories recursively Inspect directories and remove items that do exist in the VCS but are not mentioned or do not removeall have a commit attribute Careful Only use this command when it is certain that all files that should be in the VCS are explicitly mentioned and do have a commit attribute reviseall Just like using both checkinall and removeall tagall Add a tag to all items with a commit and tag attribute Related to these commands are targets that are handled automatically when not defined explicitly When defining a target for these it would be highly unexpected if it works differently Normally uses the files you currently have to update the version control system This can be aap commit eae E P TE used after you are done making a change Default is using commitall aap Update all files from the VCS that have a commit attribute When the VCS supports locking checkout all files will be locked Without locking this does the same as aap fetch aap Do_ checkin for all files that have been checked out of the VCS For a VCS that doesn t do file checkin locking this is the same as aap commit aap unlock Unlock all files that are locked in the VCS Doesn t change any files in the VCS or locally Do_ add for all files that appear in the recipe with a commit attribute that do not appear in the VCS Do_ removeall remove all files that appear in the VCS but do not exist
152. ed A change in CC or the sys command does not cause generating the target action depend buildcheck CFLAGS c sys CC CFLAGS MM source gt Starget Aap expects the dependency checker to only inspect the source file If it recursively inspects the files the source files include this must be indicated with a recursive attribute That avoids Aap will take care of this and do much more work than is required Example action depend recursive c cpp sys CC SCFLAGS MM source gt target Missing Include Files It is possible that an include file is not typed in by the user but is generated with commands This file may then need to be generated to be able to figure out the dependencies This can be complicated because the generated include file may again include other files Thus the dependency check needs to be repeated after the file has been generated To make it easier to handle this situation Aap provides the ssysdepend command It will take care of executing a shell command to figure out the dependencies catching the output to check for error messages build targets that can t be found and repeat until it is done Custom Dependency Checking 106 A A P Recipe Executive Here is an example for the imaginary f language action depend recursive f sysdepend filepat File Not found SFCC SFFLAGS depend Ssource gt target The filepat option of sysdepend specifies how the file na
153. ed Example using the recipe above aap c print BDIR executed during the first step build FreeBSD4_5_ RELEASE Common Recipe Structure A recipe used for building an application often has these parts global settings include recipes with project and or user settings automatic configuration specify variants e g debug release build rules and actions explicit dependencies high level build commands _ program _ dll etc You are free to use this structure or something else of course This is an explanation that you can use as a base Many times you will be able to use this structure as a starting point and make small modifications where it is needed Now let us look into each part in more detail 1 global settings include recipes with project and or user settings When the recipe is part of a project it s often useful to move settings and rules that apply to the whole project to one file Then use the include command in every recipe that can be used to build something User preferences e g configuration choices should be in a separate file that the user edits using a template 2 automatic configuration Find out properties of the system and handle user preferences This may result in building the application in a different way See Chapter 24 Using Autoconf 3 specify variants Usually debug and release but can include many more choices type of GUI small or big builds etc This ch
154. ed if the target exists With Aap the build commands will be executed in more situations e when the build commands were never executed e when the build commands have changed For example this dependency is often used in a Makefile to create a symbolic link when it doesn t exist yet gvim in s vim gvim The Aap recipe for this would be gvim symlink vim gvim When running Aap with this recipe for the first time and the gvim link already exists you will get an error message To avoid this problem set the buildcheck attribute to an empty string gvim buildcheck symlink vim gvim Note if the symbolic link exists but the file that it points to doesn t exist you still get an error That s probably what you want Use Of Environment Variables The make program uses all environment variables for variables in the Makefile This can cause unexpected results because you may have a large number of environment variables and some of them you didn t set yourself thus don t even know about them Aap does not use environment variables for recipe variables A few environment variables are explicitly used For example PATH is used to locate programs To access an environment variable Python code must be used The os environ dictionary stores them Example Home os environ get HOME gt Note that some systems are case sensitive e g Unix some systems are not e g MS Windows Signatures Instead Of Timestam
155. eful if you know how to do this or when you don t think the automatic mechanism will work After the package has been installed you can enter 2 and Aap continues executing the recipe The last choice is a which means you give up and abort executing the recipe In situations where the package name differs from the command name or there are more complicated requirements you can write a check yourself When a package needs to be installed the_ installpkg command can be used to have Aap install the package To install a package automatically Aap will download a recipe and execute it To be able to execute the recipe in a proper environment a directory is created On Unix this will be aap packages package name The Chapter 25 Automatic Package Install 91 A A P Recipe Executive boot aap recipe is downloaded from the A A P web site This uses a simple PHP script that selects the recipe to use Example http www a a p org package php package scp amp osname posix The downloaded recipe contains further instructions for building and or installing the package This can be anything thus it is very flexible Usually the recipe finds out what kind of system you are using and selects another recipe to be used for it Or it uses the standard package mechanism of your system If you are running a BSD system you probably have the BSD ports system installed if not you should install it This is a very well maintained system that
156. eie sum local o V wa segue When reading a variable with the _no scope it is first looked up in the local scope If it does not exist the _stack and _tree scopes are used as explained above When writing a variable without a specified scope it is always put in the local scope A specific situation where this may lead to an unexpected result is appending foo something This is equivalent to foo foo something This obtains the value of foo from the first scope where it is defined but it is set in the current scope To change the variable where it is defined use the _no scope explicitly _no foo something User Scopes The user can define a new scope by assigning a value to a variable using the scope name s_debug foo xxx This creates the scope s_debug if it didn t exist yet The variable foo within that scope is assigned the value xxx The scope name must start with an alphabetic character Following characters may be letters digits and the underscore A user defined scope is only used when explicitly specified The _no and _up scopes do not use it User Scopes 125 A A P Recipe Executive The scope can be accessed from everywhere except recipes that create a new toplevel scope have their own set of user defined scopes That is when using execute or child nopass execute pass and_ child do share the user scopes There cannot be a scope name and a variable with the same name This a
157. en files is transported This is slower for transferring a whole file but a lot faster if a file has few changes Requires the rsync program installed Aap will attempt installing it for you when needed Uses rsync rsh ssh by default Set the RSYNCCMD variable to use another command URLs 183 Appendixes Table of Contents A License Appendix A License LICENSE FOR A A P PROJECT FILES The files of the A A P project that refer to this file can be copied modified distributed and used as described in the license below If this license does not meet your needs contact the copyright holder s to negotiate an alternate license Contact information for stichting NLnet Labs can be found at http www nInetlabs nl Further information about the A A P project can be found at http www a a p org GNU GENERAL PUBLIC LICENSE Version 2 June 1991 Copyright C 1989 1991 Free Software Foundation Inc 59 Temple Place Suite 330 Boston MA 02111 1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document but changing it is not allowed Preamble The licenses for most software are designed to take away your freedom to share and change it By contrast the GNU General Public License is intended to guarantee your freedom to share and change free software to make sure the software is free for all its users This General Public License applies to most of the Free Soft
158. ent will show them aap comment target all build everything target foo link the program Sticky Attributes When attributes are used in a rule or dependency most of them are only used for that dependency But some attributes are sticky Once used for an item they are used everywhere for that item Sticky attributes are Table 37 2 Sticky attributes virtual virtual target not a file remember virtual target that is remembered directory item is a directory filetype type of file constant file contents never changes fetch list of locations where to fetch from first one that works is used commit list of locations for VCS publish list of locations to publish to they are all used force rebuild a target always depdir directory to put an automatically generated dependency file in when omitted BDIR is used var_BDIR directory to put the related object or generated file in when omitted BDIR is used signfile file used to store signatures for this target The check attribute The check attribute is used to specify what kind of signature is used for an item The default check for a file that was changed is an md5 checksum Each time a recipe is executed the checksums for the relevant items are computed and stored in the file AAPDIR sign The next time the recipe is executed the current and the old checksums are compared When they are different the build commands are Sticky Attributes 138 A A P Recipe Executive
159. es This uses the commit attribute What happens is specific for the VCS Common arguments for Commands redir Redirect the output of a command Can be one of these items Common arguments for Commands 181 A A P Recipe Executive gt fname write output to file fname fails when fname already exists gt fname write output to file fname overwrite an existing file gt gt fname append output to file fname create the file if it does not exist yet command pipe output to the following command The redirection can appear anywhere in the argument except inside quotes The normal place is either as the first or the last argument The pipe to the next command must appear at the end The file name can be a URL The text will first be written to a local file and then the file is moved to the final destination The white space before the file name may be omitted White space before the gt and I is required To avoid recognizing the gt and I for redirection and pipes use gt and pipe When a command produces text on stdout and no redirection or pipe is used the stdout is printed to the terminal URLs In various places URLs can be used to specify remote locations and the method how to access it http machine path HTTP protocol commonly used for web sites read only machine can also be machine port ftp machine path FTP protocol machine can also be machine port When port is omitted the de
160. es a fetch target one will be generated automatically This will go through all the nodes used in the recipe and fetch the ones that have an fetch attribute The recipe itself may also be fetched from the CVS repository sreclps feton ayvss To update a whole directory omit the fetch attribute from individual files and use it on the directory Example Chapter 19 Using CVS 68 A A P Recipe Executive source main c version c semis ESTEN Cys AT program myprog source Alternatively a specific fetch target may be specified The automatic updates are not used then You can specify the fetch attribute right there fetch fetch fetch cvs Ssource If you decided to checkout only part of a module and want to be able to get the rest later you need to tell where in the module of the file can be found This is done by adding a path attribute to the cvs item in the fetch attribute Example fetch fetch fetch SCVSROOT path mymodule foo foo aap What will happen is that aap will checkout mymodule foo foo aap while standing in two directories upwards That s required for CVS to checkout the file correctly Note this only works as expected if the recipe is located in the directory mymodule foo If the path attribute is omitted A A P will obtain the information from the CVS Repository file This only works when something in the same directory was already checked out from CVS Ch
161. es it easier to understand the recipe anyway Compile only when needed This continues the last example of the tutorial Chapter 14 Variants 51 A A P Recipe Executive We happen to know that the main c file does not depend on the GUI used With the recipe above it will nevertheless be compiled again for every GUI version Although this is a small thing in this example in a bigger project it becomes more important to skip compilation when it is not needed Here is the modified recipe 1 Source main c version c gui c 2 5 Byeleieuene BULLE 4 release 5 OPTIMIZE 4 6 Target myprog T debug 8 DEBUG yes 9 Target myprogd 10 La sattr var_DEFINE SDEFINE var_BDIR BDIR main c 12 13 Gui motif 14 Variant Gui L5 console 16 motif 17 Source motif c 18 gtk 19 Sitios ae GEK e 20 Zl DEFINE DGUI Gui 22 29 program STarget Source The only new line is line 11 The main c file is given two extra attributes var_DEF INE and var_BDIR What happens is that when main c is being build Aap will check for attributes of this source file that start with var_ The values will be used to set variables with the following name to the value of the attribute Thus DEFINE gets the value of var_DEF INE This means that the variable is overruled by the attribute while building main c The var_
162. fault port 21 is used For authentication the netrc file is used if possible unfortunately the Python netrc module has a bug that prevents it from understanding many netrc files Alternatively login name and password can be specified just before the machine name ftp user machine path ftp user password machine path When password is omitted you will be prompted for entering the password Either way ftp sends passwords literally over the net thus THIS IS NOT SECURE Should use scp instead scp machine path SCP protocol using SSH secure shell Requires the scp program installed Aap will attempt installing it for you when needed Additionally a user name can be specified scp userEmachine path path is a relative path to the directory where ssh logs in to To use an absolute path prepend a slash scp machine path URLs 182 A A P Recipe Executive The resulting path for the scp command uses a instead of the first slash Uses scp C by default Set the SCPCMD variable to use another command rcp machine path RCP protocol using rcp remote copy Very much like using scp but WITHOUT SECURITY Requires the rcp program installed Aap will attempt installing it for you when needed Uses rep by default Set the RCPCMD variable to use another command rsync machine path RSYNC protocol using rsync remote sync Like using scp but only the difference betwe
163. file from pieces iecerei eet Ey a eh IO ee ee Tae 30 Pipe outputin a Vartable tua a td a dea Read A qa 31 Creating a file from Scratch nariki a riii E e EEE Aaa Adan IA Adel hidra 31 Chapter 11 A Ported Application ecccecccesccessseesseecseecessneecsscceeseceeaaecsenecseneeceseeesaeceeaaeceeaesneneeesuees 32 The Port RECIPES Ble tetas de seen aot ET ETET 32 PAS RS 35 User Manual AA TN 36 Chapter 12 Howit all WorkSuintocio cited cion Sa hee neds id 36 How Recipes Are Executed neos e a e a a aa E a E a i eie 36 Common Recipe Structures siie i aE E a a a a AAA a ea ta 37 Building A Target In The First Stepio eeii e E SE A E EE AEE ENT aTa 38 Nesting The St ps conire A 38 Using Multiple Recipes iii aladdin 39 RecipesEXecution Details penenr nienean a a i a o lao tendat dpi airis 39 Use Ob VWartables A A AA N E EE ENE 40 Special Characters sisien GH a Aas ee a BL eee ee Re 40 Gne Synta RR rank at madece betiee ven ets 41 Chapter 13 Dependencies Rules and Actions cccccecssccenceceseeeseceesaeceeaceeeeeeceaeeeaeeseaaeceeaeceeaeesaees 42 Buiild Commiand ps oyvotesseuvtedervotederseanan 42 The Production Command e ie Te So coeseoceescvovnbaveevetsuvvs vovievn ve vaievecdetevend abate 43 Attributes for the Production Commands ccccccccccccccccccccccscccccscscsesceescsesessesesesesesesseeeeeeeeseseeseeeeeeeeees 44 MESA A TOS 45 Command blOCK SECHOMS iii AA hv dada Shu dads dda vega AE age he ake 46 Multipletargets a
164. forget you can use execute to do just about anything Chapter 13 Dependencies Rules and Actions 42 A A P Recipe Executive The Production Commands The commands program lib dll and _ Itlib are called production commands because they explicitly state what things Aap should produce and what sources are involved Everything the production commands can do can be done by hand with dependencies as well but the automation the production commands provide is quite useful This section discusses how the production commands can be used and the variables that affect them The form of each of the production commands is command targets sources It is unusual to have more than one target since both targets would be built from the same sources but it is allowed The list of sources should list the actual original sources i e only files that are actually written by the programmer and that exist on disk It is these sources that will be packaged together for distributing the program or library in source form Each production command transforms all of the sources into objects using compile actions The sources are transformed into object files of a particular type e g libraries use files with type libobject Once all of the sources have been compiled a build action is invoked to turn the object files into the target The table below lists the production commands and the actions used Some of the production commands can use different programs
165. g myprogram program myprogram comment MyProgram is really great main c startup stuff version c Just the date stamp help c display a help message Now run Aap with a comment argument aap comment target myprogram MyProgram is really great target clean delete generated files that are not distributed target cleanmore delete all generated files target cleanALL delete all generated files AAPDIR and build directories target install install files target uninstall delete installed files The text inside curly braces is called an attribute In this case the attribute name is comment and the attribute value is MyProgram is really great An attribute can be used to attach extra information to a file name We will encounter more attributes later on Dependencies Let s go back to the Hello world example and find out what happens when you change a source file Use this hello c file include lt stdio h gt include hello h main printf Hello s n world The included hello h file defines world define world World Comments 7 A A P Recipe Executive If you run Aap the hello program will be built as before If you run Aap again you will notice that nothing happens Aap remembers that hello c was already compiled Now try this touch hello c aap If you have been using the make program you would expect s
166. g Subversion Subversion is a new version control system that is going to replace CVS It has many advantages such as atomic commits But version 1 0 is not ready yet although the current versions appear to be very stable and usable Subversion support is not implemented yet For the time being you can retrieve files from a Subversion repository by using a URL That works because subversion is using an Apache server You can obtain a copy of single files by specifying the URL in the fetch attribute Obviously you can t commit changed files this way Using Another Version Control System To add support for a new version control system define a Python function with the name method_command where method is the word at the start of the commit attribute The function will be called with five arguments recdict a dictionary with references to all variable scopes for expert users only the name of the repository defined with the commit attribute with the scheme part name removed dia de the dictionary holding attributes for the specified repository e g for commit foo arg blah it is in Python syntax name foo arg blah nodelist a list of the nodes on which the action is to be performed action the name of the action to be executed can be fetch commit etc The function should a list of nodes that failed When the action worked without errors an empty list should be returned For an
167. gh the text explains modules for a language this can also be used for adding a module for other purposes It is a generic method to have Aap load a module that defines actions sets variables etc In a recipe a module can be used with the_ import command Thus when your recipe uses Java you would add this line import java For the standard modules see Chapter 39 Standard Modules Module Name It is important to chose a good name for the module because it must be unique on your system For a programming language simply use the name of the language For Java you would use java for the D language d In case there are variants of a language that are different enough to justify using a different module add something to the name to make this clear You can use letters digits and the underscore Examples foo foo2004 foo_latest If you have a specific module with different functionality you could prepend my For example myjava After the module has been imported the variables in 1t can be accessed through the m_name scope where name is the name of the module For example the variable m_d DMD holds the command used for the d language to execute the compiler Note It is not possible to have a variable and a scope with the same name Thus if you have a module called foo which uses the scope m_foo you cannot have a variable m_foo anywhere in a recipe Since the modules are Aap recipes the file names alway
168. h nofetch recipe to obtain the files if needed it obtains the files but not the recipes srcpackage Steps Generate a package with recipe and source files Not implemented yet Puts the main recipe and all downloaded files into an archive The resulting archive can be installed without downloading Depends on the fetch target 85 A A P Recipe Executive Port Description The text to describe the port is usually a page full of plain text Here is an example PORTDEOCR lt Or This is the description of the port A very important application indeed S our website http myport org EOF In the rare situation that EOF actually appears in the text you can use anything else such as THEEND Chapter 23 Automatic Configuration The_ conf command is used to discover properties of the compiler and the system With this information a program can be compiled to work on many different systems without the user to manually specify the properties For Unix systems an alternative is using Autoconf see Chapter 24 Using Autoconf TODO The conf command is still under development SCOM miie Clean the configuration environment Only needed when configure checks were done befor conf language lang Use lang as the language for tests that do not have a language attribute Only WOW amcl Ei aise curra ly surco WOW ais Tlas default A test will be done if the compiler for the language works If not
169. h modules2 Although there is no modules2 directory in the distribution thus the last item in the directory lists above is not used The scope that is used for the module recipe can be accessed from elsewhere under the name of the module with m_ prepended Thus when doing import java the m_java scope is available The recipes from the modules2 directory use this same scope include option name Read recipe name as if it was included in the current recipe Does not change directory and file names in the included recipe are considered to be relative to the current recipe not the included recipe The I or include command line argument can be used to specify directories to look for the recipe The current directory is always searched first When the recipe name is an absolute path or starts with a dot e g foo aap only the current directory is used The fetch attribute can be used to specify a list of locations where the recipe can be fetched from If the recipe is fetched it is stored under the specified name in the current directory options ae Don t give a warning for a file that can t be read Used to optionally include a recipe o Don t include the recipe if it was already read Useful for project settings that are only to once be included once while you have sub projects that can be build independendly installpkg package Install packages Each argument is the name of a package This works like a
170. handling exceptions when the file doesn t exist Detection 142 A A P Recipe Executive When after isn t given the detection is done before the suffix regexp and script detection When after is given it s done last When append isn t given the new detection is put before existing python detections When append is used it is put after the existing python detections The Python code can use the ft_detect function on a modified fname when needed Example python after if ignore and fname 1 type ft_detect fname 1 ignore non This is actually one of the default rules When the file name ends in detection is done on the name with this character removed This finds the type of backup files declare type Declare type to be a recognized filetype This is needed for filetypes that are recognized through Python code only All other filetypes those that appear in suffix regexp and script rules need not be separately declared When you use an unknown filetype in a recipe Aap prints a warning to alert you to the possibility of a misspelling The declare rule is needed because Aap cannot tell what filetype the Python code is capable of detecting so the declare rule is used to tell Aap specifically that the filetype type is a known and recognized type In the above the first argument can be put in quotes to include white space type can only consist of ASCII lowercase letters and digits Chapter 39 S
171. have build commands myprog mysource this Does Not Work Line Syntax 41 A A P Recipe Executive You must use a backslash in this situation myprog mysource this OK Chapter 13 Dependencies Rules and Actions Build Commands There are several methods to specify build commands to update a target 1 A dependency This is more or less the same as how this is used in a Makefile One or more targets a colon and any number of sources This specifies that the target s depends on the source s When build commands are given these are the commands to build the target s from the source s Without build commands the dependency is only used to check if the target is outdated and needs to be build 2 A rule Specified with a rule command A in the target s and source s stands for any string This is used to specify a dependency that is to be used for files that match the pattern 3 An action Specified with a act ion command Unlike dependencies and rules an action does not specify a build dependency It must be invoked by other build commands with the do command Nearly all recipe commands can be used in the build commands But these are not allowed they can only be used at the recipe level a dependency specification rule route totype clearrules delrule program Ho ENE Lib recipe variant In short all commands that define dependencies cannot be used in build commands But don t
172. heck DMD DFLAGS d do compile target target source do build for object files resulting from d source files saction d_build default if _no get D_BUILD_ACTION E do D_BUILD_ACTION target target source else sys DMD S DLINKFLAGS ofStarget source default route route default d object libobject dllobject compile Object File Suffixes Many languages use the same object file suffixes as used for C o on Unix and obj on MS Windows But for some languages a different suffix is used and the suffixes for building a static and shared library are different The simplest example is when a language always uses the same suffix for all kinds of object files For example the d language does not make a difference between normal object files static library objects etc This can be specified like this _top D_DLLOBJSUF SOBJSUF _top D_LIBOBJSUF SOBJSUF Note that the _top scope is used If this would be left out the variables would only be set in the scope of the module and would not be available in the user recipe The name of the variable is made from the filetype in upper case and underscore and the name of the generic variable The_src2objQ function will look for these variables Note that the filetype is used not the module name An extreme example is when all suffixes are different Boo LOOmOL US UE MEE O _top FOO_DLLOBJSUF dfo Scop O OMITE OE US UE O EROPAEOOBTIOB S
173. here are any problems read the documentation available for your CVS server 3 Checkout a copy from CVS and merge Move to a directory where you want to get your project back Create the directory myproject with this example cvs d ext myname cvs sf net cvsroot myproject checkout mymodule You get back the files you imported in step 2 plus a bunch of CVS directories These contain the administration for the cvs program Move each of these directories back to your original project Example mv myproject CVS projectdir CVS mv myproject include CVS projectdir include CVS If you have many directories one complicated command does them all Distributing Your Project With CVS 70 A A P Recipe Executive cd myproject find name CVS exec mv projectdir This is a bit tricky Another method is to copy all the files from your original project into the newly created directory But then you have to be careful not to change relevant file attributes which is tricky as well Obviously the best solution is to have all files you need in CVS so that you don t have to copy any files 4 Commit changes After making changes to your project and testing them it s time to check them in In the recipe you use for building add a commit attribute to all the files that should be in CVS The reviseall command then does the work for you see above Example Files source S header main aap sattr commit cvs ext
174. hes have been replaced with forward slashes rule is introduced in Chapter 3 Publishing a Web Site of the tutorial Also see_ delrule and_ clearrules start command Like_ sys and_ system but don t wait for the commands to finish Errors of the executed command are ignored Runs in the same terminal which will cause problems when the command waits for input Open a new terminal to run that command in Example start xterm e more README WARNING Using start probably makes your recipe non portable symlink option from to Create a symbolic link so that to points to from Think of this as if making a copy of from without actually copying the file Only for Unix and Mac OS X options q or quiet Don t complain when to already exists f or force Overwrite an existing to file or symlink sys option command system option command Execute cmds as system shell commands Example system filter lt foo gt bar sys reboot universe The following lines with more indent are appended replacing the indent with a single space Example sys echo one two This echos one two options i or interactive don t log output see below Alphabetical list of Commands 175 A A P Recipe Executive q or quiet Don t echo the command 1 or log Redirect all output to the log file do not echo it f or force Ignore a non zero exit value interactive and log cann
175. ibute starting with add_ is added to a variable Example do build foo c add_DEFINE DBIG The value of the attribute is not added when it already appears in the variable This avoids adding it two or more times Variable values for the executed action can also be passed by giving an attribute just after the action slo lomabilel OPTIMA 2 50008 And yet another method is to define a user scope and use this for the action s_foo OPTIMIZE do build scope Is Se roo LOOLE Chapter 28 Customizing Filetype Detection and Actions 99 A A P Recipe Executive Executing Actions The user can select how to perform an action for each type of file For example the user may specify that the view action on a file of type html uses Netscape and the edit action on a html file uses Vim To start an application do actionname filename This starts the action actionname for file filename Variables to be used by the commands can be specified after the action as attributes action convert default sys convertcmd arg source gt Starget do convert arg r filenam The filetype is automatically detected from the file name s and possibly its contents To overrule the automatic filetype detection specify the filetype as an attribute on the file do convert filename filetype text This changes the filetype of the source file the input of the action To change the filetype of the o
176. ic keys For MS Windows you can find information here http the earth li sgtatham putty 0 53b htmldoc Chapter8 html This is for the PuTTY version of scp which is what Aap installs for you if you let it For Unix try man ssh keygen Use SSH protocol version 2 if possible You can specify the command to be executed with the SCP variable see the reference manual Example SCP scp i c private keyfile Using Another Method Using rsync has an advantage if you have files with only a few changes The rsync program will only transfer the differences This adds a bit of overhead to find out what changed thus it s a bit slower when copying whole files Aap uses the same secure channel as with scp by default This can be changed with the RSYNC variable see the reference manual If your server does not support scp you might want to use rcp However this is insecure information is transferred unencoded over the internet and making a connection is not secure Only use this when scp is not possible Using rcp means changing the scp part of the URL to rcp The RCP variable holds the name of the command see the reference manual You can also use ftp Some web servers require this even though ftp sends your password as plain text over the internet thus it is insecure Aap uses the Python ftp library thus an external command is not needed and there is no variable to specify the command Changing A Url
177. icitly contain your user name and can also be used by others Once you tested this recipe and it works you can easily distribute your software with aap f cvs aap revise You don t have to worry about the exact CVS commands to be used However don t use this when you want to checkin only some of the changes you made And the example does not work well when others are also changing the same module Further Reading The User manual Chapter 18 Version Control has more information about version control and Chapter 19 Using CVS about using CVS Chapter 8 Filetypes and Actions A A P can recognize what the type of a file is either by looking at the file name or by inspecting the contents of the file The filetype can then be used to decide how to perform an action with the file A New Type of File Suppose you are using the foo programming language and want to use A A P to compile your programs Uploading Checkin 22 A A P Recipe Executive Once this is has been setup you can compile hello foo into the hello program with a simple recipe sprogram hello hello foo You need to explain Aap how to deal with foo files This is done with a recipe filetype SURTI COO TOO action compile foo sys foocomp FOOFLAGS Ssource O Starget route foo object compile For Unix write this recipe as usr local share aap startup foo aap or aap startup foo aap The recipes in these startup directories are always read whe
178. id all automatic dependency checks set the variable AUTODEPEND to off AUTODEPEND off To avoid automatic dependencies for a specific file set the attribute autodepend to off foo o foo c autodepend off Specifying Actions in Python 105 A A P Recipe Executive Custom Dependency Checking You can add your own dependency checks This is done with an_ action command Its arguments are depend and the file types for which the check works A block of commands follows which is expected to inspect source and produce the detected dependencies in target which has the form of a dependency Simplified example action depend c cpp sys CC SCFLAGS MM source gt target The build commands are expected to generate a file that specifies the dependency LODO LED LOO ola The first item before the colon is ignored The items after the colon are used as implied dependencies The source file itself may appear this is ignored Thus these two results have the same meaning a dependency on foo h TOD VZ E TOD COO g OOO FOON Comments starting with are ignored Line continuation with is supported Only the first continued line is read Aap will take care of executing the dependency check when the source changes or when the command changes e g the value of CC and CFLAGS This can be changed with a buildcheck attribute after depend In the following example only a change in CFLAGS is notic
179. iles the targets that depend on the source file also depend on the included files Thus when foo c includes foo h and foo h is changed the build commands to produce foo o from foo c must be executed even though foo c itself didn t change Aap detects these implied dependencies automatically for the types it knows about Currently that is C and C Either by using gcc or a Python function the include statements are found in the source code and turned into a dependency without build commands This works recursively Thus when foo c includes foo h and foo h includes common h the dependency will look like this FOOSE 3 LOO lar COnN la For other types of files than C and C you can add your own dependency checker For example this is how to define a checker for the tt filetype action depend tt sys tt_checker Ssource gt target The tt_checker command reads the file source and writes a dependency line in the file target This is a dependency like it is used in a recipe In a Makefile this has the same syntax thus tools that produce dependencies for make will work Here is an example foo o foo tt foo hh include common hh This is interpreted as a dependency on foo hh and include common hh Note that foo o and foo tt are ignored Tools designed for make produce these but they are irrelevant for Aap Since the build commands for action depend are ordinary build commands you can use
180. imestamp in the object file in that case building the program will happen anyway Compiling Multiple Programs Suppose you have a number of sources files that are used to build two programs You need to specify which files are used for which program Here is an example 1 Common help c util c ae oie all g oo lore an Se program foo Common foo c 6 De program bar s Common bar c This recipe defines three targets all foo and bar foo and bar are programs that Aap can build from source files But the all target is not a file This is called a virtual target A name used for a target that does not exist as a file Let s list the terminology of the items in a dependency Table 2 1 items in a dependency source item on the right hand side of a dependency source file source that is a file virtual source source that is NOT a file target on the left hand side of a dependency target file target that is a file Compiling Multiple Programs 9 A A P Recipe Executive virtual target target that is NOT a file node source or target file node source or target that is a file virtual node source or target that is NOT a file Aap knows the target with the name all is always used as a virtual target There are a few other names which Aap knows are virtual see Table 37 1 For other targets you need to specify it with the virtual attribute The first dependency has no build commands This only specifies that all
181. in and gz are ignored Sometimes the contents of the file is inspected for example on Unix a shell script is recognized by bin sh in the first line To manually set the file type of an item add the filetype attribute This overrules the automatic detection Example foo o foo x filetype cpp Most detection is already built in If this is not sufficient for your work filetype detection instructions can be used to change the way file type detection works These instructions can either be in a file or directly in the recipe filetyp filenam filetype suffix p pascal acicate asias sla The advantage of using a file is that it will also be possible to use it when running the filetype detection as a separate program The advantage of using the instructions directly in the recipe is that you don t have to create another file For the syntax of the file see Chapter 38 Filetype Detection It is sometimes desired to handle a group of files in a different way For example to use a different optimizer setting when compiling C files An easy way to do this is to give these files a different filetype Then define a compile action specifically for this filetype Example star Meli E ONE Er EOS action compile c_opt OPTIMIZE 3 do compile Ssource Chapter 28 Customizing Filetype Detection and Actions 98 A A P Recipe Executive When you define an action or a route Aap checks that the filetypes you use are know
182. in full compliance 5 You are not required to accept this License since you have not signed it However nothing else grants you permission to modify or distribute the Program or its derivative works These actions are prohibited by law if you do not accept this License Therefore by modifying or distributing the Program or any work based on the Program you indicate your acceptance of this License to do so and all its terms and conditions for copying distributing or modifying the Program or works based on it 6 Each time you redistribute the Program or any work based on the Program the recipient automatically receives a license from the original licensor to copy distribute or modify the Program subject to these terms and conditions You may not impose any further restrictions on the recipients exercise of the rights granted herein You are not responsible for enforcing compliance by third parties to this License 7 If as a consequence of a court judgment or allegation of patent infringement or for any other reason not limited to patent issues conditions are imposed on you whether by court order agreement or otherwise that contradict the conditions of this License they do not excuse you from the conditions of this License If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations then as a consequence you may not distribute the Program at all For examp
183. in the recipe with a commit attribute or do not exist in the local directory This works in the current directory and recursively enters all subdirectories Careful files with a search path may be accidentally aap add aap remove removed Do_ tagall tag all files with a commit and tag attribute The tag name should be defined aap tag properly in the recipe although aap tag TAG name can be used if the recipe contains something like attr tag STAG SFILES Same as aap checkin followed by aap remove checkin all changed files unlock all files and remove files that don t have the commit attribute aap revise For the above the 1 or local command line option can be used to restrict the operation to the directory of the recipe and not recurse into subdirectories A variable can be used to set the default change log entries LOGENTRY message This variable is used for new changed and deleted files that don t have a logentry attribute When it s desired to commit one directory at a time the following construct can be used source _ files c laciude tiles adineilucle la commit s eva uote commit source_files removeall commit include virtual Chapter 18 Version Control 66 A A P Recipe Executive commit Sinclude_files removeall include Note that this is not possible when the sources and include files are in one directory removeall only works per directory Usin
184. included in the package 1 Specify the list of files below WRKDIR with a dest attribute where they should end up Assign the list to PACKFILES Example PACKFILES SWRKSRC bin prog dest usr local bin prog SWRKSRC man prog 1 dest usr local man man1 prog 1 2 Specify a command to fake install into PKGDIR and use all files that end up there Set INSTALLCMD to the command to be used Example INSTALLCMD aap install DESTDIR PKGDIR Set INSTALLDIR to the directory inside WRKDIR where the files are put Default is WRKSRC PKGDIR PREFIX is where files end up A packing list is generated with the files that exist in the package Then pkg_create is executed to actually create the package Arguments are given such that PORTDESCR is used as the description of the package and PORTCOMMENT for a short explanation of what the package is for Install the binary package 84 A A P Recipe Executive This executes the pkg_add command in a separate shell You are asked to type the root password This is reasonably safe since the shell is only connected to Aap and it can only install a package Exception This updates the rundepend and installtest targets after updating the post install target This allows doing aap install which is a lot more obvious than aap installtest rundepend Check runtime dependencies Check if all required items specified with DEPEND_RUN are present and tries to install them
185. included recipe were typed instead of the include command There is no change of directory like with the child command and the included recipe uses the same scope In the toplevel recipe you need include common aap as well Suppose you include it in the first line of the recipe before the child commands The children also include common aap The CPPFLAGS variable would first be appended to in the toplevel recipe then passed to the child and appended to again That is not what is supposed to happen To avoid this add the once option to the_ include command This means that the recipe is only included once and not a second time The child recipes use include once common aap And the parent uses include once common aap child core main aap sets Core_obj A losilel Wie sj melsta ado sets Util_obj all theprogSEXESUE EMSA adas ul y Cora Cora oo viral S oeil AS lo low sois oO OY Ole WN Fe You might argue that another way would be to put the include command at the top of the parent recipe so that the children don t have to include common aap You could do this but then it is no longer possible to execute a child recipe by itself Note that using _ include like this will always use the _t op scope for the variables set in the included recipe Be careful that the _recipe scope isn t used in one of the child recipes Sharing Modules Sometimes a group of settings is so gener
186. ing BDIR and changing or appending the suffix specified with sufname defaults to OBJSUF The attribute var_BDIR is used instead of BDIR when the attribute exists The attribute suffix is used for the suffix instead of using the suffix argument when the attribute exists When the auto argument is non zero the default then the filetype of the source file will be prepended to the sufname in upper case and adding an underscore Thus for a Java source file JAVA_OBJSUF will be used When it does not exists sufname is used When this is not wanted the auto argument must be set to zero suffix name Alphabetical list of Python functions 152 A A P Recipe Executive Return the filename suffix If there isn t one an empty string is returned Example suffix foo c non returns c Note that the dot isn t included while variables like OBJSUF do include the dot sufadd suf expr always 0 Returns expr with suffix suf appended When always is non zero the suffix is also added to items that already have a suffix If always is omitted or zero the suffix is only added to items without a suffix expr can be a list of filenames Example ISS RACE POS sufreplace from to expr Returns expr with all occurences of the suffix from changed to to When from is empty any suffix is changed to to When from is None the suffix to is also appended to items that do not have a suffix yet expr ca
187. ion should work Example Filenames relative to the child directory child_INSTALL_DATA myscript sh myicon png Now add those filenames relative to the top ONSEN ATA E ES ORDER CAN SAD AA Destination Directories 63 A A P Recipe Executive If you hard code the paths from the parent to the files to install say by writing INSTALL_DATA child myscript sh then you cannot execute the child recipe by itself as if it were a toplevel recipe since the paths will be wrong Using TOPDIR or equivalently the topdir function is the safe way to do so Uninstall aap uninstall deletes the file that aap install has installed All the targets and actions have the same name with install replaced with uninstall The same variables are used Files that do not exist are silently skipped Files that do exist but cannot be deleted will cause a warning message Sometimes your recipe offers installing optional files You probably want to uninstall those optional files as well without requiring the user the specify the same options again For this you can set the SUNINSTALL_ variables For example if you install either the foo or bar program tvariant What foo Target foo UNINSTALL_EXEC barSEXESUE bar Target bar UNINSTALL_EXEC fooSEXESUE program Target Sources Installing in non standard places When you need to install in other directories than the ones
188. irectory called aap Exec e Download the latest Aap zip archive and unpack it in the new directory e Run aap install or aap install Tutorial 3 A A P Recipe Executive To check if your Aap program is working type this command aap help You should get a list of the command line arguments Note that there are two dashes before help You can read details about the command line arguments in_Chapter 32 Aap Command Line Arguments Chapter 2 Compiling a Program A Hello world of sorts Most programming languages start with a short example that prints a hello world message With Aap this is also possible In a file called main aap enter the following print Hello World Now run Aap by entering aap at the command line Aap will respond something like this aap Hello World Aap No target on the command line and no TARGET build rules or all target As you can see Aap outputs the desired text but also prints an error message This is because Aap is not a programming language but a language for describing how to compile and build programs written in other languages In other words if you have written a hello world program in some language then you can use Aap to compile that program Using Aap to compile hello c Suppose you have written a hello world program in C and the sources are stored in a file called hello c Aap already knows about the C language and several others so the instruc
189. is License may add an explicit geographical distribution limitation excluding those countries so that distribution is permitted only in or among countries not thus excluded In such case this License incorporates the limitation as if written in the body of this License 9 The Free Software Foundation may publish revised and or new versions of the General Public License from time to time Such new versions will be similar in spirit to the present version but may differ in detail to address new problems or concerns Each version is given a distinguishing version number If the Program specifies a version number of this License which applies to it and any later version you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation If the Program does not specify a version number of this License you may choose any version ever published by the Free Software Foundation 10 If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different write to the author to ask for permission For software which is copyrighted by the Free Software Foundation write to the Free Software Foundation we sometimes make exceptions for this Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally NO WARRAN
190. is equal to the for line Scope 18 A A P Recipe Executive this indicates the for loop has ended Note how the name and fname variables are used without a dollar in the Python code You only put a dollar before a variable name in the argument of an Aap command Not in Python code and not on the left hand side of an assignment In line 2 the fname variable is set to README_ plus the value of name The os path exists function in line 3 tests if a file exists Assuming all four files exist this is the result of executing this recipe aap README _ solaris README_hpux README_linux README _freebsd Python Block When the number of Python lines gets longer the characters become annoying It is easier to put the lines in a block Example python Files for memes ain soglazist Mao Visas Ezeccosew 5 fname README name if os path exists fname aie Jal less miles Enles m Y Y Files Files fname Sla print Files This does the same thing as the above recipe but now using Python commands As usual the python block ends where the indent is equal to or less than that of the python line n_n When using the python command make sure you get the assignments right Up to the character the Python assignment is the same as the recipe assignment but what comes after it is different Expressions for Files In many places a Python expression can be used For examp
191. istributed to several sites at once This is unlike fetching which stops as soon as the file could be obtained from one of the items When publishing fails for one of the sites e g because the server is down this is remembered When you publish again uploading is done only for that site The destinations for which pusblishing worked will be skipped then Using Secure Copy Uploading files requires write access to the server There are several methods for this but some have the disadvantage that your password is sent as normal text over the internet Or someone in between can change the files that you send out There is one that provides sufficient security scp or secure copy Using Secure Copy 54 A A P Recipe Executive To publish a file to a server through secure copy use a URL in this form publish file publish scp myname the server com dir file myname is your login name on the server the server com The file will be written there as dir file relative to your login directory This requires the scp command which is not a standard item If it does not appear to exist then Aap will offer you to install it for you If the automatic mechanism fails you will have to install it yourself You might also want to do this if you have specific preferences for how the scp command is to be installed versions of scp exist with different kinds of encryption To avoid having to type a password each time you need to use publ
192. itten for set by the user Uses the format 1 0 1 3 Currently not used but in a later version of Aap it can be use for backward compatible behavior Remote sync program to use for rsync The default is not set which means rsync p rsh ssh copy links is used preserve file attributes use secure shell connection copy what symbolic link points to Sub directory to install sbin files into Default value sbin Secure copy program to use for scp The default is not set which means scp C p is used May also include arguments e g scp 1 c private keyfile Name of linker used to combine object files into a shared dynamic library Default value Id for Unix link for MS Windows Arguments for SHLINK Default value shared for Unix nologo dll for MS Windows List of source files OBSOLETE Program to run on installed program Default is empty When the strip action is involved Aap will search for the strip command and set STRIP to the found program Arguments for STRIP The default is not set Tar program to use Default value is tar List of target files usually the name of the resulting program OBSOLETE 133 A A P Recipe Executive TARGETARG Aap Target s specified on the command line TIMESTR Aap Time as a string in the form 23 11 09 This always uses GMT it ignores time zones and daylight saving But it depends on the system time to be set correctly
193. l targets Each of these dependencies is only added automatically if you do not define it yourself In other words if you do not define a dependency with install data as a target Aap will add such a dependency internally Unless you need special processing for specific kinds of items you should rarely need to define any of the install targets yourself The exceptions are install platform local install shared local and install local which you can define without disturbing Aap s normal mechanisms for installing the programs and libraries you create All these dependencies that Aap adds are at the toplevel Thus there is only one of each for all the recipes in your project See_ below for an example of including the path of an item Note that this works different from Caching 61 A A P Recipe Executive the clean and cleanmore targets These can exist multiple times each parent and child recipe can have one All of Aap s default install targets operate in roughly the same fashion specific actions are invoked for each install target The default actions all use top level variables named INSTALL_target which collect filenames to install Other toplevel variables control where those files are installed t argetDIR and what file mode is used targetMODE This table shows the specific settings for each of the default install targets Table 17 2 Settings for the install target target variable action directory def
194. laced with the name of the file being published Generating a HTML File It is common for HTML files to consist of a standard header a body with the useful info and a footer You don t want to manually add the header and footer to each page When the header changes you would have to make the same change in many different files Instead use the recipe to generate the HTML files Let s start with a simple example Generate the index html file Put the common header containing a logo and navigation links in header part The footer containing contact info for the maintainer goes in footer part The useful contents of the page goes in index_body part Now you can use this recipe to generate index html and publish it Files index html images logo png attr publish scp user ftp foo org public_html file Files all Files publish SFiles publishall index html header part index _body part footer part cat source gt Starget Notice that only the published files are put in the Files variable These files get a publish attribute which tells Aap that these are the files that need to be uploaded The part files are not published thus they do not get the publish attribute Three dependencies follow The all target is the virtual target we have seen before It specifies that the default work for this recipe is to update the files in the Files variable This means you don t accidentally upload the files by ru
195. le if a patent license would not permit royalty free redistribution of the Program by all those who receive copies directly or indirectly through you then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program If any portion of this section is held invalid or unenforceable under any particular circumstance the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system it is up to the author donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License Appendixes 188 A A P Recipe Executive 8 If the distribution and or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces the original copyright holder who places the Program under th
196. le the glob function can be used to expand wildcards Sonen clase Ev Python users know that the glob function returns a list of items Aap automatically converts the list to a string because all Aap variables are strings A space is inserted in between the items and quotes are added around items that contain a space Using glob is dangerous It is actually a bit dangerous to get the list of source files with the glob function because a test c file that Python Block 19 A A P Recipe Executive you temporarily used will accidentally be included It is often better to list the source files explicitly Why use glob when you can use wildcards directly The difference is that the expansion with glob takes place immediately thus Source will get the expanded value When using wildcards directly the expansion is done when using the variable but that depends on where it is used For example the_ print command does not do wildcard expansion pattern c expanded glob pattern dll e print pattern Spattern expands into Sexpanded When foo c and bar c exist the output will be aap pattern c expands into foo c bar c The following example turns the list of source files into a list of header files Sources O MACU Header sufreplace c h Source all APS O e SS SO eN print Header is Header Running Aap in a directory with main c and version c aap Sour
197. le was not damaged when downloading it child nopass name Read recipe name as a child Works like the commands were in the parent recipe with a number of exceptions 1 When name is in another directory change to that directory and accept all items in it relative to that directory 2 Build commands defined in the child are executed in the directory of the child Thus 1t works as if executing the child recipe in the directory where it is located 3 The child recipe defines a new scope Variables set there without a scope specification will be Alphabetical list of Commands 160 A A P Recipe Executive local to the child recipe 4 When the nopass option is used the child recipe is used as if it is a toplevel recipe Variables from the parent recipe are not available to the child 5 Build commands defined in the child recipe will be executed in the scope of that recipe The fetch attribute is supported like with_ include The_ child command can only appear at the recipe level chmod opt ion mode name Change the protection flags of a file or directory Currently mode must be an octal number like used by the Unix chmod command Useful values mode meaning 755 executable for everyone writable by user 444 read only 600 read write for the user only 660 read write for user and group options c continue when an item with a wildcard does not have matches continue with the next item f forc
198. le with delayed evaluation cannot be used directly in Python code because it is set the the class ExpandVar See the_var2string function for expanding the variable in Python code When first setting a variable with and later appending with the evaluation is done before the new value is appended VAR 1 TE WAR Tr a 2 VAR 3 Somalia ST prints 1 2 Note that evaluating a python expressions in is not postponed Chapter 36 Assignments 135 A A P Recipe Executive Block Assignment The normal assignment command uses a single line of text When broken into several lines they are joined together just like with other commands BR can be used to insert a line break Example POG tesi lime SIB second line BR third line BR The block assignment keeps the line breaks as they are The same example but using a block assignment TOS OE ese ias second line third line EOF The generic format is var lt lt term linel EAN term can be any string without white space The block ends when term is found in a line by itself optionally preceded by white space and followed by white space and a comment The amount of indent to be removed from all the lines is set by the first line When the first line should start with white space use All the variations of the assignment command can be used var lt lt term assign var lt lt term append assign if not set yet var lt lt ter
199. les set in the commands and need to be used after the action is finished The first argument is the variable name to which to assign the resulting program name When none of the programs is found an error message is given Note that shell aliases are not found only executable programs When the action uses a temporary file make sure it is deleted even when one of the commands fail The Python try finally construction is ideal for this Example garcia Flee jose aese tmp tempfname try sys extract_docs source gt S tmp sys docs2pdf tmp target finally delete Stmp print Converted source to Starget When the sys commands execute without trouble the delete and print commands are executed When the first sys commands causes an exception execution continues with the delete command and then the exception is handled Thus the second sys command is skipped and the print command is not reached More examples action compile object c cpp sys CC SCPPFLAGS SCFLAGS c source cacto DWE OJSC sys CC SLDFLAGS CFLAGS o Starget source Specifying Actions 104 A A P Recipe Executive Specifying Actions in Python When an action needs to be defined with more properties a Python function can be used Example python Clair sats aero Mouth il Want if DEFER_ACTION_NAME do SDEFER_ACTION_NAME target target S source else sys me lt source gt Starget w
200. lling ON UMR sesso sec nan Nado asian andadas 93 Installing a Specific Package cotton liliana EEEE EEE EEEE EEEREN RES 95 Clea in HUD enr RS 95 Chapter 26 Debugging a RECIPE eecceesseeseeecstecessecessaeceececeeneecsaeeesaecseaaeceaceceeeeeceeseaaecseaaeneaeeeeeeeees 95 Messages oe iae AANER T soli Sle hides tae ee gets ieee tee aes 96 Chapter Ditferences from Makes ci ccssseselecanteea tees vee ducesasie endaledee Dean edie cecesntiseatdelendeseelededees dal 96 Build tie dOES Ot lt gt I lt oe E E NE E EA AA E dd AECA 97 Use Of Environment Variables adoradores 97 Signatures Instead Of Timestamp ccccccesceceseceseeceeseceeaceseaceceeeeeaeeeeaaeceeaeceeaeeceaeeesaeeeeaaeceaaeseeaeeeses 97 Chapter 28 Customizing Filetype Detection and ACctiOns cc ceccecsccseseeceneeceeeeeseeeeesaeeeeaeeneaeeeeeeeees 98 Filetype Detectan e a ee aa A ida ted 98 Executing ACUSA aad e AE DES EEEa ERES ANET 100 Wetault A TEE OI I EE E A EE E AT A E 101 PEC SACOS EE EE O E ia O ads bad 102 Specifying Actions in Python seei anii e E E R a E e a E a E a R 105 Chapter 29 Customizing Automatic DepedenciesS coooconocccnonccnonccononannnnccnnoconnnccnnnncnnno cono conan ccnnnccnnnnss 105 Custom Dependency Checking yore Seteis Reaves tavennss EE E tees RE RO O E a Ea 106 Missing Include Files ni n innie eaaa aee e E a d ee ea a E E E eaaa 106 Chapter 30 Customizing Default To ls ie ee ceccessecessseceececeeeeeeaeeeaeceeaceceaee
201. lowing lines contain gt gt This will cause each line to be appended to pathdef c In the example the VIMRCLOC and srcdir variables are defined in the recipe config aap That is why this file is used as a source in the dependency Also note the use of in line 7 Since normally starts a comment it cannot be used directly here is a special item that results in a in the print output This is the resulting file pathdef c This file is automatically created by main aap DO NOT EDIT Change main aap only include vim h char_u default_vim_dir char_u usr local share vim61 char_u all_cflags char_u cc c I g O2 The list of gt gt redirections is quite verbose Fortunately there is a shorter way il include config aap 2 pathdef c config aap 3 print Creating target Pipe output in a variable 31 A A P Recipe Executive 4 text lt lt EOF 5 pathdef c 6 maite alle ls autorarically exceteco ly meim cic Omar 7 8 DO NOT EDIT Change main aap only S include vim h 9 char_u default_vim_dir char_u SVIMRCLOC 10 Glnigie 0 alll crees Clyne wi VSCC e SusisieeClie CHIA SI led EOF 12 print text gt target In line 4 text lt lt EOF is used This is called a block assignment The following lines up to the matching EOF line are assigned to the variable text You can use something else than EOF if y
202. ls back to vi On Unix and notepad otherwise Sub directory to install programs files into Default value is bin Mode to use for installed programs Default value 0755 readable and executable for everybody writable for the user 130 GMTIME HASGCC HASGCCXX INCLUDE INCLUDEDIR INCLUDEMODE INFODIR INFOMODE LD LDFLAGS LEX LEXFLAGS LEXPP LEXPPFLAGS LIBDIR LIBMODE LIBOBJSUF LIBPRE LIBS Aap conf conf user user Aap user Aap user Aap Aap conf conf user Chapter 35 Common Variables A A P Recipe Executive Suffix for an executable file Default value exe for MS Windows empty for others Time in seconds since 1970 Jan 1 This always uses GMT it ignores time zones and daylight saving But it depends on the system time to be set correctly The value does not change while Aap is running it is the time when Aap was started Also see STIMESTR and DATESTR Indicates whether gcc can be used to scan C sources for dependencies It is initialized empty When dependency scanning is to be done a configure check is run to see if CC can be used for dependency checking HASGCC is then set to yes or no You can set HASGCC to empty to force running the check again set it to no to avoid using CC for dependency checking or set it to yes to skip the configure check and use CC for dependency checking Indicates whether gcc can be used to sc
203. m When append is used it is put after the existing regexp detections script script type append Add detection of a filetype by examining the first line of the file When it starts with and script matches with the script program name it gets filetype type script is used as a Python regular expression It must match at the start of the program name Use to ignore a path End with to match at the end of the program name When type is remove a previously defined filetype detection for script is removed When append isn t given the new detection is put before existing script detections When append is used the new detection is put after the existing script detections python after append suffixlist python code Add detection of a filetype by executing Python code When the optional suffixlist is specified the Python code is only executed when the file name matches a suffix in this comma separated list of suffixes This speeds up detection by only executing the Python code on relevant files For example to only check bas and frm files python bas frm The code is executed with these variables set fname the name of the file fname_base the last part of the path ignore 1 if extra suffixes are to be ignored 0 otherwise When the code detects the filetype it must assing it to the variable type An JOError in the code is ignored Other errors are reported Thus an open call can be used without
204. m only assign when not set yet var lt lt term evaluate when used var lt lt term append evaluate when used var lt lt term only when not set evaluate when used Chapter 37 Attributes Attributes can be added to an item with the_ attr command and by using them in a dependency or rule Note that an assignment does not directly associate the attribute with a node This only happens when the variable is used in an_ attr command or a dependency The form for an attribute is name value value is expanded like other items with the addition that cannot appear outside of quotes Block Assignment 136 A A P Recipe Executive This form is also possible and uses the default value of 1 name Examples bar thatfile check SMYCHECK foo virtual somefile The virtual attribute is used for targets that don t exist as file or directory but are used for selecting the dependency to be built These targets have the virtual attribute set by default Table 37 1 Virtual Targets Target Commonly used for all build the default targets clean remove generated files that are not distributed added automatically cleanmore remove all generated files added automatically cleanALL remove all generated files AAPDIR and build directories below the toplevel recipe test run tests check same as test install build and install for use added automatically uninstall uninstall for use added automatically
205. me of a missing file can be located This is a Python regular expression where the file name matches in the first group in parenthesis See the sysdepend command for more details and an option to specify the search path Chapter 30 Customizing Default Tools Tools are used to execute actions Examples are a compiler and a linker Each tool must be executed with specific arguments But the recipe attempts to be portable thus not include the literal command to be executed The mechanism described in this chapter takes care of translating the generic action into invoking a specific tool with its arguments It all starts with an action Let us use the C compile action as an example In the default recipe a default C compile action is defined This one works for most C compilers that take arguments like the Unix cc command If another kind of compiler is to be used the C_COMPILE_ACTION variable is set to the name of the action to be used for example compile_msvc The default compile action will check the C_COMPILE_ACTION variable and invoke the compile_msvc action instead of using its generic compile command During startup the default recipe will check for existence of tools for C and C A specific sequence of tools is checked for depending on the platform Thus in MS Windows msvc will be checked for while on Unix this doesn t happen This is implemented with a Python module For msve it is tools msvc py Each tool module defi
206. mlink make a copy of the file u unlink or dir it links to Wildcards in local files are expanded This uses Unix style wildcards When there is no matching file the command fails also when there are enough other arguments When after expanding wildcards there is more than one from item the to item must be a directory For to only local files ftp rcp rsync and scp can be used See URLs for info on forming URLs Attributes for from and to are currently ignored Alphabetical list of Commands 162 A A P Recipe Executive del option file delete option file Delete files and or directories options f force don t fail when a file doesn t exist r recursive delete directories and their contents recursively q quiet don t report deleted files Wildcards in local files are expanded This uses Unix style wildcards When there is no matching file the command fails also when there are enough other arguments When deleting a symbolic link the link itself is deleted not the file or directory it refers to CAREFUL if you make a mistake in the argument anything might be deleted For example accidentally inserting a space before a wildcard shel Sule es aiempi s To give you some protection the command aborts on the first error Thus if dir temp didn t exist in the example would not be deleted deldir option dir Delete a directory Fails when the
207. mote source action edit view text c cpp sys vim source filetype can be default to specify an action used when there is no action specifically for the filetype When using a variable in the commands of an action without specifying a scope or using the _no scope its value is obtained from the first scope where it is defined from this list 1 The local scope the scope of the action commands 2 Invoking command blocks That is the scope of the command block that invoked the action with a do command Then the scope of the command block that invoked that command block and so on This excludes the toplevel 3 The recipe in which the do command was invoked its parent and so on This goes on until and including the toplevel 4 The recipe in which the action was defined its parent and so on This goes on until the toplevel The meaning of this all is that when using a variable such as FOOCMD you can give it a default value in the recipe where the action is defined The location where the action is later invoked from can define a different value Example FOOCMD foocc done action compile object foo sys SFOOCMD source gt Starget _recipe done S soure action foolist default sprint Compiled _recipe don The action can be used like this aLilg FOOCMD foocc 0 used instead of the default FOOCMD do compile target opt piet o piet f done nothing This has no effect do foolist any
208. mplicated expression the result of the eval command should be redirected to a variable like this import time eval time strftime A d B Y time localtime time time assign Datestamp manual html body html footer html print 1t BRS gt Last updated Datestamp Br sear lo chyloieml footer menl gt l Sireseceic The assign command takes the input from the pipe and puts it in the variable mentioned as its argument which is Datestamp here Actually the same can be done with a normal assignment and a Python expression in backticks but we intentionally wanted to show using a pipe here Creating a file from scratch It is also possible to completely generate a file from scratch Here is an example that generates a C header file al include config aap 2 pathdef c config aap 3 print Creating target 4 sore S target pauadest e 5 coria SS Giese Mois falle de avromarrcally crasas ly mella aaa 6 gora Ss Siege e DO INOW EDIT Clases mesbla aleja om 7 sprint gt gt Starget S include vim h 8 O E ES vion ehe TS US VIMEO Si 9 goring gt gt Stace Char ja sall cilags Ciara 1500 e 1Ssiccclice SCTMUNES Ys The first print command displays a message so that it s clear pathdef c is being generated The next line contains gt to overwrite an existing file It doesn t matter if the file already existed or not it now only contains the line pathdef c The third and fol
209. n is the preferred way to turn the specified input filetypes into the output filetypes The commands argument is a string with the Aap commands that are executed for the action Normally a multi line string is used Make sure the indent of each command is correct Alphabetical list of Python functions 147 A A P Recipe Executive The optional attr argument specifies extra attributes for the action The optional intypes argument specifies the list of input filetypes When omitted the get_in_typesQ function must be specified see below The optional outtypes argument specifies the list of output filetypes When omitted the get_out_types function must be specified see below The optional defer_var_names argument specifies a list of variable names that are used to make the action invoke another action The special name buildaction can be used to check the buildaction attribute of the source files for a specific build action to be used For example if defer_var_names is BUILD_ACTION buildaction then first BUILD_ACTION is looked at If it is defined its value is used as the name of the action to be invoked If it is not set then the buildaction attribute of the source files is obtained In the commands argument the DEFER_ACTION_NAME variable can be used it is set to the found action name Otherwise it is empty The optional outfilename argument specifies a string that forms the target file name It norm
210. n 146 Alphabetical list of Python functions eccecccecssecesseceececeececeeeeeaeeeaaecseaeeceaceceeeeseeeeaaeceeaeeeeaeeceaees 147 Chapter 42 A A P Commands iorsin oaei neiro reet E rE EE N ESE a ESN AE E E a E ish 155 Commands grouped by functionality eee eccecseecesseceeneeceeeeceeeeecaeeesaecseaceceaceceeeeeeeeeaaeceeaeeeeaeeeeaees 155 Alphabetical list Of Commands cicle caces EE E E E EE Ee anias 157 Common arguments for C mma ds eie aee noieeini esiin e ee desohora niiina 181 NRT E EE E EEE A AAE A E AA AEE EES 182 O A NN 184 Appendix A License niesen orrie eoe a a R EEEE ERITREA E sitas 184 A A P Recipe Executive Bram Moolenaar For Aap version 1 071 Copyright 2002 2003 Stichting NLnet Labs The license for copying using modifying distributing etc this documentation and the A A P files can be found in Appendix A License 2004 Oct 02 19 08 59 GMT Abstract This is the documentation for version 1 071 of the Recipe Executive commonly known as the aap command It is part of the A A P project The web site of A A P can be found here http www a a p org The HTML version of this manual can be read on line http www a a p org exec index html As a single file _http www a a p org exec exec html The PDF version of this manual can be found here _http www a a p org exec exec pdf The plain text version of this manual _http www a a p org exec exec txt Table of Contents
211. n Aap starts up Now try it out using the simple recipe at the top as main aap aap Aap foocomp hello foo o build FreeBSD4_5_RELEASE hello o Aap cc L usr local lib g O2 o hello build FreeBSD4_5_RELEASE hello o The foo aap recipe does three things 1 The filetype command is used to tell A A P to recognize your hello foo file as being a foo file 2 The action command is used to specify how the foocomp compiler is used to compile a foo program into an object file The user can set the FOOFLAGS variable to options he wants to use The convention is that the option variable is in uppercase starts with the filetype and ends in FLAGS 3 The route command is used to specify which actions are to be used to turn a foo file into an object file Defining a Filetype by Suffix The filetype command is followed by the line suffix foo foo The first word suffix means that recognizing is done by the suffix of the file name the suffix is what comes after the last dot in the name The second word is the suffix and the third word is the type Quite often the type is equal to the suffix but not always Here are a few more examples of lines used with filetype filetype Sto CM OO suits tes It is also possible to recognize a file by matching the name with a pattern checking the contents of the file or using a Python script See the user manual Defining a Filetype by Suffix 23 A A P
212. n be a list of filenames Example OBJECT sufreplace OBJSUF SOURCE tempfname Returns the name of a file which does not exist and can be used temporarily The recipe should take of deleting the file but Aap may delete the directory in which the file resides when it exits Thus don t depend on the file to continue to exist after Aap exits topdir arg Prepend TOPDIR to every item in arg This makes items with a path relative to the current recipe relative to the toplevel recipe Example COD ES MENS O O Cl SEE SA Also see_childdir and_var_abspathQ uninstall_files dir sources Uninstall the files specified in sources from the directory DESTDIR PREFIX dir When given the same arguments as install filesQ it will delete the installed files Example Files test foo txt test bar txt Dir usr local share Vina cell lores uninstall_files _no Dir _no Files var_abspath var Returns var with all filenames turned into absolute paths Prepends the current directory to each item in var which isn t an absolute path name Example ria vee clospocicia UE Oo oean Running this in home mool test results in home mool test foo home mool test bar var2dictlist var Turns var into a list of dictionaries var must be a string or a variable Each dictionary has a name entry for the item itself and other entries are attributes Example Alphabetical list of Python functions 153
213. n filetypes i e mentioned somewhere in a_ filetype command If you just make up filetypes and use them in actions Aap will give you a warning This helps detect misspellings and the like However for the optimized C filetype above this leads to a warning where you do not want one c_opt is a proper filetype in this context In order to declare a filetype without giving any rules to detect files of that type use declare in a_filetype command filetype declare c_opt The detected filetypes never contain an underscore A A P knows that the underscore separates the normal filetype from the additional part When no action is found for the whole filetype it is tried by removing the _ and what comes after it This isn t fully implemented yet Care should be taken that an action should not invoke itself For example to always compile version c when linking a program attr filetype my_prog TARGET action build my_prog object do compile target versionSOBJSUF version c do build target Starget filetype program Ssource versionSOBJSUF Without filetype program on the do build command the action would invoke itself since the filetype for TARGET is my_prog Attributes on source arguments of the_ do that start with var_ are passed on to the executed action as variables Examples selo loud fosa yer OLIN Iwo aa 2 sabe five OMIM Ai 2 OE eco ovii ilei LOG 8 In the same way an attr
214. name a UserError exception is raised Otherwise the value of attribute attr_name is returned Example action get_var_attr source buildaction Est ache oie do Saction Ssource has_target target Returns a number depending on whether a dependency exists in which target is a target item O there is no dependency for target 1 a dependency for target exists there is no dependency with build commands 2 a dependency for target with build commands exists Example Alphabetical list of Python functions 150 A A P Recipe Executive sti MOE heas arma VikSte ela has_targetarg targets Returns non zero if one of the items in targets was used as a build target in the aap command Example if has_targetarg commit tar include maintainer aap has_build_target Returns non zero if Aap was started with a target that will build something or no target at all the default target is expected to build something Returns zero if the only targets are clean cleanmore cleanALL or fetch Useful to skip configuration when it s pointless install_files dir sources mode Install the files specified in sources in the directory DESTDIR PREFIX dir Set the file protection to mode Attributes on the items in sources can change the destination directory and mode see_the section called Destination Directories dir can be any directory When dir is an absolute path starts with a slash
215. nes an exists function It contains a check if the tool can be found Mostly this is done by looking for a certain executable program The msvc tool searches for cl the compiler and vevars32 a command to start using the MSVC command line tools If a tool is detected the actions for it are defined This is always done also when another tool was already detected This allows the user to invoke specific actions or switch toolchain where he wants to For MSVC the compile_msvc action is defined That is like the normal compile action but with MSVC specific arguments The first tool that is detected will be used by default The use_actions function of the tool is invoked which sets a number of variables such as C_COMPILE_ ACTION to the name of the action to be used As mentioned above the result will be that the generic actions will invoke the tool specific action Building in a different way The default build action works for object files generated from C source files It might also work for other object files in that case you do not need to do anything When building needs to be done in a different way depending on the kind of source files used add a buildaction attribute to the object file This will make the default build action invoke the action specified with buildaction instead of the default build commands Sources without a buildaction attribute do not Chapter 30 Customizing Default Tools 107 A A P Recip
216. ng on MS Windows _recipe use_asroot to avoid having to make the choice again when invoked a second time the recipe is 94 A A P Recipe Executive first invoked with all to build the program as the current user and then with install to do the actuall install possibly as super user The_ asroot command passes the command to a separate shell with root privileges The user is asked confirmation for every executed command for safety Installing a Specific Package This automatic package installation system is a nice way of installing a program without the need to know how it s done You can also use it to install a package directly aap install scp This will attempt to install the scp package on your system It works just like when Aap discovered that the scp command was needed for executing a recipe Obviously not just any package is available Quite a few currently but hopefully this will grow when people submit their packages When a package cannot be found you get an error message aap install foobar Aap Creating directory home mool aap packages foobar Aap Entering directory home mool aap packages foobar Aap Attempting download of http www a a p org package php package foobar amp osname posix Aap Downloaded http www a a p org package php package foobar amp osname posix to boot aap Aap Error in recipe home mool aap packages foobar boot aap line 3 Sorry package foobar
217. ng the var_BDIR attribute if it is present In the last line is specified what happens when running aap without arguments in the core directory The object files are built There is no specification for how this is done thus the default rules will be used All the files in the child recipe are defined without mentioning the core directory That is because all parent and child recipes are executed with the current directory set to where the recipe is Note the files in Core_obj are passed to the parent recipe which is in a different directory That is why the parent recipe had to prepend core when using Core_obj This is so that the child recipe doesn t need to know what its directory name is only the parent recipe contains this directory name Sharing Settings Another mechanism to use a recipe is by including it This is useful to put common variables and rules in a recipe that is included by several other recipes Example CPPFLAGS DFOOBAR SMS OBS ESOO sys foocomp source o target Sharing Settings 26 A A P Recipe Executive This recipe adds something to CPPF LAGS and defines a rule to turn a foo file into an object file Suppose you want to include this recipe in all the recipes in your project Write the above recipe as common aap in the top directory of the project Then in core main aap and util main aap put this command at the top include common aap The include command works like the commands in the
218. nning aap without arguments The normal way of use is to run aap check if the produced HTML file looks OK then use aap publish to upload the file For index html a target is specified with a build command The_ cat command concatenates the source files source stands for the source files used in the dependency header part index_body part and footer part The resulting text is written to target which is the target of the dependency thus index html The gt is used to redirect the output of the_ cat command and overwrite any existing result This works just like the Unix cat command Generating a HTML File 11 A A P Recipe Executive In the dependency with the publish target the_ publishall command is used This command goes through all the files which were given a publish attribute with the_ attr command Note that this does not work This won t work Files index html publish scp user ftp foo org public_html file Using a publish attribute in an assignment will not make it used with the_ publishall command Using rule to Generate Several HTML Files Your web site contains several pages thus you need to specify how to generate each HTML page This quickly becomes a lot of typing We would rather specify once how to make a xxx html file from a xxx_body part file and then give the list of names to use for xxx if you have assocations with the name xxx_body part that is your own imaginati
219. nnot be used in the recipe start that sets the default settings and in the startup recipes The scope of variables set on the command line Can be used to obtain the values set when Aap was _arg executed or arguments of the execute command Although the scope is writable thus you can mess it up _parent The parent recipe Only valid in a child recipe The scope of the command block that invoked the current command block Can only be used in caller a command blocks of dependencies rules actions and_ tree These scope specifiers can be used to search scopes to find a variable The first scope in which the variable exists is used No scope equal to leaving out the scope specifier in recipe commands but required in Python no commands First looks in the current scope then _stack and then _tree Uses the scope of the command block that invoked the current scope the command blocks that _stack invoked that scope and further up the call stack Excludes the toplevel Can only be used in command blocks of dependencies rules and actions Uses the scope of the current recipe its parent the parent of its parent etc up to the toplevel tree aes In the toplevel recipe it is equal to _top _up First uses _stack and then _tree but excludes the current scope These are the scopes searched for a variable with the _up scope when it is used in a build command block 1 Invoking command blocks That is
220. ns sheets dees ie ethene PARED BAR el a eens 78 War tables A A o AA A a a TET ve te uae 79 Dependency Forti SAIZ a DA AE O Ad ta 80 Dependencies For Various Steps yrii e e aE E E E E a diciendo 81 PILA AE RON 82 Pott DESCrIPUlOn iaa E NE E EERE E AR EEEE EOE Aen 86 Chapter 23 Automatic Configuration sesei eieiei irese iiieoo tenai iein niii 86 Chapter 24 Using A tOCON seesi reuri i reais aesan aaaea eek Sedan Sa ai Gian aaa TESS a asiata 88 Running The Configure Script sweis ieee oaee bake tole EE E E AEE a a n a dio 88 Remembering Configure Arguments sesesesesesssssseesseesseesttssessesstssstesstesstesseesstestesstesstessesseeeseessees 88 Variants And CONTIQUTE sareen ena ene aE E E Ee TE E ETE EE EAE ERE aS 89 Running A toconf serene an e e lets ted ae Ne tas bog aa eE EAEE E aE pigs EE E e aE 89 Using A Distributed Configure Script ee cecccecssesssseceesceceececeeceeseceesaeceeaceeeaeeceseeeaeeseaaeceeaeceeaeeenaees 89 Skipping Conf Uria iii llista 89 A Complete Examples ii a Itata 90 Chapter 25 Automatic Package Install ceccecseessecessceceeeeceeeeesecessaeceeaceeeaeeceaeecaeeseaaeceeaeceeaeeeaees 91 How Does Tt Wok A ERIE 91 Adding Support For a Package scccssscsssscssrescesesessecsesssesscsesoeseeescsneecsnssccsssaesnacsonscceesesensesensnaesnnees 92 Tnstalling on MS WindOWsS ecese cional aa dae a e AAA Ein cta 93 A A P Recipe Executive Table of Contents User Manual Building and Insta
221. number k Maximum number of parallel jobs Not implemented yet continue 1 local i Continue after encountering an error When an error is detected in a block of build commands the execution of that block is aborted Building continues for other targets but a target that depends on a target that failed to build will not be build To continue execution after an error in the same block of commands use the Python try statement Example try src als ds lial Seucieone except UserError e print caught error str e Not fully implemented still stops at some errors Careful When an error has side effects strange things may happen Do not recurse into subdirectories Only applies to add and remove targets on the command line Also for revise for its remove action nobuild Only print messages about what will be done don t execute build rules Commands at the toplevel and Reference Manual 117 A A P Recipe Executive commands to discover dependencies are executed but system commands commands that download upload write or delete files and version control commands are skipped Note since no files are downloaded child commands won t work for not existing recipes N nofetch recip Do not fetch recipes when using the fetch and update targets Useful if the current recipe is to be used while files must be fetched profile file Profile the execution of A A P and write the re
222. nus one All action lines except the last one must define a filename This is the file used for the result of the action which becomes the input for the next action If the filename is not an absolute path BDIR will be prepended the var_BDIR attribute is used if present on the source file Example Alphabetical list of Commands 173 A A P Recipe Executive route yace c object yace S soueics e compile This defines the route from a yacc file to an object file with an intermediate c result The step non from yace to c is done with an action called yacc It will be invoked like this do yacc target source c Ssource The step from c to object is done with a compile action It will be invoked like this do compile target target source c The steps will be generated as separate dependencies Thus for the above example when an included header file of the intermediate C file changes only the compile action will be invoked options default This is a default route No warning is given if the route is redefined later The defined routes can be used explicitly with the totype command They are also used with the produce command and derivatives Note In a later version of Aap the defined routes may be used for dependencies without build commands and without a matching rule Thus the routes may be used as rules based on filetypes rule option tpat attr val spat
223. o XXX replace the body of a step The Port Recipe 78 A A P Recipe Executive pre XXX do something before a step post XXX do something after a step Example DOSIS O delete the directory used for testing del r f SWRKDIR testdir Variables Various variables need to be set to specify properties of the port variable used for example value PORTNAME name of the port foobar PORTVERSION app version number 3 8alpha PORTREVISION port patchlevel optional 32 CVSMODULES names of CVS modules to checkout optional Exec MAINTAINER_NAME maintainer name optional John Doe MAINTAINER maintainer e mail optional john foobar org PORTCOMMENT short description get foo into the bar PORTDESCR long description blah blah blah IS_INTERACTIVE requires user input optional yes or no Variables that can be used by the port recipe variable used for default value WRKDIR directory all files are extracted in and the building is done in work DISTDIR directory where downloaded distfiles are stored distfiles PATCHDISTDIR directory where downloaded patches are stored patches PKGDIR directory where files are stored before creating a package pack Variables that may be set by the port recipe defaults are set only after reading the recipe variable used for default value Directory inside WRKDIR where the unpacked sources end up This should be the common top WRKSRC directory in the unpacked archives When using CVS PORTNAME PORTVERS
224. of all the import time line This is a Python command to load the time module So far we used modules that Aap has already loaded for you This one isn t and since we use the time module in the next eval command it needs to be loaded explicitly The Python function strftime formats the date and time in a specified format See the Python documentation for the details In this case the resulting string looks like Monday 21 October 2002 The output of the eval command is piped into a print command The variable st din contains the output of the previous command Note that It is used instead of lt The meaning is exactly the same the value of the 1t variable Without the extra parenthesis it would read ItBR which would be the value of the ItBR variable The resulting text is lt BR gt Last updated Monday 21 October 2002 n Note that the first BR is the HTML code for a line break while the Br at the end is the Aap variable that contains a line break here displayed as n Finally the cat command concatenates the file body html the output of the print command and the file footer html Thus the stands for where the pipe input is used The result is redirected to target which is manual html Creating a file from pieces 30 A A P Recipe Executive Pipe output in a variable The generated date in the previous example could be used elsewhere in the recipe Since we don t want to repeat a co
225. of the recipe WARNING variables with a relative path become invalid This includes source and target Use var_abspath when needed changed option name Consider file name changed no matter whether it was really changed Similar to the command line argument changed FILE options r recursive Targets build from file name will also be considered changed recursively chdir dir Same as_cd checkin attr val fname Version control command also see Chapter 18 Version Control Commit the files to the repository and unlock them Just like commit and unlock checkinall fattr val Version control command also see Chapter 18 Version Control Apply the checkin command to all files in the recipe and child recipes that have the commit attribute Checkout attr val fname Version control command also see Chapter 18 Version Control Obtain the latest version of the files from the repository Lock the files for editing if possible checkoutall attr val Version control command also see Chapter 18 Version Control Apply the checkout command to all files in the recipe and child recipes that have the commit attribute Checksum file For each file argument compute the MD3 checksum and compare it to the md5 attribute of the file An error is generated when a file doesn t exist or when the checksums differ This command is useful to check if a downloaded fi
226. ol 19 Using CVS 20 Issue Tracking 21 Using Python 22 Porting an Application 23 Automatic Configuration 24 Using Autoconf 25 Automatic Package Install 26 Debugging a Recipe 27 Differences from make 28 Customizing Filetype Detection and Actions 29 Customizing Automatic Depedencies 30 _Customizing Default Tools 31 Adding A Language Module Chapter 12 How it all works How Recipes Are Executed Executing recipes is a two step process 1 recipe processing Read and parse the toplevel recipe child recipes and included recipes Commands at the recipe level are executed Build commands commands for dependencies rules actions etc are stored 2 target building Build each of the specified targets following dependencies Build commands are executed Generally one can say that in the first step the specification for the building is read and stored In the second step the actual building is done In a simple recipe the first step is used to set variables and define dependencies In the second step the dependencies are followed and their commands are executed to build the specified target print executed during the first step targetl sourcel source2 print executed during the second step User Manual 36 A A P Recipe Executive An exception is when Aap was started to execute a command directly The recipe processing step will still be done but instead of building a target the specified command is execut
227. ol is the first choice for MS Windows but the last choice for OS 2 This ordering is based on what works best for most people Note that for Unix systems there is no search for tools That is because the default command for the C compiler always works there There is one trick you should be aware of which is using the buildaction attribute on object files When a specific compiler is used to turn a source file into an object file this often means a specific action needs to be used to turn this object file into a program or library The compile action must then add a buildaction attribute to the object file so that the generic build action can inspect the object files and invoke the proper build action You can see this in the example above The compile action for the d language contains Use the d_build action for building and also for dll and lib sattr buildaction d_build Starget The action is not executed when the target is already up to date Therefore the buildaction attribute should also be set by the dependency or rule using a gt always section See the section called Command block sections Example rule SSOBJSUF cpp gt always attr buildaction cxx_build target gt build do compile target target source Note that the generic build action cannot handle the situation that object files with different buildaction attributes are linked together And object files that do not have a builda
228. ole name is prepended and is appended The pattern for contents is matched with every line in the file including the newline character and may match part of the line n Hidden and system files are found as well but the directory entries and are never selected The selected entries are ordered depth first For example tree foo would select foo sub f1 foo sub subsub f2 foo sub subsub foo sub f3 foo sub foo f4 Symbolic links to are not followed The symbolic link itself is included in the results if the pattern matches Use os path islink to test for symbolic links Hard links are not detected and may cause an infinite loop Example that creates a list of C files skipping old directories and test_ files source tree filename c skipdir old reject test_ source name unlock attr val fname Version control command also see_Chapter 18 Version Control Remove any lock on the files don t change the file in the repository Alphabetical list of Commands 180 A A P Recipe Executive unlockall attr val Version control command also see Chapter 18 Version Control Apply the unlock command to all files in the recipe and child recipes that have the commit attribute update force searchpath path target Update target now if it is outdated or when force is used One or more targets can be specified each will be updated
229. om the examples that were used to compile a program except that we explicitly mention the header file used Line 9 specifies where the files can be fetched from This is done by giving the source and header files the fetch attribute The attr command does not cause the files to be fetched yet When a file is used somewhere and it has a fetch attribute then it is fetched Thus files that are not used will not be fetched A user of your program stores this recipe as main aap and runs aap without arguments What will happen is Dependencies will be created by the program command to build theprog from main c and version c 2 The target theprog depends on main c and version c Since these files do not exist and they do have a fetch attribute they are fetched 3 The main c file is inspected for dependencies It includes the common h file which is automatically added to the list of dependencies Since common h does not exist and has a fet ch attribute it is fetched as well 4 Now that all the files are present they are compiled and linked into theprog Uploading You need to upload the files mentioned in the recipe above This needs to be repeated each time one of the files changes This is essentially the same as publishing a web site You will need to upload both the source files and the recipe itself The publish attribute can be used for this You can add the following two lines to the recipe above in order to
230. omething to happen But Aap checks the contents of the file not the timestamp A signature of hello c is computed and if it is still the same as before Aap knows that it does not need to be compiled even though hello c is newer than the hello program Aap uses the mechanism of dependencies When you use the_ program command Aap knows that the target depends on the sources When one of the sources changes the commands to build the target from the sources must be executed This can also be specified explicitly helloSEXESUF S BDIR helloSOBJSUF do build Ssource SBDIR helloSOBJSUF hello c do compile Ssource The generic form of a dependency is target list of sources build commands The colon after the target is important it separates the target from the sources It is not required to put a space before it but there must be a space after it We mostly put white space before the colon so that it is easy to spot There could be several targets but that is unusual There are two dependencies in the example In the first one the target is helloSEXESUF the source file is SBDIR helloSOBJSUF and the build command is do build source This specifies how to build the helloSEXESUF program from the BDIR hellos OBJSUF object file The second dependency specifies how to compile hello c into BDIR helloS OBJSUF with the command do compile source The BDIR variable holds the name of the platform dependen
231. ommands in a Pipe 29 A A P Recipe Executive The third and last part gt foobar txt redirects the output of the eval command back to the file foobar txt Using just gt would cause an error since the file already exists Note that in a Unix shell command this pipe would not work The foobar txt would be overwritten before it was read In Aap this does not happen the commands in the pipe are executed one by one That makes it easier to use but it does mean the text is kept in memory Don t use pipes for a file that is bigger than half the memory you have available Changing a file in place has the disadvantage that the normal dependencies don t work since there is no separate source and target file Often it is better to use a file foobar txt in as source change it like in the example above and write it as a new file The recipe would be FOOIOENIE EXE S TODOS EXE oa gontant Serra Care alin Siceuecerc 5 Cat source SETA TONE STE O CN SO CD AS a Va STC gt Starget Creating a file from pieces Sometimes you need to generate a file from several pieces Here is an example that concatenates two files and puts a generated text line in between manual html body html footer html import time eval time strftime A d B Y time localtime time time print 1t BR gt Last updated stdin BR seet bocka leal Foie meni gt Sieeuecpeic There are quite a few items here that need to be explained First
232. on This is how it s done Files 0 MEL images png attr publish scp user ftp foo org public_html file Files all Files publish Files publishall rule html header part _body part footer part cat source gt Starget This is very similar to the example that only generates the index html file The first difference is in the value of Files It contains wildcards These wildcards are expanded when they are used where a file name is expected The expansion is not done in the assignment More about that later In the three places where Files is used the wildcard expansion results in a list of all html files in the current directory and all png files in the images directory The second difference is that there is no specific dependency for the index html file but a rule command It looks very much the same but the word index has been replaced by a percent character You could read the rule command as a dependency where the stands for anything In the example the target is anything html and in the sources we find anything_body part Obviously these two occurrences of anything are the same word If you have made HTML pages you know they contain a title We ignored that until now The following recipe will handle a title stored in the file xxx_title part You also need a file start part which contains the HTML code that goes before the title Files 75 oE aL images png
233. on MS Windows that would be hello obj 4 The hello o object file is linked to produce the hello program on MS Windows this would be hello exe the exe is added automatically Other things to do with hello world The same simple recipe not only specifies how to build the hello program it can also be used to install the program aap install PREFIX try Aap Creating directory try bin Aap Copied test hello to try bin hello Aap usr bin strip try bin hello The PREFIX variable specifies where to install the program The default is usr local For the example we use the t ry directory which doesn t exist Aap creates it for you Other ways that this recipe can be used aap uninstall undo installing the program aap clean cleanup the generated files aap cleanALL cleanup all files careful See the reference manual for details about_ program Several Source Files When you have several files with source code you can specify them as a list program myprogram main c version c help c There are three source files main c version c and help c Notice that it is not necessary to use a line continuation character as you would have to do in a Makefile The list ends at a line where the indent is equal to or less than what the assignment started with The amount of indent for the continuation lines is irrelevant so long as it s more than the indent of the first line The Makefile styl
234. one for a file foo html If there are two with an equally long pattern this is an error TRICK When the source and target in a rule are equal it is skipped This avoids that a rule like this becomes cyclic Rules And Dependencies 45 A A P Recipe Executive o seule salo Parn 398 copy source target Command block sections Sometimes it is useful to execute commands when a target does NOT require updating For example to give a message And sometimes commands need to be executed no matter if the target is outdated For example to add an attribute to the target You can add sections to build commands of rules and dependencies Three kinds of sections are possible gt always always executed gt build executed when building the target gt nobuild executed when NOT building the target The sections can be used in arbitrary order and may appear multiple times All section headers must have the same amount of indent The commands in the sections must have more indent than the section headers Example LEO QUIE LOO 1m gt always Always attach an attribute to the target attr output yes Starget gt build Only when Starget requires updating scopy source target gt nobuild Only when Starget does not require updating print Starget is up to date Multiple targets When a dependency with build commands has more than one target this means that the build commands will produce all these t
235. or js ee ECO jouclonay o ASES 1234 proxy http www someproxy com 1080 The protocol can be ftp http or gopher When omitted http is used Case doesn t matter The address is a URL with the port number included The result of this command is that an environment variable is set as the Python library urllib requires Therefore it must be done early in the startup phase before accessing the internet publish attr val file Publish the files mentioned according to their publish or commit attribute Creates directories when needed for CVS only one level publishall attr val Publish all the files in the recipe and child recipes that have the publish attribute and changed since the last time they were published Note that this doesn t fall back to the commit attribute like publish does pushdir dir Change directory to dir The current directory is pushed onto the directory stack so that_popdir goes back to the old current directory Note that at the start of each command block Aap changes directory to the directory of the recipe WARNING variables with a relative path become invalid This includes source and target Use var_abspath when needed python python command block A block of Python code The block ends when the indent drops to the level of python or below python terminator python command block terminator A block of Python code The block ends when terminator is found on
236. or the user readable for the group and others Suffix for an object file to be included in a static library Default value o for Unix obj for MS Windows Prefix for static library The default is empty on MS Windows lib on Unix Arguments for linking after the object files Convention Always use Iname the tools will translate it into the flags that the linker actually uses Also see LTLIBS 131 LIBSUF LIBTOOL LNKSUF LOGENTRY LTOBJSUF LTLIBPRE LTLIBS LTLIBSUF MANDIR MANMODE MESSAGE OBJSUF SOPTIMIZE SOSNAME conf conf conf user conf conf user conf Aap Aap user Aap user Aap Chapter 35 Common Variables A A P Recipe Executive Suffix for a static library Default value lib for MS Windows a for Unix Actual name of the libtool program used to build libtool libraries and for building programs that use libtool libraries Default value libtool silent Suffix for a symbolic link Default is empty Default message for the version control change log Used when a file is committed also when it was deleted and the delete is committed Suffix for an object file to be included in a libtool library Default value lo Prefix for libtool library The default is lib Arguments for linking after the object files but before SLIBS When LTLIBS is set libtool will be used for building see LIBTOOL when the platform s
237. ory doesn t exist the default is empty Version number of Aap E g 31 version 0 031 or 1003 version 1 003 Also see SVERSIONSTR Name of archiver program combines object files into a static libray Arguments for AR default r or nologo Directory to write build files in Modified by the_ variant command A line break HTML browser to be used for the view action for HTML XML and PHP files The default value comes from the BROWSER environment variable or a list of known browser commands netscape mozilla konquerer grail iexplore mosaic lynx w3m When not empty specifies the action name to be executed for building Usually for building a program from object files with a specific tool A puildaction attribute on one of the object files is used before BUILD_ACTION See Chapter 30 Customizing Default Tools When not empty specifies the action name to be executed for building a dynamic shared library A buildaction attribute on one of the object files should be respected by the action specified with BUILDDLL_ACTION See_Chapter 30 Customizing Default Tools When not empty specifies the action name to be executed for building a static library A buildaction attribute on one of the object files should be respected by the action specified with BUILDLIB_ACTION See Chapter 30 Customizing Default Tools Program to use for bz2 compressed files Default value is bunzip2 When not empty specifies
238. osoft com For your convenience these things are imported for you already from glob import glob from RecPython import The RecPython module defines the Python functions listed in Chapter 41 A A P Python functions A backtick in the Python expression has to be escaped to avoid it being recognized as the end of the expression AE a orep ol too wch hT contains the Python expression y CA I ito a H Using Python Expressions 74 A A P Recipe Executive In the result of the Python expression characters are doubled to avoid them being interpreted as the start of a variable reference Otherwise Python expressions with arbitrary results would always have to be filtered explicitly When the resulting string is used the will be reduced to a single again The result of the expression is used as a string in place of the expression and the backticks Example Dos OO cua Mesas Would be equivalent to Foo foo one tmp two tmp Note that foo is only prepended to the whole result not each white separated item If you do want rc style expansion use two commands TT glob tmp Foo foo TT Equivalent to Foo foo one tmp foo two tmp Note that a following attribute is only attached to the last item resulting from the Python expression Source glob c check md5 Can be equivalent to Source foo c bar c check md5 To apply it to all items use the_ attr command Soure e OMC s
239. ot be used at the same time When using the f or force argument the exit value of the command is available in sysresult Output is logged by default If this is undesirable e g when starting an interactive command prepend i or interactive to the command It will be removed before executing it Example system i vi bugreport Aap attempts to execute consecutive commands with one shell to speed up the execution This will not be done when the f or force attribute is used these commands are executed separately Aap waits for the command to finish Alternatively you can use_ start which runs the command asynchronously When the async variable is set and it is not empty _ sys works like_ start except that consecutive commands are executed all at once in one shell Also see_ asroot for executing a shell command with super user privileges On MS Windows several commands use a forward slash for options and require using backslashes in file names But in Aap most file names use forward slashes To obtain the value of variable var with slashes replaced with backslashes use var See_Chapter 34 Variables and Scopes When using a variable as an argument it may need to be put in quotes to avoid it being interpreted as two arguments when it contains a space To obtain the value of variable var with quotes for the shell use var See Chapter 34 Variables and Scopes WARNING Using_ sys or_ system probably m
240. ou want to It must be a word that does not appear inside of the text as a line on its own White space before and after the word is ignored The indent of the text in the block assignment is removed The indent of the first line is used the same amount of indent is removed from the following lines Thus if the second line has two more spaces worth of indent than the first line it will have an indent of two spaces in the result Half a tab is replace with four spaces when necessary a tab always counts for up to eight spaces Chapter 11 A Ported Application When an application already exists but for your system it requires a few tweaks a port recipe can do the work This can also be used for applications that work fine but you want to apply a number of patches or to add a feature The recipe can be distributed so that others can install the application without knowing the details This works very much like the FreeBSD ports system This chapter is specifically for doing the port If you are only interested in another kind of building you might want to skip this chapter The Port Recipe Since A A P is prepared for doing all the work usually you only need to specify the relevant information such as where to find the files involved Here is an example ib A A P port recipe for Vim 6 1 plus a few patches 2 RECIPEVERSION LO 3 4 PORTNAME vim 5 LASTPATCH 003 6 PORTVERSION
241. owerful feature When a program is required and it does not exist on the system it can be installed automatically Suppose a recipe specifies that a file is to be uploaded to a server with secure copy This requires the scp command When Aap cannot find this command it offers you the choice to install it Aap will check what kind of system you have and find a recipe for it This recipe is executed and it will install the package for you Either by obtaining an executable program or by fetching the sources and building them Then the original recipe continues and uses the scp command that has just been installed Note This requires an internet connection How Does It Work The first step is to detect if a required program is present on the system This is done internally when scp or cvs is to be used You can also check explicitly in a recipe with the_ assertpkg command This uses the PATH environment variable Aap will also look in its own directory because this is where previously installed programs are sometimes located Also see the progsearch command and the program _pathQ function When the program is not found the user is asked what is to be done Cannot find package scp 1 Let Aap attempt installing the package 2 Retry install it yourself first q Quit Choice When the user types 1 the automatic install will be invoked That will be explained below An alternative is to install the package yourself This is us
242. p _default _start _parent _caller user_scope_name user_scope_name ascii letter ascii letter ascii number _ Chapter 34 Variables and Scopes Using Variables A variable value is normally a string The meaning of the value depends on where it is used For example is interpreted as a wildcard when a variable is used where a file name is expected Thus the wildcard is not expanded in the assignment If you need it use a Python expression to expand wildcards When using Python you can assign any type of value to a variable Only a few types are supported for variables used in Aap commands String Integer or Long converted to a string ExpandVar object used for delayed expansion of variables In Python code the ExpandVar object needs to be expanded before you can use the value it contains Use the var2stringQ function for that Normally using VAR gets what you want Aap will use the kind of quoting expected and add attributes when needed This depends on the place where the variable is used However when you want something else this can be specified var depends on where it s used var when the variable is not set or defined use an empty string instead of generating an error var without attributes may collapse white space var with attributes var use rc style expansion may collapse white space var slashes changed to backslashes for MS Windows commands var no q
243. p argument has build targetQ Checks if Aap was started that builds something sre2Zobj Transform source file names into object file names skipbuildQ Returns non zero when build commands are to be skipped Installing ask prefix Ask the user for an installation prefix do BSD port Attempt to install a BSD port do Debian pkg Attempt to install a Debian package install files Install files to a specified directory uninstall files Uninstall files from a specified directory Filesystem file2strin Return the contents of a file as a string rogram path Search for a program and return the full path tempfname Returns the name of a temporary file var_abspath Turn filenames into absolute paths childdir Prepend CHILDDIR to every item in the argument parentdir Prepend PARENTDIR to every item in the argument topdir Prepend TOPDIR to every item in the argument basedir Prepend BASEDIR to every item in the argument Various aap_has Check if Aap supports a feature redir_system Execute a system command are return its stdout sort_list Sort a list and return the resulting list Python functions grouped by functionality 146 A A P Recipe Executive get html imagesQ Extract list of images used in a HTML file suffix Return the filename suffix sufreplaceQ Replace filename suffix in a list of filenames sufadd Add filename suffix in a list of filenames define action Define an action Alphabetical li
244. p download php copy ZIP ftp upload sf net incoming ZIP copy ftp foo org README ftp bar org mirrors foo README Note that ftp machine path uses path relative to the login directory while ftp machine path uses path absolutely When from and to are directories from is created in to Unlike the Unix cp command where this depends on whether to exists or not Thus copy recursive foo bar will create the directory bar foo if it doesn t exist yet If the contents of foo is to be copied without creating bar foo use this scopy recursive foo bar options A when an item with a wildcard does not have matches continue with the next c continue item e exist exists don t overwrite an existing file or directory f force forcefully overwrite an existing file or dir default sad Aes before overwriting a local file prompt for confirmation currently doesn t i interactive work for remote files keep the directory of the source file if the target is a directory the targetfile Use a name is the target directory with the source file name appended m mkdir create destination directory when needed p preserve preserve file permissions and timestamps as much as possible q quiet don t report copied files r recursive recursive copy a directory tree to is created and should not exist yet when used with recursive don t copy a sy
245. pplies to variables in ALL scopes Thus when you have a scope foo in one place you cannot use the variable foo anywhere else The only exception is that you can use the variable foo in scopes that have been abandoned when the user scope foo is created but that is tricky Recommendation Let user scope names start with s_ A user scope can be specified for a dependency s_foo OPTIMIZE 4 foo scope s_foo foo c do build Ssource A user scope can be specified for a rule srule a scope s_aaa b A user scope can be specified for an action do foobar scope s_some foo bar Variables In Build Commands A dependency and a rule can have a list of commands For these commands the following variables are available source The list of input files as a string source_list The list of input files as a Python list source_dl Only for use in Python commands A list of dictionaries each input item is one entry depend The list of dependencies source files plus virtual dependencies as a string depend_list The list of dependencies source files plus virtual dependencies as a Python list depend_dl se o use in Python commands A list of dictionaries each dependency item is one target The list of output files as a string target_list The list of output files as a Python list target_dl Only for use in Python commands A list of dictionaries each output item is one entry buildtarget The name of
246. ps Make checks for outdated files by comparing timestamps A target file is considered out of date when it s older than one of the source files This means that Make will not notice a source file that was changed back to an older version And Make has big problems when a source file has a timestamp in the future happens when the system clock is turned back for some reason The target will always be older thus Make will build it Build if file does not exist 97 A A P Recipe Executive every time The default check for Aap is to use MD5 signatures This means a target is considered out of date if one of the source files is different from when this target was last build Additionally a signature is made for the build commands If you change the commands that build the target it will also be considered out of date Mostly this means Aap will build the target in many more situations If you want Aap to use timestamps like Make does set the SDEFAULTCHECK variable to newer Also see the_check attribute it can be used to change the check for a specific dependency Chapter 28 Customizing Filetype Detection and Actions See_Chapter 8 Filetypes and Actions for a simple example how to define a new filetype Filetype Detection A A P detects the type of a file automatically This is used to decide what tools can be used for a certain file The detection often uses the name of the file especially the suffix Extra suffixes like
247. ptions bar bar c options targetsuffix optional appended to the target if it doesn t contain a dot Alphabetical list of Commands 170 A A P Recipe Executive targetprefix optional prepended to the target if it doesn t contain a dot optional description of type of building displayed for aap comment comment PENE fi eee target A comment attribute on the target overrules this objectprefix optional prefix for the intermediate results objectsuffix optional suffix for the intermediate results objecttype mandatory filetype for the intermediate results installvar optional name of the install variable to add the target to default INSTALL_EXEC Set to an empty value to omit installing f mandatory name of the action used to turn the intermediate results into the buildaction target Can only be used at the recipe level program option target attr val source Specify that target is a program build from source Dependencies will be added to compile source into an object file and link the object files together into target When the basename of target does not contain a dot EXESUF will be appended The original name becomes an alias name for the target so that this works alle oo loe NAO asin ToO E TIOE Sjoeo eiechin logia lez e On MS Windows this builds foo exe and bar exe See_produce for the most important options The default values used for program are EXES
248. r Use of Filetypes When building a program you often want to include the date and time when it was built A simple way of doing this is creating a source file version c that contains the timestamp This file needs to be compiled every time your program is built Here is an example how this can be done al DOCE Drog E memi O Wore 2 3 attr prog filetype myprog 4 5 action build myprog object 6 version_obj src2obj version c 7 do compile target S version_obj version c 8 do build filetype program source version_obj The target prog is explicitly given a different filetype in line 3 The default filetype for a program is program here it is set to myprog This allows us to specify a different build action for prog Write the recipe as main aap without the line numbers and execute it with aap The first time all the files will be compiled and linked together Executing aap again will do nothing Thus the timestamp used in version c will not be updated if the files were not changed If you now make a change in main c and run aap you will see that both main c and version c are compiled Defining a Compile Action 24 A A P Recipe Executive The action command in line 5 has three arguments The first one build is the kind of action like before The second argument myprog specifies the target filetype the third one object the source filetype Thus the template is action kind of
249. r aS N OOOO y DR ANE NEEE 64 Installing in non standard places ecccceessessececsseceseeceesaeceeeeceeeeecaeeeaecseaaeceaeeceeeeeeeesesaeceeaeeneaeeseeeeees 64 Chapter 18 Version Controla ii ii iaa 65 Operating On Alles cialis 65 Using SubVersiOM neona dcvacesbestase eae ued Maswebscahelccaawe cl unteuvtescesobeutesasessceags a aaa e enia eae 67 Using Another Version Control System oo eccccesccesseceeseceececseneeceaeeeaecseaaeceaceceeeeeeeeeesaeceeaaeeeaeeceeeeens 67 Chapter Using Ei Sitios 68 Obtaming A Modales atan ea E a sete at ee 68 Pet A RN TN 68 Checking AI 69 Distributing Your Project With CVS ai ee e aE E Ee TE E E EE a E 70 Usin S OUrCefOrge sane irn eiaei okr EEEN E EEEE EEO KEE A E sacle RE EE E TEE AE 71 Chapter 20 Issie Trackin ge nnie ie a a a i a o lao tendat di nA ian aiat 72 Bug Repor iii Hees Teas a AA Aca 72 Bug Pax gin ede a ea a a aa an deen a A aE aes aed RS 72 Chapter 2 PA sing NO 73 Using Python Times aci iO in laws dee E E E E Cascade cedverers E EE E A ha 73 Using Aap variables in Python ecccecscccessecesecesseeeaecseaeeceneecaeeeeaecesaaecseaceseneecaeecsaeeseaaecseaeceeaeesaees 73 Using Pythons x pressions io o isd 74 Python Block utilice taal glasses 76 Us tul Python Items ot da lianas a AE AE Ee aio Eaa ae Ateoa Misvettaned 76 Chapter 22 Porting an Application ecccecccesccessseeesseceeacecencecsseeeesecessaecseaceneaeeceseecaeeesaaeceeaeceeaeesaees T11 Th Port Redmer iesscsirtea
250. rate the output file cat Ssource gt target Need to generate the index file again supdate index sulle falls ore The goal is to produce the file file out It is created from test in and index The index is created from file out which includes the index file thus a circular dependency exists The idea is to repeat generating file out until it no longer changes The recursive attribute is set to 3 for index and file out This allows rebuilding file out three times before giving up In the first dependency the update no attribute is used to avoid updating file out The build commands first update the index file before using update to update file out But this is only done when the index file has changed That is where the circular dependency stops When the generated index file no longer changes In the second dependency a similar thing is done The index file is not updated before executing the build commands but as part of the build commands Chapter 38 Filetype Detection The filetype detection module basically takes a file name and returns the type of the file The A A P filetype detection is a separate module You can use the filetype detection in recipes as a standalone program and from any Python program A filetype name is made of lowercase ASCII letters and digits a z and 0 9 The Program Usage Filetype py I ruledir f rulefile filename This will print
251. rated To execute recipe commands you need to start Aap for example asroot SAAP e copy r foodir usr local share AAP includes the Python interpreter so that it works the same way as how the current Aap was started assertpkg package For each argument check if the command by that name can be found If not ask the user and attempt installing the package for it Alphabetical list of Commands 158 A A P Recipe Executive Option optional after the package name indicates the user may chose not to install the package Without this option the user cannot chose to continue without the package being installed See Chapter 25 Automatic Package Install about using packages See_ installpkg for installing a package unconditionally assign varname Assign stdin to a variable Can only be used after a I See here about using stdin sattr fattrname itemname attrname attributel attrname itemnamel attrname Any attrname given before the items is added to each item in the list of items itemname The attrname give later are only added to the item just before it A node is created for each itemname This also means wildcards in item names will be expanded Example delia ietcla us2 oe risa Constante This adds the fetch attribute to both foo c and patch12 and the constant attribute only to patch12 This does the same in two commands Helin rerem CWSI ESE jacirala 2 sarci
252. re aap startup aap aap startup aap For other systems one directory is used the first one that can be found from this list SHOME aap startup aap SHOMEDRIVE SHOMEPATH aap startup aap c aap startup aap HOME HOMEDRIVE and SHOMEPATH are environment variables not Aap variables Use Of Variables Variables with uppercase letters are generally used to pass choices and options to actions For example CC is the name of the C compiler and CFLAGS optional arguments for the C compiler The list of predefined variables is in the reference manual here To avoid clashing with an existing or future variable that is defined by Aap use one or more lower case letters or prepend MY Examples Sn Ssources SFooFlags SMYPROG Also be careful with chosing a name for a user scope it must be different from all variables used in recipes Prepending s_ is recommended Examples s_debug CFLAGS Ss_ovr msg Special Characters Some characters in expressions have a special meaning And a command like_ print also handles a few arguments in a special way This table gives an overview of which characters you need to watch out for when using the print command Table 12 1 Special characters in the print command print argument resulting character C backtick gt Use Of Variables 40 A A P Recipe Executive lt lt 0 l Example clslialige gorio cie
253. rigin ftp ftp foo org recipes include once common aap fetch Origin common aap child core main aap fetch S Origin core aap child util main aap fetch S Origin util aap all theprogSEXESUE cascos SEEST 2 COra S Core alos will Ses ole do build source 00 J0O0U0N0BuNnNRA Executing a Recipe 28 A A P Recipe Executive The fetch attribute is used to specify the URL where the recipe can be obtained from This works just like fetching source files Notice in the example that the file name in the URL can be different from the local file name When Aap reads this recipe and discovers that a child or included recipe does not exist it will use the fetch attribute to download it The fet ch attribute can also be used with the execute command Once a recipe exists locally it will be used even when the remote version has been updated If you explicitly want to get the latest version of the recipes used run aap R or aap fetch Chapter 10 Commands in a Pipe A selection of commands can be connected together with a pipe This means the output of one command is the input for the next command It is useful for filtering text from a variable or file and writing the result in a variable or file Changing a timestamp This example shows how you can change the timestamp in a file It is done in place als Socie GSC ing catre da out AEX gt CARES ONE MIST ASTON STO CS E SI DA SO ES e cl gt
254. rived from the Program or any part thereof to be licensed as a whole at no charge to all third parties under the terms of this License c If the modified program normally reads commands interactively when run you must cause it when started running for such interactive use in the most ordinary way to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty or else saying that you provide a warranty and that users may redistribute the program under these conditions and telling the user how to view a copy of this License Exception if the Program itself is interactive but does not normally print such an announcement your work based on the Program is not required to print an announcement These requirements apply to the modified work as a whole If identifiable sections of that work are not derived from the Program and can be reasonably considered independent and separate works in themselves then this License and its terms do not apply to those sections when you distribute them as separate works But when you distribute the same sections as part of a whole which is a work based on the Program the distribution of the whole must be on the terms of this License whose permissions for other licensees extend to the entire whole and thus to each and every part regardless of who wrote it Thus it is not the intent of this section to claim rights or contest your rights to work
255. rnatives are specified with a bit more indent in lines 4 and 7 For each alternative two commands are given again with more indent Note that the indent not only makes it easy for you to see the parts of the variant command they are essential for Aap to recognize them To select the debug variant the Build variable must be set to debug A convenient way to do this is by specifying this on the command line aap Build debug T This will build the myprogd program for debugging instead of for release The DEBUG variable is recognized by Aap The object files are stored in a directory ending in debug Once you finished debugging and fixed the problem in for example gui c running Aap to build the release variant will only compile the modified file There is no need to compile all the C files because the object files for the release variant are still in the release directory Two Choices You can extend the Build variant with more items for example profile This is useful for alternatives that exclude each other Another possibility is to add a second variant command Let us extend the example with a selection of the user interface type 1 Source main c version c gui c 2 3 Variant Build 4 release 5 OPTIMIZE 4 6 Target myprog qi debug 8 DEBUG yes e Target myprogd 10 itil Gui motif 12 Variant Gui L3 console 14 motif 15 SOULS T MOCT EnC 16 gtk 7 Source
256. rogram prog main c common c SS texXeeCUure Test AED TSST print TestResult This recipe uses the program command as we have seen before This takes care of building the prog program For testing a separate recipe is used called test aap The first argument of the execute command is the recipe name Further arguments are handled like the arguments of the aap command In this case the target test is used The test aap recipe sets the TestResult variable to a message that summarizes the test results To get this variable back to the recipe that executed test aap the _parent scope is used if all_done Parente else _parent TestResult Some tests failed stResult All tests completed successfully It would also be possible to use the child command to reach the test target in it The main difference is that other targets in test aap could interfere with targets in this recipe For example test aap could define a different prog target to compile the program with specific test options By using execute we don t need to worry about this In general the child command is useful when splitting up a tree of dependencies in parts while execute is useful for two tasks that have no common dependencies Fetching a Recipe So far we assumed the included recipes were stored on the local system It is also possible to obtain them from elsewhere The example with children above can be extended like this O
257. ry 0700 The number must start Source Path 49 A A P Recipe Executive with a zero Build Command Signature A special kind of signature is used to check if the build commands have changed An example foo o buildcheck SCFLAGS foo c sys CC SCFLAGS c source o Starget This defines a check for the value of CFLAGS When this value changes the target is considered outdated When something else in the build command changes e g CC this does not cause the target to become outdated The default buildcheck is made from the build commands themselves This is with variables expanded before the commands have been executed Thus when one of the commands is sys CC CFLAGS source and CC or CFLAGS changes the buildcheck signature changes The_ do commands are also expanded into the commands for the action specified However this only works when the action and filetype can be estimated The action must be specified plain not with a variable and the filetype used is the first of 1 a filetype attribute specified after action 2 if the first argument doesn t contain a the filetype of this argument 3 the filetype of the first source argument of the dependency To add something to the default check for the build commands the commands variable can be used Example Version 1 4 foo txt buildcheck Scommands S Version del force target oia gt Seremos mais ae Suemoei print gt gt target version number
258. s used command attribute is ob ject type which changes the object file type from the default dl lob ject for instance for shared libraries to something else For programs that need to be linked by libtool you may also want to force the object files used in the program to be compiled with libtool since mixing non libtool objects and libtool libraries can cause problems For this use the objecttype ltobject as well so that libtool programs will usually have build commands like Attributes for the Production Commands 44 A A P Recipe Executive program filetype ltprogram objecttype ltobject The attributes assigned in the per target attributes are used in the build and install actions of the target Typical attributes assigned here are installdir and keepdir Variables that affect the build step can be assigned too such as var_LIBS and var_LDFLAGS The attributes for sources are used for the compile steps of the build process and useful attributes here are var_ INCLUDE if one source file needs special include files and filetype The attributes in the source global attributes position apply to all the sources in the list and per source attributes apply only to the source file immediately preceding the attribute An example that uses all of these settings is iL dbeilsdo nS ta livar Condu TEE knot es la 2 add_LIBS lkdeui 3 add INCLUDE I BDIR knotes 4 kno
259. s GUND BRR a ae Sin antes 46 Automatic dependency Checking eeecceecceesccecseecesseceesaeceeneceeneecaeeesaeceeaaeceaceceeeeeseeeesaeeseaaeseaeeeeeeeees 47 Attributes Overruling Variables iseenese tiri iese se A EAE a AE En ai A AE 48 Virtttial A RUN 48 SOULCE Pa diia 49 Dependiig On A Directly sesionin nenea EAE EEEE EE ENEE EEEE EAEE AEE AEE 49 Build Command SiON acres sisirin aen e a a ae a ae eine iE eaat 50 Chapter 14 Vara i e riscos E TE Ea oa a Ea Gea Sade en ie eee aes 51 The BDIR Varta ble iaa d 51 Compile Only when needed escondite aE aE adele Dean deidades 51 Building multiple variants at Onte eicere aneirin eene aT E E EEE a nono cono EEEE a e E 52 Chapter IA RN 53 Using Secure COP A A ce det eas tenes 54 Using Another Method iii iia linia avelees acehe RES 55 Chan gine A Url A A a A E tai 55 Distributing Generated Files ei enore i ree e arrea eE APAE EELEE aar EEVA KEEA CENEO RAAE EASES E SEN 56 Copying AIk Pil s At ONCEren a iaa earn i a ee ad I ea alae alias RN 56 Publishing images for HTML files eccecccecsseceseeceeaeceececeeeeecueeesaeceeaaeceaeeceeeeeseeeeeaaeeseaaeneaeeeeeeeees 57 Chapter t6 Fetching secos ii da EIA AT uae A AA a e 57 A A P Recipe Executive Table of Contents User Manual Fetching And Update 57 The Fetch Attributes ici iaa ais 58 Defining Your Own Method rinser Hasevusscdeas rta sitiada 59 IO 60 Chapter 17 Install cai ida 60 Destination Directori S n let Ai ie io ita 62 Unitat aia t
260. s a suffix a dot in the last component adding extensions is not done Returns the first program found Returns None when name could not be found Only finds executable files not ordinary files Optional arguments path search path to use instead of PATH when a string items are separated with os pathsep RR extensions to try Can be a list or a string When a string is used items must be P separated with os pathsep skip name of directory to skip name is not found in this directory Example search for program foo py and foo sh iy jOxrOCiecin eta MEOW joaicinexs ay esla 1 redir_system cmd use_tee 1 Execute shell commands cmd and return two items a number indicating success and the stdout By default tee is used to display the output as well as redirecting it When no output is desired set use_tee to zero Example ok text redir_system ls 0 1 OE prenen ls our El Le ese else print ls failed skipbuild Returns non zero when build commands are to be skipped This is when Aap was started with the nobuild or touch argument sort_list list sorts a list and returns the list Example INP sort_list glob inp The Python list sort method doesn t return the sorted list src2obj source sufname OBJSUF auto 1 Transform a string which is a list of source files into the corresponding list of object files Each item in source is changed by prepend
261. s end in aap Module directories Modules that are included with Aap are located in the Aap sub directory modules If you are working on a module that is to be submitted for a next Aap release you may also want to put the module there for testing But be aware that this directory may be overwritten or deleted when updating Aap Modules that you want to share with all users on your system should be placed in a system wide directory For Unix this usually is usr local share aap modules This can be changed with AAPSYSDIR Modules that you only use for yourself are placed in HOME aap modules for Unix and Mac OS X SHOME aap modules SHOMEDRIVE SHHOMEPATH aap modules orc aap modules MS Windows Chapter 31 Adding A Language Module 109 A A P Recipe Executive If you only want to change a few settings after the module is loaded you can place these in the modules2 directory See_ import for details Parts Of A Module In a module you will usually find these parts 1 filetype recognition How to recognize files used in the module For a module included with Aap this is normally missing since it can be added to the generic Python filetype module See Chapter 28 Customizing Filetype Detection and Actions 2 default values Give default values to variables used in the commands further on The user can change these values if he needs to It is a good habit to put all specific command names dir
262. s for var in the _no scope this does not happen for Python Python only looks in the current scope Thus you must explicitly specify _no var in Python code to get the same effect as var in an Aap command In the following example a local variable system is used CFLAGS DFOO aut system SOSTYPE if system posix flags _recipe CFLAGS The same thing could be done by accessing SOSTYPE directly from Python Chapter 21 Using Python 73 A A P Recipe Executive CFLAGS DFOO alle Este 0 OSI Viowysalyc s flags _recipe CFLAGS Using Python Expressions In an assignment command arguments and most other places a Python expression can be used in backticks Expanding this is done before expanding VAR items because this allows the possibility to use the Python expression to result in the name of a variable Example foovaridx 5 Foo Src foovaridx Is equivalent to HOO Sires The result of the Python expression in backticks should be a string or a list of strings A list is automatically converted to a white separated string of all list items A Python expression cannot be used for the variable name in an assignment This doesn t work varname this does not work If you really need this use a Python command instead eval varname value When using a function from a module it must be imported first Example from httplib import HTTP Connection HTTP www micr
263. s given only the local scope is used To get the equivalent of an Aap command that does not specify a scope you need to use the _no scope in Python The same example as above but now with a Python expression looks like this Socie _ INO WSSWULE print the result Predefined Scopes Aap defines a scope for each recipe and each block of commands Variable Indexing 123 A A P Recipe Executive A user may also define a specific scope see below These scope names must start with an alphabetical name Scope names starting with an underscore are used for predefined scopes Each time a block of commands is executed a new scope is created Thus when executing the commands for a dependency a second time its scope will not contain items from the first time A variable may exist in several scopes with a different value To specify which scope is to be used a scope name is prepended before the variable name using a dot to separate the two These scope specifiers can be used to access a specific scope _recipe The current recipe Useful in build commands that are defined in the recipe _top The toplevel recipe This can be regarded as the global scope The scope of default values after the defaults settings have been done but before reading user or default 7 z system startup recipes Cannot be used in the recipe that sets the default settings The scope of startup values as it was before reading the toplevel recipe Ca
264. s only search for ports in usr ports and on the ports a a p org http ports a a p org web site Steps These are the individual steps for installing a ported application Each step up to install depends on the previous one Thus aap install will do all the preceding steps But the steps that have already been n successfully done in a previous invocation of Aap will be skipped The rundepend installtest clean etc targets do not depend on previous steps they can be used separately dependcheck Check if required dependencies can be fulfilled This doesn t install anything yet it does an early check if building and or installing the port will probably work before starting to download files This uses all the DEPEND_ variables that will actually be used Fails if something is not available fetchdepend Check dependencies for fetch and checksum Uses DEPEND_FETCH unless disabled with AUTODEPEND no fetch Get required files If CVSMODULES is set and CVS is not no obtain files from CVS Uses CVSROOT or cvsroot attribute in CVSMODULES CVSWRKSRC is where the files will end up default is first member in CVSMODULES Also obtain CVSDISTFILES if defined Also obtain CVSPATCHFILES if defined Use a post fetch target if directories need to be renamed else Steps 82 A A P Recipe Executive if DISTFILES is set obtain them if PATCHFILES is set obtain them Use MASTER_SITES for CVS DISTFIL
265. s the value mswin C gt aap INCLUDE is Ic vc include C gt Note that the Python conditional commands end in a colon Don t forget to add it you will get an error message The indent is used to form blocks thus you must take care to align the if and else lines You can include more lines in a block without the need for extra characters such as in C Calis OSI Wioreisais lt s INCLUDE 1 usr local include LDFLAGS L usr local else INCLUDE Ic vc include LDFLAGS Le vc lib Scope In Aap commands a variable without a scope is searched for in other scopes Unfortunately this does not happen for variables used in Python To search other scopes you need to prepend _no before the variable name Changing the above example to print the result from Python PERRO SIB DO SiS INCLUDE I usr local include else INCLUDE Ic vc include alla Pan EN CLOUDS SO INCLUDE Loops Python has a for loop that is very flexible In a recipe it is often used to go over a list of items Example dior memes aim Solaris apa Mim Esos fname README_ name if os path exists fname Files Sfname adi print Files O Ol me WN The first line contains a list of strings A Python list uses square brackets The lines 2 to 4 are executed with the name variable set to each value in the list thus four times The indent of line 5
266. s to all variable scopes for expert users only machine the machine name from the url what comes after the scheme upto the first slash Defining Your Own Method 59 A A P Recipe Executive path the path from the url what comes after the slash after machine fname the name of the file where to write the result The function should return a non zero number for success zero for failure Or raise an IOError exception with a meaningful error Here is an example python def fetch_foo dict machine path fname from foolib import foo_the_file FooError Cee foo_the_file machine path fname EX SSPE PoC hrror 07 nase Ona Mierda oo ateulikeele Es E Siria 8 return 1 Note that a version control function overrules a fetch function Thus if foo_command is defined fetch_foo will not be called Caching Remote files are downloaded when used This can take quite a bit of time Therefore downloaded files are cached and only downloaded again when outdated The cache can be spread over several directories The list is specified with the CACHE variable NOTE Using a global writable directory makes it possible to share the cache with other users but only do this when you trust everybody who can login to the system Someone who wants to do harm or make a practical joke could put a bogus file in the cache A cached file becomes outdated as specified with the cache_update attribute or the CACHEUPDATE variable Th
267. s with a publish attribute mkdownload Create a recipe to download files prox Define a proxy server Version control Chapter 42 A A P Commands 155 add zaddall checkin checkinall checkout checkoutall commit commitall remove removeall reviseall tag tagall unlock unlockall verscont A A P Recipe Executive Add a file to the version control repository Add all files with a commit attribute to the version control repository Checkin a file into the version control repository Checkin all files with a commit attribute into the version control repository Checkout a file from the version control repository Checkout all files with a commit attribute from the version control repository Commit files to the version control repository Commit all files with a commit attribute to the version control repository Remove a file from the version control repository Remove all file without the commit attribute from the version control repository combination of checkinall and removeall Add a tag in the version control repository for a file Add a tag in the version control repository for all files with the commit attribute Unlock a checked out file Unlock all checked out files with the commit attribute Generic version control command System commands asroot System start syseval sysdepend syspath Execute a command as the system administrator Execute
268. se the same specification for the repository as used when checking the files out sewr TOOG comme CYS These commands can be used commit Update each file in the repository Add it when needed checkout Like fetch and additionally lock for editing when possible checkin Like commit but unlock file unlock Remove lock on file don t change file in repository or locally add Add file to repository File must exist locally Implies a commit of the file remove Remove file from repository File may exist locally Implies a commit of the file tag Add a tag to the current version Uses the tag attribute Additionally there is the generic command vors cont aceron Matth Well 63 Ale gow This calls the Version control module as specified in the commit attribute for action with the supplied arguments What happens is specific for the VCS Operating On All Files These commands work on all the files mentioned in the recipe and child recipes that have the commit attribute checkoutall Checkout the files and locks them commitall Commit the files Files missing in the VCS will be added No files will be removed checkinall Just like commitall and also remove any locks Chapter 18 Version Control 65 A A P Recipe Executive unlockall Unlock the files Inspect directories and add items that do not exist in the VCS but are mentioned in the recipe s addall with a commit attribute Uses the current dir
269. sed to the compiler Optimization is on by default If DEBUG is set to yes the g switch will be passed to the compiler For other language independent switches like gt use the DFLAGS variable The language dependent debug switches should be put in the SDDEBUG variable gcc Adds support for the GNU C compiler tools icc Support for the IBM C compiler tools mingw Adds support for the GNU C compiler tools under the MinGW environment msvc Support for the MicroSoft Visual compiler tools Chapter 41 A A P Python functions This chapter documents the Aap specific functions that can be used in Python code Chapter 40 Standard Tools 145 A A P Recipe Executive Python functions grouped by functionality Variable Values expand2dictlist Expands wildcards and turns it into a list of dictionaries expand2list Expands wildcards and turns it into a list of items expand2string Expand wildcards user and user wildescape Avoid expansion of wildcard characters var2dictlist Turns a string into a list of dictionaries var2list Turns a string into a list of items var2string Does delayed evaluation of var when necessary get attr Returns a dictionary with the attributes of a node get var attr Returns the value of a specific attribute used in a list of items Dependencies has target Checks the kind of dependencies a target has has targetarg Checks if one of the arguments was used as an Aa
270. show w This is free software and you are welcome to redistribute it under certain conditions type show c for details The hypothetical commands show w and show c should show the appropriate parts of the General Public License Of course the commands you use may be called something other than show w and show c they could even be mouse clicks or menu items whatever suits your program You should also get your employer if you work as a programmer or your school if any to sign a copyright disclaimer for the program if necessary Here is a sample alter the names Appendixes 190 A A P Recipe Executive Yoyodyne Inc hereby disclaims all copyright interest in the program Gnomovision which makes passes at compilers written by James Hacker lt signature of Ty Coon gt 1 April 1989 Ty Coon President of Vice This General Public License does not permit incorporating your program into proprietary programs If your program is a subroutine library you may consider it more useful to permit linking proprietary applications with the library If this is what you want to do use the GNU Library General Public License instead of this License Appendixes 191
271. ssertpkg but without checking if the package is already present or asking the user whether it should be installed See_Chapter 25 Automatic Package Install about using packages lib option target attr val source Specify that target is a static library build from source Dependencies will be added to compile source into an object file and combine the object files together into target When the basename of target does not contain a dot LIBPRE will be prepended and LIBSUF will be appended The original name becomes an alias name for the target so that this works Alphabetical list of Commands 167 A A P Recipe Executive alls oo loas 21309 oo 2 LOE Zila loa 2 oes On Unix this builds libfoo a and libbar a See_ produce for the most important options The default values used for lib are LIBSUF for targetsuffix LIBPRE for targetprefix LIBOBJSUF for objectsuffix libobject for objecttype INSTALL_LIB for installvar and buildlib for buildaction In addition the onestep option explained for command can be used attr val is an optional attribute that apply to the generated dependencies Use the scope attribute to specify a user scope to be used before other scopes except the local scope in the generated dependencies The target will be added to SINSTALL_LIB Use the installvar option to select another variable name Use installvar when installing the target is not w
272. st of Python functions aap_has name Returns non zero if Aap supports feature name These features can be checked command name Whether the command command name is supported Example Qif aap_has tree tree filename aap print recipe found name ask_prefix name Ask the user where to install the package name Returns a tuple asroot prefix asroot is a boolean indicating whether the package is to be installed as root using_ asroot prefix is the root for the install If the user is root it will return 1 usr local without asking When aborted it returns an empty prefix basedir arg Prepend BASEDIR to every item in arg This makes items with a path relative to the toplevel recipe relative to the current recipe Example LibFiles basedir LibNames Also see topdir and_var_abspath childdir arg Prepend CHILDDIR to every item in arg This makes items with a path relative to the child recipe relative to the parent recipe Example _parent DISTFILES childdir DISTFILES Can only be used in a child recipe Also see parentdir topdir and_var_abspath define_action action primary commands attr intypes outtypes defer_var_names outfilename Define an action with the name action Also see the section called Specifying Actions The primary argument must be zero for a normal action one for a primary action A primary actio
273. sults in file This file can then be examined with the standard Python module pstats The PrintProfile py script can be used for this it is located with the other Aap modules R fetch recip Fetch the recipe and child recipes This is impled by using a refresh fetch or update target unless nofetch recipe is used 5 stop Stop building after encountering an error This is the default thus this option has no effect Also see Ccontinue 5 silent Print less information see MESSAGE st touch Update signatures on targets without executing build commands After doing this the specified targets and intermediate results are considered up to date Commands at the toplevel will be executed except system commands commands that write a file and version control commands u up search up Search the directory tree upwards for the main aap recipe Useful when in a sub directory of a large project where the main aap recipe is an unknown number of directory levels upwards y version Print version information and exit Does not read a recipe Ni verbose Print more information see MESSAGE End of options only targets and assignments follow Use this when a target starts with a Chapter 33 Recipe Syntax This defines the recipe syntax It is not very strict but you should be able to understand what is allowed and what isn t Chapter 33 Recipe Syntax 118 A A P Re
274. t OPTIMIZE 4 S_opt DEBUG no Note that you can set the values of the variables in the user scope after adding the scope attribute to filter c Virtual Targets A virtual target is a target that is not an actual file A Virtual target is used to trigger build commands without creating a file with the name of the target Common virtual targets are clean all publish etc When a target is virtual it is always built Aap does not remember if it was already done a previous time However it is only build once for an invocation of Aap Example clean del r f temp To remember the signatures for a virtual target use the remember attribute version virtual remember version txt in Attributes Overruling Variables 48 A A P Recipe Executive sprime SVezsioja scat Ssouisee gt l veamsilo sex Now aap version will only execute the_ print command if version txt in has changed since the last time this was done Using remember for one of the known virtual targets e g all or fetch is unusual except for publish When using remember for a virtual target without a dependency 1t will only be built once This can be used to remember the date of the first invocation all firsttime firsttime virtual remember cpm icate leales Dulle Om DATES gt Ealsesicloma lel Esde The difference with a direct dependency on firstbuild txt is that when this file is deleted it won t be built ag
275. t directory for intermediate results as mentioned in the first example of this chapter In case you need it the SEXESUF variable Aap is empty on Unix and exe on MS Windows The relation between the two dependencies in the example is that the source of the first one is the target in the second one The logic is that Aap follows the dependencies and executes the associated build commands In this case hello EXESUF depends on BDIR hello OBJSUF which then depends on hello c The last dependency is handled first thus first hello c is compiled by the build command of the second dependency and then linked into helloSEXESUF by the build command of the first dependency Now change the hello h file by replacing World with Universe define world Universe If you now run Aap with aap hello or aap hello exe the hello program will be built But you never mentioned the hello h file in the recipe How did Aap find out the change in this file matters When Aap is run to update the hello program this is what will happen Comments 8 A A P Recipe Executive ER The first dependency with helloSEXESUF as the target is found it depends on BDIR hellos OBJSUF 2 The second dependency with S BDIR helloSOBJSUF as the target is found The source file hello c is recognized as a C program file It is inspected for included files This finds the hello h file stdio h is ignored since it is a system file hello h is ad
276. t line are replaced with a single space An exception is when the line ends in BR The BR is removed the line break is inserted in the text and leading white space of the next line is removed All indent is computed with a tabstop setting of eight spaces For items that have a build_block the start of the build block is the line with the smallest indent that is larger than the indent of the line that started the item The lines before this are continuation lines of the command itself Example mytarget sourcel source2 continuation line of dependency sprint Ssource first line of the build block something continuation line of print command Chapter 33 Recipe Syntax 119 aapfile aap_item dependency targets sources build_block rule variant variant_item toplevel_command build_command assignment block_assignment python_item python_line python_block generic_command A A P Recipe Executive aap_item EOL dependency rule variant toplevel_command build_command targets attribute sources EOL build_block Item_list item_list INDENT build_command EOL INDENT build_command rule attribute pattern attribute pattern EOL build_block variant variable_name EOL variant_item INDENT varvalue EOL INDENT2 build_block child_command clearrules_command delrule_command dll_command lib_
277. takes care of installing almost any software you can think of The only disadvantage is that you need to be super user to use it Aap will ask you if you want to do this The devel templ port appears to exist Do you want to become root and use the port y n If you respond with y you will be asked to type the root password and Aap will invoke the commands to build and install the BSD port If you respond with n the generic Unix method will be used if there is one On MS Windows it will often be possible to download an executable file This works without asking questions Since there is no standard directory for executables they are often placed in the Aap directory You might want to move them to a directory in PATH if you want to use them at the command line On generic Unix systems Posix Linux the recipe will attempt to download a source archive unpack it and build and install it This mostly works but may fail on some systems You may have to do some steps manually then possibly by running configure with specific arguments You can find the downloaded files in aap packages package name The Aap message log AAPDIR log may contain hints about what went wrong If you know the solution please report this to the maintainer of the recipe so that it can be made to work automatically Adding Support For a Package To make it possible to automatically install a package at least one recipe needs to be written This recipe
278. tandard Modules There is no standard module for the C language This language is supported without the need to import a module The following modules are distributed with Aap d Support for the D programming language With this module imported program d11 and Lib commands can be used as easily as with C or C To customize compilation and linking the variables below can be filled See also_Chapter 40 Standard Tools for supported D tools Table 39 1 Variables of the D module name type description D_COMPILE_ACTION Aap When not empty specifies the action name to be executed for compiling a D file into an object dllobject or libobject file See Chapter 30 Customizing Default Tools D_BUILD_ACTION Aap When not empty specifies the action name to be executed for building a program or library from object files compiled by a D compiler A buildaction Chapter 39 Standard Modules 143 A A P Recipe Executive D_BUILDDLL_ACTION D_BUILDLIB_ACTION D_BUILDONESTEP_ACTION D_BUILDDLLONESTEP_ACTION D_BUILDLIBONESTEP_ACTION DFLAGS DLINKFLAGS DIMPORT DVERSION DDEBUG DIMPLIB libtool Chapter 39 Standard Modules Aap Aap Aap Aap user user user user user user attribute on one of the object files is used before D_BUILD_ACTION See_Chapter 30 Customizing Default Tools When not empty specifies the action name to be executed for building a dynamic link librar
279. tata chee E chee Deets E ENAA castiete 14 Chiapter 3 Building Variants oneer eeno e e e EE ETE E A EEE a e e 14 DIELE OA A E EE di ias 14 Two CHOICES anna ieee a a A ti ad sio 15 Chapterios Using Python siessen aaan e E A E AENA EO EEEE EE EERE 17 AO E RN NN 17 Condition a de e es od Us 17 A E RT NN 18 O NN NR 18 NS A RR RN 19 Expressions fot Files corintio E siii ion 19 Burther REA ai 20 Chapter 7 Version Control With CVS essesi erek see D eE E E EE ERER EERE ENEE NEN En 20 Downloading CHE CKOUt niies nena i a ieod eenaa iiaeie iah 21 Getting Past A Firewall none os ices eect rei ahd aaaea aE TEE Sade ean Gime aa es eaten aai 21 Uploading Checkin reniri neniesa Ae Ne A ee a eT A de 22 PUrtherR Gadi Se e e e de a ds e id 22 Chapter S Filetypes and ACt oni cidcid Inia EAE a 22 A New Types0k Filete tas beg e E EEVEE E E EEEE aE E E E e AT 22 Defining a Filetype by SUf ni a taa 23 Defining a Compile Acton ticas eii EEAS 24 Another Useof ElletypEs icon n a a a E a E S r E E Aa Ea Ae ai esa Tiia 24 Chapter 9 More Than One Recipe srianan beet aent EErEE E Ta nE OI eE A NED KEDE aTa EES 25 CATS a EE NN 25 SHANA SEU Seerne e EE E E e EE da 26 A A P Recipe Executive Table of Contents Tutorial Executing ARE ni ada 28 F tching aReciDE estilistas sia 28 Chapter 10 Commands in a PIDE oscar vvccceccuedcanss Hacecusscsens rias tias 29 Changing a timestamps oca aise no Etip TEE a oa na Ean aaa ied Sade Maan ian Gees 29 Creating a
280. ten used to configure C programs to be able to compile them on any Unix system This section explains how to use autoconf with Aap in a nice way An alternative is to use the conf command of Aap It is much easier to use and also works on non Unix systems See Chapter 23 Automatic Configuration Running The Configure Script A recipe that uses the configure script that autoconf generates can start like this SEDER Contkgu la IDR come aleja 8 configure config arg config h in config aap in SVS o COnirigure ri lezsrring ecimeLe ace move force config h config aap config log config cache config status BDIR COME LE GEG 2 touch exist config arg update SBDIR config aap include SBDIR config aap What happens here is that the config aap target is updated before any of the building is done This is required because running the configure script will generate or update the config aap file that influences how the building is done Remembering Configure Arguments The arguments for configure are stored in the config arg file This makes it easy to run configure again with the same arguments The file is read with the file2string function There should be a config txt file that explains all the possible configure arguments with examples that can be copied into config arg Example Select the library to be used for terminal access When omitted a series of libraries will be tried Useful values with tlib curses
281. tes KNotesIface h filetype stub var_LTOBJSUF _stub lo 5 knotes knotes factory cc Here we see a libtool library that is not installed line 1 which must be linked with an additional library line 2 All of the sources are compiled with an extra include directory line 3 The first source file line 4 has additional complications and uses a different compile action due to its filetype The last source file line 5 is compiled with normal flags extended only by the source global attribute on line 3 Rules And Dependencies When a target is to be build Aap first searches for an explicit dependency with build commands that produces the target This dependency may come from a high level build command such as_ program When such a dependency is not found then the rules defined with_rule are checked 1 All the matching rules without commands are used but only if the source already exists Thus this cannot be used to depend on a file that is still to be created 2 One rule with commands will be selected in this order of preference A rule for which the sources exist A rule for which one of the sources does not exist and was not defined with the sourceexists option If there are multiple matches the rule with the longest pattern is used Thus if you have these two rules rule test html test in do something Seve Solace 5460 do something else The first one will be used for a file test foo html the second
282. th are missing this is an error When a file didn t change since the last time it was published it won t be published again This works with signatures like building a target The remote file is the target in this case But Aap won t read the remote file to compute the signature it will remember the signature from when the file was last uploaded otherwise checking for outdated files would be slow In the example file is used This is replaced with the name of the file being published including the directory This means you can use the same attribute for several files Files myfile yourfile hisfile attr publish ftp ftp my org upload file Files publish Files Including the directory is sometimes not what you want To only use the last part of the path use basename Files one myfile two yourfile three hisfile attr publish ftp ftp my org common basename Files publish Files wow The three files will be uploaded to the common directory The directory names one two and three will not be used on the ftp server To publish all files with a publish attribute start Aap like this aap publish If the publish target is defined explicitly it will be executed Otherwise all files with the publish attribute are given to the publish command just like using the_ publishall command The publish attribute may consist of several items Publishing will use all these items This means a file can be d
283. than copying distribution and modification are not covered by this License they are outside its scope The act of running the Program is not restricted and the output from the Program is covered only if its contents constitute a work based on the Appendixes 185 A A P Recipe Executive Program independent of having been made by running the Program Whether that is true depends on what the Program does 1 You may copy and distribute verbatim copies of the Program s source code as you receive it in any medium provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty keep intact all the notices that refer to this License and to the absence of any warranty and give any other recipients of the Program a copy of this License along with the Program You may charge a fee for the physical act of transferring a copy and you may at your option offer warranty protection in exchange for a fee 2 You may modify your copy or copies of the Program or any portion of it thus forming a work based on the Program and copy and distribute such modifications or work under the terms of Section 1 above provided that you also meet all of these conditions a You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change b You must cause any work that you distribute or publish that in whole or in part contains or is de
284. the action name to be executed for compiling a C file into an object dllobject libobject or Itobject file See Chapter 30 Customizing Default Tools When not empty specifies the action name to be executed for compiling a C file into an object dllobject libobject or Itobject file See Chapter 30 Customizing Default Tools List of directories to search for cached downloaded files Default for Unix var aap cache aap cache 128 CACHEUPDATE CC CFLAGS CHILDDIR CLEANDIRS CLEANFILES CLEANMOREDIRS CLEANMOREFILES COMPILE_ACTION CONFDIR CONFMODE CPPFLAGS CVS CVSCMD CXX CXXFLAGS CXXSHLINK CXXSHLINKFLAGS user conf user Aap auto auto user user conf Aap Aap user conf user conf user conf user Chapter 35 Common Variables A A P Recipe Executive aap cache For MS Windows OS 2 HOME aap cache aap cache Directories that don t exist are skipped When using a relative name it is relative to the current recipe Thus the recipe specified with child dir main aap uses a different cache directory When this variable is set currently cached files are flushed Otherwise this only happens when exiting Thus this command can be used to flush the cache CACHEPATH SCACHEPATH Timeout after which cached files may be downloaded again For the possible values see the_explanation in the user manual Command to execute the C compiler def
285. the maintainer of a project and want to distribute your latest changes so that others can obtain the software with a recipe as used above This means you need to checkin your files to the CVS server This is done by listing the files that need to be distributed and giving them a commit attribute Example CVSUSER_FOO johndoe CVSROOT ext SCVSUSER_FOO cvs foo sf net cvsroot foo Files main c common h version c lacie commit eves SOS ROO MES EES Write this as cvs aap and run aap f cvs aap revise What will happen is 1 Files that you changed since the last checkin will be checked in to the CVS server 2 Files that you added to the list of files with a commit attribute will be added to the CVS module 3 Files that you removed from the list of files with a commit attribute will be removed from the CVS module This means that you must take care the Files variable lists exactly those files you want to appear in the CVS module nothing more and nothing less Be careful with using something like c it might find more files that you intended Note This only works when the CVS module was already setup Read the CVS documentation on how to do this The A A P user manual has useful hints as well In the example the CVSUSER_FOO variable is explicitly set thus this recipe only works for one user Better is to move this line to your own default recipe e g aap startup default aap Then the above recipe does not expl
286. the target for which the commands are executed It is one of the items in target match For a rule the string that matched with Example Cote warlietetoyaill e print building Starget Variables In Build Commands 126 A A P Recipe Executive PRO coc O print building target from source Results in building doit virtual 1 building prog from main file c Note that quoting of expanded var depends on the command used The Python lists source_list and target_list can be used to loop over each item Example SOUR g TOO TE for item in target_list print source gt item Note the difference between source and depend source only contains real files depend also contains virtual dependencies The list of dictionaries can be used to access the attributes of each item Each dictionary has an entry name which is the file name of the item Other entries are attributes Example ao alone Checks maS print sourcelist 0 name sourcelist 0 check Results in file c md5 Chapter 35 Common Variables This is a complete list of the variables that are currently used inside Aap except the variables specifically used for porting see Chapter 22 Porting an Application for that This list will be extended when more features are being added To avoid the problem that your own variables interfere with the use of common Aap variables do not use variable names with only upper case letters Suggeste
287. tions to Aap about how to compile this program are very short Instructions for Aap are stored in a file with the extension aap Such a file is called a recipe This is the recipe for compiling such a program with Aap program hello hello c Write this text in a file main aap in the same directory as hello c Now invoke Aap to compile hello c into the program hello 1s hello c main aap aap 1 Aap Creating directory home mool tmp build FreeBSD4_5_ RELEASE 2 Aap cc I usr local include g 02 E MM hello c gt build FreeBSD4_5_RELEASE hello c aap 3 Aap cc I usr local include g O2 c o build FreeBSD4_5_RELEASE hello o hello c 4 Aap cc L usr local lib g O2 o hello build FreeBSD4_5_RELEASE hello o Chapter 2 Compiling a Program 4 A A P Recipe Executive You see the commands Aap uses to compile the program 1 A directory is created to write the intermediate results in This directory is different for each platform thus you can compile the same program for different systems without cleaning up 2 Dependencies are figured out for the source file Aap will automatically detect dependencies on included files and knows that if one of the included files changed compilation needs to be done even when the file itself didn t change In this example Aap uses the C compiler with the MM option to determine the included files 3 The hello c program file is compiled into the hello o object file
288. tries are attributes Wildcards in expr are expanded See_var2dictlist for not expanding wildcards Example soeces Cilek rore ELSA miles for item in expand2dictlist source if item get force print forced item item name expand2list expr Turns a variable with a string value into a list of items Attributes are discarded Delayed evaluation is taken care of Wildcards in expr are expanded See_var2listQ for not expanding wildcards Example source filel file2 file3 for fname in expand2list source sys prog fname expand2string expr Expand wildcards user and user in expr Returns the expanded string expr is handled as a list of items white space is collapsed into a single space file2string fname dict None Reads the file fname and concatenates the lines into one string Lines starting with a are ignored One space is inserted in between joined lines other white space including CR and VT at the start Alphabetical list of Python functions 149 A A P Recipe Executive and end of a line is removed When fname doesn t exist or can t be read an error message is given and an empty string is returned Aap does continue with the following commands dict is used to obtain the value for MESSAGE The default is None To avoid the error message for a not existing file use something like this foofile file2string foo MESSAGE get_attr name
289. uotes or backslashes var aap quoted using and or where required no backslashes var quoted with doubled for a literal var special characters escaped with a backslash Chapter 34 Variables and Scopes 121 A A P Recipe Executive var depends on the shell either like var or var In most places var is expanded as var with attributes using and for quoting The exceptions are SyS var no attributes shell quoting n in v n var no attributes no quoting del var no attributes normal quoting The quoted variables don t handle the backslash as a special character This is useful for MS Windows file names Example PIO Velie enibe ie sprint source Results in dir file 1 c Be careful with using var and quotes you may not always get what you wanted RC style expansion RC style expansion means that each item in a variable is concatenated to the item immediately before and after the variable Example var one two three gamine Grge veue Results in dir one dir two dir three For the expansion the variable is used as a list of white separated items Quotes can be used to include white space in an item Use double quotes around a single quote and single quotes around a double quote Escaping the meaning of quotes with a backslash is not supported When using rc style expansion of a variable that is empty the result is empty Example aa prine lola Saa
290. upports it Convention Always use Iname the tools will translate it into the flags that the linker actually uses Suffix for a libtool library Default value la Sub directory to install man pages into Default value man Note that Aap will append man1 man2 etc when installing manual pages Mode to use for installed man pages Default value 0644 read write for the user readable for the group and others Comma separated list of message types which are printed Possible values note note message warning warning message error error message system executed system command result result of sys command info informational message extra extra informational message changedir changing directories depend message about dependencies all all messages Default value error warning system info When the_ s or_ silent option is used error When the v or verbose option is used all possible values Instead of removing print from MESSAGE it is possible to use the log command to write text to the log file Suffix for an object file Default value o for Unix obj for MS Windows A number from zero to nine Zero means no optimization nine means maximum optimization The default is two For an example see the tutorial The name of the operating system and its version on systems that support it For instance FreeBSD 4 9 gives SOSNAME the value 132 SOSTYPE PAINTER PREFIX
291. utive Finally the do checksum target is defined This part was not typed but added to the recipe with aap makesum This is done by the port recipe maintainer when he has verified that the files are correct When a user later uses the recipe Aap will check that the checksums match so that problems with downloading or a cracked distribution file are found and reported Using CVS The port recipe specifies which source files and patches to download thus it has to be adjusted for each version This is good for a stable release but when you are releasing a new version every day it is a lot of work Another method is possible when the files are available from a CVS server Adding these lines to the recipe will do it CVSROOT pserver anonymous cvs vim sf net cvsroot vim CVSMODULES vim CVSTAG vim 6 1 S LASTPATCH The first line specifies the cvsroot to use This is specific for the cvs program CVSMODULES is the name of the module to checkout Mostly it is just one name but you can specify several Specifying CVSTAG is optional If it is defined like here a specific version of the application is obtained When it is omitted the latest version is obtained Much more about the port recipe can be found in Chapter 22 Porting an Application Using CVS 35 User Manual Table of Contents 12 How it all works 13 Dependencies Rules and Actions 14 Variants 15 Publishing 16 Fetching 17 Installing 18 Version Contr
292. utput the target of the action use a filetype attribute on the action name do convert filetype html filename filetype text Multiple filename arguments can be used do action filel file2 file3 For some actions a target can or must be specified This is done as an attribute on the action name do convert target outfile infilel infile2 Attributes of the input filenames other than filetype are not used to select the action that will be executed The async attribute can be used to start the application without waiting for it to finish However this only works for system commands and when multi tasking is possible Example do email async remove to piet subject done building logmessage The remove attribute specifies that the files are to be deleted after the command is done also when it fails wow When the filetype contains a _ and no action can be found for it the search for an action is done with the part before the _ This is useful for specifying a variant on a filetype where some commands are different and the rest is the same action is usually one of these Executing Actions 100 A A P Recipe Executive view Look at the file The readonly attribute is normally set it can be reset to allow editing edit Edit the file Send the file by e mail Relevant attributes edit edit before sending email t subject subject of the message to destination build Build the file s
293. w the log of each variant that was build Running Autoconf For a developer there also needs to be a method to generate the configure script from configure in This needs to be done even before configure is run Prepending this to the example above should work configure signfile mysign configure in sys autoconf Normally the configure script is distributed with the program so that a user does not need to install and run autoconf The signfile mysign attribute on the target is used to avoid running autoconf when the user builds the program and the configure and configure in files are still as they were distributed The signatures in the mysign file which you must include in the distribution will match and Aap knows that configure is up to date If using the mysign file was omitted there would be no signature for the configure target and Aap would decide to run autoconf When you change configure in its signature will be different from what is stored in mysign and autoconf will be run Using A Distributed Configure Script If you are porting an application that already has a configure script you can filter it to make it work with Aap This means you can use the unmodified configure in configure_aap configure cat configure eval re sub Makefile config aap stdin gt configure_aap chmod 755 configure_aap Now you need to execute configure_aap instead of configure in the first example
294. ware Foundation s software and to any other program whose authors commit to using it Some other Free Software Foundation software is covered by the GNU Library General Public License instead You can apply it to your programs too When we speak of free software we are referring to freedom not price Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software and charge for this service if you wish that you receive source code or can get it if you want it that you can change the software or use pieces of it Appendixes 184 A A P Recipe Executive in new free programs and that you know you can do these things To protect your rights we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the software or if you modify it For example if you distribute copies of such a program whether gratis or for a fee you must give the recipients all the rights that you have You must make sure that they too receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two steps 1 copyright the software and 2 offer you this license which gives you legal permission to copy distribute and or modify the software Also for each author s protection and ours we want to
295. written entirely by you rather the intent is to exercise the right to control the distribution of derivative or Appendixes 186 A A P Recipe Executive collective works based on the Program In addition mere aggregation of another work not based on the Program with the Program or with a work based on the Program on a volume of a storage or distribution medium does not bring the other work under the scope of this License 3 You may copy and distribute the Program or a work based on it under Section 2 in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following a Accompany it with the complete corresponding machine readable source code which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange or b Accompany it with a written offer valid for at least three years to give any third party for a charge no more than your cost of physically performing source distribution a complete machine readable copy of the corresponding source code to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange or c Accompany it with the information you received as to the offer to distribute corresponding source code This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such
296. ww outtypes me intypes moo defer_var_names BUILDME_ACTION This defines an action almost like this action command action buildme primary me moo if _no get BUILDME_ACTION do SBUILDME_ACTION target target source else sys me lt source gt Starget An important difference is that when the action defined with BUILDME_ACTION supports different input and output filetypes the action defined with define_action will use these The action defined with action will always support me and moo even though the actually used BUILDME_ACTION action supports different types More info about the define_action function in the reference manual Chapter 29 Customizing Automatic Depedencies For various file types A A P can scan a source file for header files it includes This implies that when a target depends on the source file it also depends on the header files it includes For example a C language source file uses include lines to include code from header files The object file generated from this C source needs to be rebuilt when one of the header files changes Thus the inclusing of the header file has an implied dependency Aap defines a series of standard dependency checks You don t need to do anything to use them The filetype used for the dependency check is detected automatically For files with an ignored suffix like in and gz no dependency checking is done To avo
297. y they are not concatenated like with_ cd A mode attribute on a directory can be used to specify the protection flags for the new directory Example mkdir r secret dir mode 0700 Alphabetical list of Commands 168 A A P Recipe Executive The default mode is 0644 The effective umask may reset some of the bits though options Don t fail when a directory already exist still fails when it is not a directory or could Ley lores not be created q quiet don t report created directories to Also create intermediate directories not just the deepest one recursive Note automatic creation of directories can be done by adding the directory attribute to a source item mkdownload name file Generate a recipe name that downloads the specified files Each file must have a fetch attribute which is used in the generated recipe When the file name already exists it is overwritten without warning Wildcards in file are expanded Not in name MDS checksums are generated and used in the recipe to fetch a file only when the checksum differs Example of one item file foobar txt Qif get_md5 file ad5dba5bce69918c040703e9b8eb35f1d said esicein Es toy icles prlde Seale When there is a fetch attribute on name this will be used to add a_ recipe command at the start of the generated recipe move option from to Move files or directories Mostly like_ copy except that the
298. y from object files compiled by a D compiler A buildaction attribute on one of the object files is used before D_BUILDDLL_ACTION See_Chapter 30 Customizing Default Tools When not empty specifies the action name to be executed for building a static library from object files compiled by a D compiler A buildaction attribute on one of the object files is used before D_BUILDLIB_ACTION See_Chapter 30 Customizing Default Tools When not empty specifies the action name to be executed for building a program directly from D source See_Chapter 30 Customizing Default Tools When not empty specifies the action name to be executed for building a dynamic link library directly from D source See_Chapter 30 Customizing Default Tools When not empty specifies the action name to be executed for building a static library directly from D source See_Chapter 30 Customizing Default Tools Compiler arguments passed to the D compiler Arguments passed to the linker in most cases libraries to link with Import directories used for the D compiler Always use the Ipath form and don t use it for other switches A A P will convert it to what the compiler actually uses This variable is also used when checking for dependencies Version arguments passed to the D compiler Always use the version form the tool will convert it to what the compiler actually uses Debug arguments passed to the D compiler Always
299. za gt The first example line shows how to retrieve an environment variable by using Python s built in os environ module The second shows how you can use Python to compute something within an Aap recipe It doesn t do anything useful but it uses Python to compute the value L374 and then Aap assigns that value to the variable label Note Using environment variables is probably not portable Conditionals When a recipe needs to work both on Unix and on MS Windows you quickly run into the problem that the compiler does not use the same arguments Here is an example how you can handle that 11 Est OSI Yogs 2 INCLUDE I usr local include 3 else 4 INCLUDE Ic vc include 5 6 alils 7 PRINCE UD ERES TES TEINS Tj WDE The first and third line start with the CE character This means a Python command follows The other lines are normal recipe lines You can see how these two kinds of lines can be mixed The first line is a simple if statement The OSTYPE variable is compared with the string posix If they compare equal the next line is executed When the OSTYPE variable has a different value the line below Chapter 6 Using Python 17 A A P Recipe Executive else is executed Executing this recipe on Unix aap INCLUDE is I usr local include OSTYPE has the value posix only on Unix and Unix like systems Executing the recipe on MS Windows where OSTYPE ha

PDF version

Contents

Download Pdf Manuals

Related Search

Related Contents