Open main menu

CDOT Wiki β

Changes

OpenGrok

948 bytes removed, 09:35, 9 November 2006
m
no edit summary
== Introduction ==
OpenGrok is the source browser in use by the OpenSolaris community. It uses Java Servlets running on Java5
 
 
==Idea's==
Opengrok has 2 major componenets. Opengrok.jar is a system independant Java Application that will index source code, which can then be viewed with its own internal client, or sent onto a Java Servlet for internet usage. Source.war is the servlet that actually serves up the information. <insert information when i feel like doing so>
== Features and Benefits ==
==== File History ==== OpenGrok maintains code version history. I am currently unsure of whether it looks at the analyzes CVS versioning information or whether it compares files between indexes. There is also options for many diffs and comparing different, non-concurrent histories in order to get the versions.[http://cvs.opensolaris.org/source/history/on/usr/src/uts/sun/io/eri OpenGrok currently does not support branching properly.c Example] After a little looking at the OpenSolaris OpenGrok, it seems that the version histories are more Wiki style than CVS style, so they are arbitrary
==== Integrates Well ====
The header and footer are completely customizable. OpenGrok could be integrated with the current MDC potentially. The header and footer are implemented through a variable which holds the copmlete html of the header and footer.
== Example Implementation ==
- tomcat5 tomcat5-admin tomcat5-webapps
- Installs GNU Java which must be removed
-make (using 3.81, may need 3.80)
-CVS
* Run "sudo update-alternatives --config java" and "apt-get remove --purge java-gcj-compat"
==== Important Info ====
* /var/lib/tomcat5 is the default $CATALINA_HOMEfor Ubuntu, but Ubuntu's packages are non-standard
* /etc/default/tomcat5 has some configuration files
* My SRC_ROOT is /var/mozilla
* My DATA_ROOT is /var/tmpopengrok/opengrok_datadata* My run.sh uses a ctags at /usr/bin/ctags not the default* File permissions need to be changed [http://tomcatin the run.apache.org/tomcat-5.0-doc/security-manager-howto.html this may help]sh
* Setting up the Admin webapp [http://www.onjava.com/pub/a/onjava/2003/06/25/tomcat_tips.html here]
* [http://blogs.sun.com/chandan/entry/releasing_opengrok_0_3_subversion Blog about OpenGrok]
* [http://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 $catalinecatalina.home/webapps/* wtite write access to tomcat5/5.5 configuration files
* have a non-home folder writable, personal preference for /var/mozilla
* Tomcat5 or 5.5
1
edit