== Features and Benefits ====== File History ==Introduction==OpenGrok analyzes CVS versioning histories is a source code searcher similar in idea to MXR. It is very advanced and written in order Java. It uses Apache Lucene to get build a search database for a source code tree. This tool is perfect for the versionsnew mercurial repository as it has built in hg repo parsing. There is only version number searching capability I think: you can't use, for example, FIREFOX_3_1b1_RELEASE in the History box. OpenGrok currently does not If there is interest in Mozilla adopting this program, I'd be willing to write support branching properlyfor it. I'd also like to customize the look and feel for the Mozilla web sites. I have a list of things to do in my script.
[[OpenGrok/script|The Script]]
[http://blogs.sun.com/chandan/entry/releasing_opengrok_0_3_subversion Blog about OpenGrok] that explains file history better==Setup==Setting this up is fairly easy if you know your way around a unix shell. This means that it is not really the best choice to use the CVS history information for indexing mozilla code because the history tracker You will just use need the newest version of the filefollowing tools:* JDK 1.5+* Servlet container - JBoss, Glassfish, not the branch that it is inTomcat, thusJetty, It would be a wise course of action to have either one opengrok webpp for each branch or have one opengrok with all versions in itetc.* Exuberant Ctags* Mercurial* Basic unix programs: sed, zip, unzip, nice, bash
==== Extendable ====If there are files which cannot be analysed by the included analysers, OpenGrok allows the user to develop their own analysers, I am unsure of whether or not there is a JavaScript analyser allready, maybe even an XPCOM/XUL analyser could be written, but I don't know assuming you have set up all the first thing about XPCOM/XUL so this maybe allready implemented in another languagerequired applications installed and configured.
==== In File Linking ====The indexer hyperlinks all symbols You are going to need to download the file opengrok binary release tarball from [http://opensolaris.org/os/project/opengrok/ OpenGrok]. Untar it (tar zxf opengrok-0.7.tar.gz) and line number make note of their declarationthe directory you put it in. If Next you will configure the symbol is following variables in multiple files it shows a list of all files which have itmy script:<pre>#Mercurial Repository to useREPO=http://hg.mozilla.org/mozilla-central <-- Change to your HG Repo
#Base directory for contentsBASEDIR==== Integrates Well ====The header /home/jhford/mozilla <-- This is the base directory for the OpenGrok data files and footer are completely customizable. OpenGrok could be integrated with the current MDC.HG repo
#This is the name of the data directory for OpenGrokDATADIR== Example Implementation ==[http://cvs.opensolaris.org/source/ OpenSolaris]data-dir <-- This is the folder *name* for opengrok's data
== Installation Procedure ==#This is the name of the source directory for OpenGrokSRCDIR==== Notes ====I will be listing notes src-dir <-- This is the folder *name* for my own reference, feel free to use themopengrok's copy of HG code
==== Steps ====* Install Ubuntu Linux as a server from the Ubuntu DVD* Install the following packages #OpenGrok install path - ctags -> exuberant-ctagsWhere is opengrok.jar? - sun-java5-jdk - tomcat5 tomcat5-admin tomcat5-webapps - Installs GNU Java which must be removed -make -CVS* Run OGDIR="sudo update-alternatives --config java" and "apt-get remove --purge java-gcj-compat"* Change the tomcat5 config (/etchome/defaultjhford/tomcat5) to point to the new default Java runtime (opengrok/usr/lib/jvm/javaopengrok-10.57" <-- this is where the OpenGrok tarball files ended up.It is likely where you ran "tar zxf opengrok-0-sun/) and disable the security manager, until that can be figured out* Setup a Mozilla code directory (mkdir /var/mozilla)* Follow guide at the [http://www.opensolaris7.tar.org/os/project/opengrok/manual OpenSolaris Project Guide]* Enjoy!gz"
#OpenGrok source.war from opengrok tarball
OGCONTEXT="grokzilla" <-- this variable defines the grokzilla in http://china:8080/grokzilla
OGWAR="${OGCONTEXT}.war" <-- Likely, you will never need to change this
==== Important Info ====* /var/lib/tomcat5 is the default $CATALINA_HOME for Ubuntu, but Ubuntu#Your application server's packages are non-standard.war deployment directory* WEBAPPDIR="/etchome/defaultjhford/tomcat5 has some configuration files* My SRC_ROOT is tomcat/varapache-tomcat-6.0.18/mozilla* My DATA_ROOT webapps" <-- This is where your app server's war deployment folder is /var/opengrok/data* My run.sh uses a ctags at /usr/bin/ctags not or where you want the default in the run.shresulting war file* Setting up the Admin webapp [http://www.onjava.com/pub/a/onjava/2003/06/25/tomcat_tips.html here]<pre>
* [Then run the script and notice that you have opengrok! It will likely show up at http://blogs.sun.com/chandan/entry/releasing_opengrok_0_3_subversion Blog about OpenGrok]* [httplocalhost:8080//www.opensolaris.org/jive/thread.jspa?threadID=8934&tstart=30 Usefull topic for history info] ==Requirements==* be able to start/stop tomcat5/5.5 init.d script* write access to $catalina.home/webapps/* write access to tomcat5/5.5 configuration files* have a non-home folder writable, personal preference for /var/mozilla* Tomcat5 or 5.5* Sun Java JRE and JDK 1.5.0 * CTags* CVS and Subversiongrokzilla
