| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN"><HTML> | |
| <HEAD> | |
| <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > | |
| <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"> | |
| <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> | |
| <LINK REL="STYLESHEET" HREF="../book.css" CHARSET="ISO-8859-1" TYPE="text/css"> | |
| <title>Feature build configuration</title> | |
| </head> | |
| <BODY BGCOLOR="#ffffff"> | |
| <h3>Build configuration</h3> | |
| <p>The build mechanism is driven by a build configuration. The | |
| build configuration for an individual plug-in, fragment, or feature is found | |
| in a <b> build.properties</b> file for the corresponding element.</p> | |
| <p>PDE project creation wizards generate the <b> build.properties</b> file when | |
| plug-in projects are created. The file contains information on how to compile source folders into | |
| JARs. This information can be indirectly updated in the Runtime page of the | |
| manifest editor. It can also be directly modified using the appropriate editor.</p> | |
| <p>PDE provides a simple editor for the <b> build.properties</b> that has form and source views. | |
| The file itself follows the Java properties format. You need to provide a number of | |
| keys and their corresponding values. Multiple values are separated using a comma | |
| as the delimiter. </p> | |
| <h4>Common properties</h4> | |
| <ul> | |
| <li><b>bin.includes</b> - lists files that will included in the binary version of the plug-in being built;</li> | |
| <li><b>bin.excludes</b> - lists files to exclude from the binary build;</li> | |
| <br> | |
| <li><b>qualifier</b> - when the element version number ends with <b>.qualifier</b> this indicates by which value ".qualifier" must be replaced. The value of the property can either be <b>context</b>, <b><value></b> or <b>none</b>. | |
| Context will generate a date according to the system date, or use the CVS tags when the built is automated. Value is an actual value. None will remove ".qualifier". If the property is omitted, context is used.</li> | |
| <br> | |
| <li><b>custom=true</b> - indicates that the build script is hand-crafted as opposed to automatically generated. Therefore no other value is consulted.</li> | |
| </ul> | |
| <h4>Plug-in specific properties</h4> | |
| <ul> | |
| <li><b>source.<library></b> - lists source folders that will be compiled (e.g. <b>source.xyz.jar=src/, src-ant/</b>). | |
| If the library is specified in your plugin.xml or manifest.mf, the value should match it;</li> | |
| <li><b>output.<library></b> - lists the output folder receiving the result of the compilation;</li> | |
| <li><b>exclude.<library></b> - lists the files that should not be copied into the library by the compiler;</li> | |
| <li> <b>extra.<library></b> - extra classpaths used to perform automated build. Classpath can either be relative paths, or | |
| platform urls referring to plug-ins and fragments of your development environment (e.g. <b>../someplugin/xyz.jar</b>, <b>platform:/plugins/org.apache.ant/ant.jar</b>). | |
| Platform urls are recommended over relative paths;</li> | |
| <li><b>manifest.<library></b> - indicate the file that will be used as a manifest for the library. The file must be located in one of the source folder | |
| being used as input of the jar.</li> | |
| <br> | |
| <li><b>src.includes</b> - lists files to include in the source build;</li> | |
| <li> <b>src.excludes</b> - lists files to exclude from the source build;</li> | |
| <br> | |
| <li> <b>jars.extra.classpath</b> - <b>(deprecated)</b> same effect than extra.<library> except that the entries are applied to all libraries;</li> | |
| <li> <b>jars.compile.order</b> - defines the order in which jars should be compiled (in case there are multiple libraries).</li> | |
| </ul> | |
| <p> The values | |
| defined for these keys ending with "includes" or "excludes" are expressed as Ant "patterns". Standard formats give the expected results. For example, "*<b>.jar</b>" | |
| indicates all jar files in the top level directory. The patterns are not deep by default. If you want to | |
| describe all Java files for example, you should use the pattern "<b>**/*.java</b>". | |
| The pattern "<b>**</b>" matches any number of directory levels. | |
| Similarly, to describe whole sub-trees, use "<b>xyz/</b>". | |
| </p> | |
| <h4>Feature specific properties</h4> | |
| <ul> | |
| <li><b>root</b> - list the files and folders that must be included in the root of the product. The different values supported are: | |
| <ul> | |
| <li><folderName> - a relative path to a folder to be copied;</li> | |
| <li>file:<fileName> - a relative path to a file to be copied;</li> | |
| <li>absolute:<folderName> - an absolute path to a folder to be copied;</li> | |
| <li>absolute:file:<fileName> - an absolute path to a file to be copied;</li> | |
| </ul></li> | |
| <li><b>root.<config></b> - list the files and folders that must be included in the root of | |
| the product when it is built for the specified configuration. config is composed of the three (3) segments of a configuration separated with a dot;</li> | |
| <br> | |
| <li><b>root.permissions.<permissionValue></b> - list the files and folders to chmod to the given value. Reference to folders must ends with a '/';</li> | |
| <li><b>root.permissions.<config>.<permissionValue></b> - list the files and folders to chmod to the given value for a specific configuration. Reference to folders must ends with '/';</li> | |
| <br> | |
| <li><b>root.link</b> - list by pairs (separated by a comma) the files and folders that need to be symbolicly linked. The first entry indicate the source (target in the unix terminology) and the second entry the link name;</li> | |
| <li><b>root.link.<config></b> - a comma separated list of pairs of files and folders that need to be symbolicly linked for a specific configuration. The first entry indicate the source (target in the unix terminology) and the second entry the link name;</li> | |
| <br> | |
| <li><b>generate.feature@<featureId></b> - indicates that the source feature <b>featureId</b> will be the source feature for the feature indicated as value of this property. | |
| The values listed after the first comma indicates elements to be fetched from the repository;</li> | |
| <li><b>generate.plugin@<pluginId></b> - indicates that the source plug-in <b>pluginId</b> will be the source plug-in for the indicated as value of this property.</li> | |
| </ul> | |
| The following example has been extracted from the build.properties of the org.eclipse.platform feature. | |
| <pre>bin.includes=epl-v10.html,eclipse_update_120.jpg,feature.xml,feature.properties,license.html | |
| root=rootfiles,file:../../plugins/org.eclipse.platform/startup.jar,configuration/ | |
| root.permissions.755=eclipse | |
| root.linux.motif.x86=../../plugins/platform-launcher/bin/linux/motif,linux.motif | |
| root.linux.motif.x86.link=libXm.so.2.1,libXm.so.2,libXm.so.2.1,libXm.so | |
| root.linux.motif.x86.permissions.755=*.so* | |
| </pre> | |
| <p > | |
| </p> | |
| </body> | |
| </html> |