build.xhtml revision 477c09a2656e6a2c1075425ad81e61d594164fa9
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<?xml version="1.0" encoding="UTF-8"?>
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews<html xmlns="http://www.w3.org/1999/xhtml">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <head>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <title>How to build {OpenGrok</title>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </head>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <body>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <h1>How to build {OpenGrok</h1>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <p>The easiest way to build (or modify) {OpenGrok is by using
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <a href="http://www.netbeans.org">NetBeans</a>, but you can also build
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein {OpenGrok from the command line.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <h2>Requirements</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <p>You need the following:</p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <ul>
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews <li><a href="http://java.sun.com/javase/downloads/index.jsp">JDK</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 1.6 or higher</li>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <li><a href="http://ant.apache.org/">Apache Ant</a> 1.7.1 or later
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if you don't intend to build using NetBeans</li>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <li>The source code is located in a
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews <a href="http://www.selenic.com/mercurial/wiki/">Mercurial</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein repository</li>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <li>The analyzers are generated from lex by using
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <a href="http://jflex.de/">JFlex</a></li>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </ul>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <h2>Check out the source</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <p>The first thing you need to do is to check out the source code. You
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein might do this from within NetBeans if you have the Mercurial plugin
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews installed, or you can check out the source with the following
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein command:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <pre>hg clone ssh://anon&#64;hg.opensolaris.org/hg/opengrok/trunk</pre>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <h2>Prepare the source for compilation</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <p>Copy <code>JFlex.jar</code> into the <code>lib</code> directory in
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the OpenGrok source. (If you are using NetBeans, you could
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein alternatively add JFlex.jar to Ant's classpath at
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Tools-&gt;Options-&gt;Miscellaneous-&gt;Ant. If you are
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein running Ant from the command line, it should also work if you put
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein JFlex.jar into your <code>~/.ant/lib</code> directory.)
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews </p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <h2>Compile the source</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <p>If you use NetBeans you should be able to open OpenGrok as a project
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews and build it from there. If you want to build from the command line,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein execute the following command:</p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <pre>ant</pre>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <p>If the build is successful, you should now find the
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews binaries under the <code>dist</code> directory.</p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </body>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</html>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein