1.相关工具下载安装
主要有4个工具:Java JDK、opengrok、ctags、tomcat
-
jdk 1.8下载地址:
https://mirrors.tuna.tsinghua.edu.cn/AdoptOpenJDK/8/jdk/x64/windows/
-
opengrok下载地址:
https://mirrors.tuna.tsinghua.edu.cn/arch4edu/x86_64/opengrok-1.4.5-1-any.pkg.tar.zst
-
ctag下载地址:
https://files-cdn.cnblogs.com/files/yaolin1228/ctags2018-1-17.zip
-
tomcat下载地址:
https://mirrors.cnnic.cn/apache/tomcat/tomcat-8/v8.5.59/bin/apache-tomcat-8.5.59-windows-x64.zip
tomcat运行需要配置JAVA_HOME环境变量,打开
正常则表示tomcat正常启动了
2.opengrok配置
步骤1:在opengrok的安装目录,如E:\opengrok,在此目录下新建data目录,然后执行如下命令
java -Xmx4096m -jar E:\opengrok\lib\opengrok.jar -W E:\opengrok\data\configuration.xml -c E:\ctags\ctags.exe -P -S -v -s F:\android10\10 -d E:\opengrok\data
说明:此命令涉及到3个目录,opengrok目录、ctag目录和源代码文件目录,执行时间很长,先做这一步
Tips:
对anroid源代码目录进行index的话,建议把源代码不相关的目录,如prebuild/tests/sdk/device/vendor等删除,能节约很多时间
步骤2:把opengrok安装目录下的\lib\source.war文件,拷贝到tomcat安装目录下的webapps\目录下,可以正常打开如下网址:
http://localhost:8080/source/
步骤3:打开tomcat安装目录下的文件,webapps\source\WEB-INF\web.xml,修改CONFIGURATION的路径,改成opengrok路径下data文件夹里面configuration.xml文件的绝对路径。
<context-param>
<description>Full path to the configuration file where OpenGrok can read its configuration</description>
<param-name>CONFIGURATION</param-name>
<param-value>E:\opengrok\data\configuration.xml</param-value>
</context-param>
当第1步完成后,重新启动tomcat,打开http://localhost:8080/source/,效果如下:
3.opengrok配置多个项目
和前面的配置是一样的,就是把对应的名称,以及代码路径、配置路径修改了一下
- 在apache-tomcat-8.5.59\webapps目录下copy一份source.war,重命名为linux.war
// 没有自动生成的话,则手动解压linux.war到
apache-tomcat-8.5.59\webapps\linux
- 生成Index文件
java -Xmx4096m -jar E:\opengrok\lib\opengrok.jar -W E:\opengrok\linux\configuration.xml -c E:\ctags\ctags.exe -P -S -v -s F:\linux-4.19.142\linux-4.19.142 -d E:\opengrok\linux
- 修改webapps\linux\WEB-INF\web.xml配置文件
<context-param>
<description>Full path to the configuration file where OpenGrok can read its configuration</description>
<param-name>CONFIGURATION</param-name>
<param-value>E:\opengrok\linux\configuration.xml</param-value>
</context-param>