Mercurial > hg > blitz_stable

comparison docs/dev_guide.html @ 0:3dc0c5604566

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial checkin of blitz 2.0 fcs - no installer yet.
author Dan Creswell <dan.creswell@gmail.com>
date Sat, 21 Mar 2009 11:00:06 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:3dc0c5604566
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <head>
4 <title>Blitz Developers Guide</title>
5 <link rel="stylesheet" type="text/css" href="ssl.css" />
6 </head>
7 <body>
8 <h1>Blitz Developers Guide</h1>
9
10 <h2>Building Blitz</h2>
11
12 The build process for Blitz is automated via Ant build scripts. First, ensure that you've installed all the <a href="required_packages.html">required packages</a>.
13
14 <h2>Configuration</h2>
15
16 Edit the following properties in the build.xml file:
17
18 <ul>
19 <li> db_root and bdb - should be configured to point to the location of your Berkeley Db installation and the je.jar respectively.</li>
20 <li> jini_root - should be configured to point to the location of the root of your JINI 2.0 installation</li>
21 <li> jdk_root - should be configured to point to the root of your JDK 1.4.x installation</li>
22 </ul>
23
24 <h2>Basic build</h2>
25
26 <p>For the purposes of this section, I assume you've unpacked the distribution in <code>/home/dan/src/jini/space</code>. First let's compile Blitz: </p>
27
28 <pre>
29 cd /home/dan/src/jini/space
30
31 ant clean compile
32 </pre>
33
34 You can generate javadoc using:
35
36 <pre>
37 ant javadoc
38 </pre>
39
40 Which will place the javadoc in <code>docs/javadocs</code>
41
42 <h2>Creating a distribution</h2>
43
44 <p>The final steps in producing a Blitz distribution are to create the <code>blitz.jar</code>, <code>blitz-dl.jar</code> and <code>stats.jar</code> files. By convention, building <code>blitz-dl.jar</code> entails including all classes the Blitz proxy code is dependent upon including various classes of the JINI starter kit.</p>
45
46 <p>Fortunately, there is an Ant addon task which makes the work of generating the dependencies and building a .jar trivial. The necessary .jar is included in <code>ant_addon</code> and automatically used by the <code>build.xml</code> file (there's no need to install the addon in the Ant lib directory).</p>
47
48 <p>Now we can build the download jar, <code>blitz-dl.jar</code> as follows:
49
50 <pre>
51 cd /home/dan/src/jini/space/
52
53 ant dljar
54 </pre>
55
56 <p>Next up, we create </code>stats.jar</code> which is required to be on the classpath of any client wishing to make use of the <code>StatsAdmin</code> interface.
57
58 <pre>
59 cd /home/dan/src/jini/space/
60
61 ant statsjar
62 </pre>
63
64 <p>Next we create the <code>dashboard.jar</code></p>
65
66 <pre>
67 cd /home/dan/src/jini/space/
68
69 ant dashjar
70 </pre>
71
72 <p>The final step is to create <code>blitz.jar</code> itself:</p>
73
74 <pre>
75 cd /home/dan/src/jini/space
76
77 ant serverjar
78 </pre>
79
80 All the generated <code>.jar</code>'s will be placed in the <code>lib</code> directory.
81
82 <h2>Reducing the risk of RSI</h2>
83
84 You can do all the above with one command:
85
86 <pre>
87 cd /home/dan/src/jini/space/
88
89 ant all
90 </pre>
91
92 <h2>Tools</h2>
93
94 There are several tools available which may prove useful in debugging 'space applications or Blitz itself - see the Tools Section in the <a href="install_guide.html#tools">Install Guide</a>
95
96 <p><div align="center"><a href="../index.html">Back to Documentation</a></div></p>
97 </body>
98 </html>