OpenGrok是由Sun的员工开发的用来查阅代码的工具,如果你听说过LXR,那么从界面上来说Opengrok和lxr有点像,如果你用过命令行下面的ctags,那么这个Opengrok和这个功能也有点像,但要更加强大。大嘴牛为了提高自己的效率,就在机器上安装了这么一个软件,所谓“工于善其事,必先利其器”嘛!安装的过程还比较麻烦,所以大嘴牛就在在这里把过程记录下来,希望对各位读者有所裨益。(注意,本文主要讲述的平台是Linux平台;Windows的请绕道;Mac OS X的应该是一直的)
安装Java
这个可以从Sun的主页上找到下载,现在这个玩意儿在Linux做得比较智能了,想到n年前还需要手动设置一些参数,就别提有多麻烦了,不过还是没有到yum install和apt-get那样的方便,不过算是很大的进步了。一般而言,Sun的JDK会被安装到/usr/java/目录。
安装tomcat6
从Apache的Tomcat6网站上下载这个网页上的core包就可以了,deployer的包可以不用下载。下载完了之后解压。这个时候,需要设置一下CATALINA_HOME参数;随后运行./bin/startup.sh就可以了。具体的指令步骤如下:
- wget http://labs.renren.com/apache-mirror/tomcat/tomcat-6/v6.0.26/bin/apache-tomcat-6.0.26.tar.gz
- tar xvfz apache-tomcat-6.0.26.tar.gz
- export CATALINA_HOME=`pwd`/apache-tomcat-6.0.26
- cd $CATALINA_HOME/bin
- ./startup.sh
这时,你可以打开浏览器,浏览http://<ip-of-this-linux-box>:<port-the-default-is-8080>,如果看到有页面出现,就说明你到现在为止还没有lost。呵呵
安装OpenGrok
- wget http://hub.opensolaris.org/bin/download/Project+opengrok/files/opengrok%2D0.9.tar.gz # 下载所需要的文件
- tar xvfz opengrok-0.9.tar.gz
- cd opengrok-0.9
- mkdir -p DATA/data # 建立一个专门的放索引和数据的目录
- ln -sf <src-of-your-repository> `pwd`/DATA/src # 这一步是将你的代码库的内容作为一个src的源,在OpenGrok中有用到。
在bin/OpenGrok文件的头上加上下面的几句话(具体的文件位置需要修改)
- diff --git a/bin/OpenGrok b/bin/OpenGrok
- index 77dfc1c..c1dc462 100755
- --- a/bin/OpenGrok
- +++ b/bin/OpenGrok
- @@ -44,6 +44,13 @@
- # Usage
- #
- +OPENGROK_DISTRIBUTION_BASE=/opengrok-0.9/lib # OpenGrok解压的目录,主要要加上lib
- +OPENGROK_INSTANCE_BASE=/opengrok-0.9/DATA # 前面刚建立的目录
- +EXUBERANT_CTAGS=/usr/bin/ctags # ctags的全部路径
- +JAVA_HOME=/usr/java/jdk1.6.0_20 # JAVA安装的目录
- +OPENGROK_APP_SERVER="Tomcat" # 大嘴牛使用的是Tomcat。Opengrok也支持glassfish。
- +OPENGROK_WAR_TARGET=/apache-tomcat-6.0.26/webapps # tomcat6的webapps目录
- +
- Usage()
- {
- echo 1>&2
然后就可以开始我们正式的工作了。
- ./bin/OpenGrok deploy # 这步将source.war复制到tomcat的webapps目录。
- ./bin/OpenGrok index # 建立索引,第一次的话,慢慢等吧。
当index的步骤完成,将浏览器中指向http://<ip-of-this-linux-box>:<port-the-default-is-8080>/source就可以查询和阅读大嘴牛自己的代码了。
试试看吧!