Changes between Version 2 and Version 3 of BuildingBase

Timestamp:

Jun 15, 2011, 12:08:17 PM (13 years ago)

Author:

Nicklas Nordborg

Comment:

Finished the Building BASE page

BuildingBase

@@ -5 +5 @@
 
 
-== Getting the source code ==
+== 1. Getting the source code ==
 
 === Download ===
@@ -19 +19 @@
 This will create a sub-directory `base-src` with all source files. Anonymous checkouts are allowed, but write permission is only granted to developers. The trunk version is the head of the development and should be used for testing purposes only. The sub-urls to `http://base.thep.lu.se/svn/branches/*` and `http://base.thep.lu.se/svn/tags/*` can be used to get other version, including specific releases and bugfix branches. For more information see the DownloadPage or check the [/browser subversion source repository] directly. 
 
+== 2. Create a local configuration ==
+
+The configuration files included with a binary distribution are located in the `<base-src>/config/dist` directory. You should never modify these files directly for your local setup. Instead, place a copy of files that you need to modify in the `<base-src>/config/local` directory. When building BASE all targets exception the 'dist' target will first check the local configuration files. 
+
+Note that the build process usually copies the configuration files to the `<base-src>/www/WEB-INF/classes` directory. The reason is that Tomcat can't read files outside the `WEB-INF` directory and this makes the subversion working copy identical to a binary distribution.
+
+ * All utility programs, such as the installation program and the job agent, use the configuration files in `<base-src>/www/WEB-INF/classes`.
+ * The only exception is the test programs. They will read the configuration from `<base-src>/config/local` and `<base-src>/config/dist` directories.
+ * Running `ant clean` will remove the copied configuration files.
+ 
+== 3. Ant ==
+
+We use [http://ant.apache.org/ Ant] to build and compile BASE. You will need at least version 1.8. All build instructions for Ant are in the build.xml file.
+
+A build is started with the command: 
+
+{{{ ant <target> }}}
+
+where `<target>` is one of the named targets defined in the build file. You may specify multiple targets:
+
+{{{ant web jobagent}}}
+
+=== Main build targets ===
+
+These targets works on the entire BASE source code. They may take some time to finish, but everything will be checked and recompiled if needed.
+
+`ant dev`
+    Build everything for local use. This targets compiles the core, plugins, web application, job agent, etc. for local use. It doesn't generate javadoc documentation. 
+
+`ant dist`
+    Build everything for distribution. This target compiles everything, generates the javadoc documentation, etc. Everything is placed in the dist subdirectory. 
+
+`ant package`
+    Create compressed tar files of the distribution. 
+
+`ant clean`
+    Remove all generated files. 
+
+=== Other useful targets ===
+
+These targets are quicker to use if you know that you have only made changes to a specific module.
+
+`ant core`
+    Compile the core for local use. 
+
+`ant coreplugins`
+    Compile the core plugins for local use. 
+
+`ant web`
+    Compile the web client application for local use. 
+
+`ant installprg`
+    Compile the installation programs for local use. 
+
+`ant jobagent`
+    Compile the job agent for local use. 
+
+`ant test`
+    Compile the test programs for local use. 
+
+`ant doc`
+    Generate documentation for local use. This generates all documentation and may take a long time. 
+
+`ant doc.javadoc`
+    Generate Javadoc documentation only. The documentation is generated in the `<base-src>/doc/api` directory. 
+
+`ant doc.docbook.html`
+    Generate user- and administrator documentation from docbook in HTML format. Docbook will work with pure Java but performance is better if [http://xmlsoft.org/XSLT/ XSLTPROC] is installed. The documentation is generated in the `<base-src>/doc/html` directory. 
+
+== Running BASE from the local installation ==
+
+If you have followed the instructions so far the subversion working copy installation is compatible with a binary distribution. You canfind the installation programs, web application and all other things in the same places as for a binary installation. Read the [/chrome/site/latest/html/admindoc/installation_upgrade/installation_upgrade.html installation instructions] for more information.