Revision: 3544
http://vexi.svn.sourceforge.net/vexi/?rev=3544&view=rev
Author: mkpg2
Date: 2009-07-08 16:20:10 +0000 (Wed, 08 Jul 2009)
Log Message:
-----------
Slightly better build documentation.
Modified Paths:
--------------
trunk/core/buildcore/README.txt
Added Paths:
-----------
trunk/core/buildcore/build.conf.txt
Modified: trunk/core/buildcore/README.txt
===================================================================
--- trunk/core/buildcore/README.txt 2009-07-02 18:13:24 UTC (rev 3543)
+++ trunk/core/buildcore/README.txt 2009-07-08 16:20:10 UTC (rev 3544)
@@ -1,55 +1,78 @@
- ++ Overview ++
-This project contains ant code for building the vexi core.
- ++ Building ++
-Run the ant file. You should make sure
- 1) -Xss128m is set (byte code shrinkage needs a large stack)
+++BUILDING++
+ 1) Check out the following projects. Your directory should look like
+ buildcore/
+ org.ibex.crypto/
+ org.ibex.io/
+ org.ibex.js/
+ org.ibex.net/
+ org.ibex.util/
+ org.vexi.core/
+ org.vexi.debugclient/
+ org.vexi.devl/
+ org.vexi.widgets/
+
+ The last 3 are currently required for all builds, but in principal should
+ only be needed if building the 'devl' version of vexi (vexi core with
+ development tools).
+
+ 2) Specify a build.conf, see build.conf.txt for which properties to provide
+
+ 3) Run the build.xml, target 'buildcore'. You should make sure
+ a) -Xss128m is set (byte code shrinkage needs a large stack)
+
+ REMARKS currently only building jar version of vexi is supported. Native
builds
+ are to be added in the future, it is hoped.
+
+
+++BUILDING ECLIPSE WORKSPACE++
+ Vexi has its eclipse project files checked in, to make working with eclipse
+ easy (some people do not approve of this and would consider that a better
+ approach would be to some how generate the project files - not worth the
effort!)
+
+ Same steps 1 and 2, as when building vexi. The directories correspond to your
+ eclipse projects.
+
+ 3) Run the build.xml, target 'src_gen_all'
+
+ REMARK not necessary but nice to have - is workspace refreshing after
+ running src_gen_all. There is a **GOTCHA**: to have the workspace
refreshed
+ it is necessary that ant is run in the same JVM as the workspace.
+ In this mode unexpected problems can arise regarding class file
+ compatability. The easiest away to avoid problems is to make sure that
+ JAVA_HOME is set to a recent JVM (1.5) and eclipse is running on that JVM.
- 2) Also, not necessary but nice to have - is workspace refreshing after
- running src_gen_all. There is a **GOTCHA**: to have the workspace refreshed
-it is necessary that ant is run in the same JVM as the workspace.
-In this mode unexpected problems can arise regarding class file compatability.
-The easiest away to avoid problems is to make sure that JAVA_HOME is set to a
-recent JVM (1.5) and eclipse is running on that JVM.
-The rest of this readme is technical notes on the build process. For upto date
-usage instructions on using the build file please see the vexi wiki:
- http://vexi.sourceforge.net/wiki/index.php/CoreBuilding
+++NOTES++
+ The rest of this readme is technical notes on the build process. For upto
date
+ usage instructions on using the build file please see the vexi wiki:
+ http://vexi.sourceforge.net/wiki/index.php/CoreBuilding
- ++ Organisation ++
-Each project has its own build file which uses shared code in build_shared.ent
-for building the project jar. So long as all dependencies are already built
-the project jar can be built independently using these the project build file.
-The file 'buildcore/build.xml' is for:-
-A) Building the vexi jar
- - fetch projects from svn (if not already available)
- - build all projects
- - create jar
- - (theoretically at least) optimisations/native builds
-B) Generating src_gen code for all projects
+++ORGANISATION++
+ Each project has its own build file which uses shared code in
build_shared.ent
+ for building the project jar. So long as all dependencies are already built
+ the project jar can be built independently using these the project build
file.
+ The following shows the relation ships between the build files ('->' means
+ 'imported by'):-
-
-The following shows the relation ships between the build files ('->' means
-'imported by'):-
-
- build_props.xml -> build_shared.xml -> org.ibex.util/build.xml
+ build_props.xml -> build_shared.xml -> org.ibex.util/build.xml
...
- -> org.vexi.core/build.xml
- -> build.xml
+ -> org.vexi.core/build.xml
+ -> build.xml
-++ Optimization ++
-Had to split the code into two. The mips/nestedvm stuff does not survive
-bytecode shrinkage/modification so we create two jars
- part_opt.jar
- part_noopt.jar
-We only shrink part_opt.jar, then we combine the shrunken output with
-part_noopt.jar
+++OPTIMISATION++
+ Had to split the code into two. The mips/nestedvm stuff does not survive
+ bytecode shrinkage/modification so we create two jars
+ part_opt.jar
+ part_noopt.jar
+ We only shrink part_opt.jar, then we combine the shrunken output with
+ part_noopt.jar
Added: trunk/core/buildcore/build.conf.txt
===================================================================
--- trunk/core/buildcore/build.conf.txt (rev 0)
+++ trunk/core/buildcore/build.conf.txt 2009-07-08 16:20:10 UTC (rev 3544)
@@ -0,0 +1,15 @@
+# This is a model properties file.
+# Copy and rename it build.conf.txt -> build.conf
+# Modify properties as required.
+
+# Version of vexi, if not an official release then give a descriptive name
+version=3.0 trunk development
+
+# Subversion revision number
+# Indicate which branch it is from if not trunk as revision number is not
+# enough in which case to identify the source level
+build=3543
+
+# Defines to be used by the java preprocessor. A comma separated list.
+# Choices: APACHE_HTTP (there is only one choice at the moment)
+jpp.defines=APACHE_HTTP
Property changes on: trunk/core/buildcore/build.conf.txt
___________________________________________________________________
Added: svn:mime-type
+ text/plain
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Enter the BlackBerry Developer Challenge
This is your chance to win up to $100,000 in prizes! For a limited time,
vendors submitting new applications to BlackBerry App World(TM) will have
the opportunity to enter the BlackBerry Developer Challenge. See full prize
details at: http://p.sf.net/sfu/Challenge
_______________________________________________
Vexi-svn mailing list
Vexi-svn@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/vexi-svn
