Dhanaraj M

OpenGrok setup - source code search and cross reference

This tool is very helpful for the developers to search, cross-reference, and navigate the source code. The following steps will explain how to setup this tool.

1. Download OpenGrok package - OSOLopengrok-0.4.pkg (same for Both sparc/x86)
    > Download link
    > pkgadd -d OSOLopengrok-0.4.pkg

2. Download Exuberant Ctags - ctags-5.6.tar.gz
    > Download link
    > Untar/configure/gmake/gmake install

3. Download  apache-TomCat  - apache-tomcat-6.0.13.zip
    > Download link 

4. Configuration steps
    > cp  /opt/OSOLopengrok/source.war   apache-tomcat-6.0.13/webapps/
    > export JAVA_HOME=/usr/java
    > mkdir INDEX
    > java -jar /opt/OSOLopengrok/opengrok.jar
       - Generate Indexes by giving the source path
    > vi apache-tomcat-6.0.13/webapps/source/WEB-INF/web.xml
        - Assign DATA_ROOT and SRC_ROOT dir variables
    > ./apache-tomcat-6.0.13/bin/startup.sh
    > http://localhost:8080/source/xref/
        - Use the above URL to navigate the source code

5. For changing the source directory
    > ./apache-tomcat-6.0.13/bin/shutdown.sh
    > rm -rf INDEX/*
    > Repeat step-4

6. Whenever the machine is restarted
    > ./apache-tomcat-6.0.13/bin/startup.sh

Posted at 08:46AM May 26, 2007 by dhanarajm in Sun  |  Comments[0]