Difference between revisions of "OpenGrok"

From CDOT Wiki
Jump to: navigation, search
m (Features)
Line 1: Line 1:
* [http://www.opensolaris.org/os/project/opengrok/ OpenGrok] - This is by far the coolest project I have come across so far.  It uses Java Server Pages, something I know nothing about, so lots of reading.  This is my favorite so far. Example: [http://cvs.opensolaris.org/source/ OpenSolaris].  A good example of how it takes care of versioning is found at [http://cvs.opensolaris.org/source/history/on/usr/src/uts/sun/io/eri.c Example].  I am looking into the "blame" feature required, it seems to track who did the last version of the file.
+
== Introduction ==
 +
OpenGrok is the source browser in use my the OpenSolaris community.  It uses Java Servlets running on Java5
  
 +
== Features and Benefits ==
 +
==== File History ====
 +
OpenGrok maintains code version history.  I am currently unsure of whether it looks at the CVS versioning information or whether it compares files between indexes. There is also options for many diffs and comparing different, non-concurrent versions.[http://cvs.opensolaris.org/source/history/on/usr/src/uts/sun/io/eri.c Example]
  
== Features ==
+
==== Extendable ====
==== History====
+
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 the first thing about XPCOM/XUL so this maybe allready implemented in another language. 
 +
 
 +
==== In File Linking ====
 +
The indexer hyperlinks all symbols to the file and line number of their declaration.  If the symbol is in multiple files it shows a list of all files which have it.
 +
 
 +
==== 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 ==
 +
[http://cvs.opensolaris.org/source/ OpenSolaris]

Revision as of 14:18, 19 October 2006

Introduction

OpenGrok is the source browser in use my the OpenSolaris community. It uses Java Servlets running on Java5

Features and Benefits

File History

OpenGrok maintains code version history. I am currently unsure of whether it looks at the CVS versioning information or whether it compares files between indexes. There is also options for many diffs and comparing different, non-concurrent versions.Example

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 the first thing about XPCOM/XUL so this maybe allready implemented in another language.

In File Linking

The indexer hyperlinks all symbols to the file and line number of their declaration. If the symbol is in multiple files it shows a list of all files which have it.

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

OpenSolaris