OpenGrok試用in WinXP

轉載自http://www.ptt.cc/bbs/Programming/M.1260550469.A.211.html

如有侵權,請告知,謝謝

http://src.opensolaris.org/source/

 

馬上先試用看看...

 

 

 

我從來沒用過Source Insight

 

之前都是用UltraEdit的ctags湊合著用

 

 

 

http://en.wikipedia.org/wiki/OpenGrok

 

http://hub.opensolaris.org/bin/view/Project+opengrok/

 

很久之前就有聽過OpenGrok

 

只是好像台灣很少人用的樣子

 

今天無聊把它拿來裝裝看

 

發現"Full Text Search"真是強大

 

只要原始檔裡面有的字串都可以幾乎馬上找到

 

還可以結合CVS SVN ...(我沒測試過)

 

客戶端只需使用瀏覽器透過網路大家都可以搜尋瀏覽

 

也許有其他更強大的軟體我沒用過...

 

 

 

文件內所謂簡單安裝方式其實都有點複雜(不要照說明檔安裝會失敗)

 

首先系統要有Java Runtime 1.6以上版本

 

C:\>java -version

 

接著總共需要安裝三個程式

 

Apache Tomcat Windows Service Installer http://ppt.cc/BagT

 

ctags source and binary for Windows http://ppt.cc/js,V

 

OpenGrok binary only http://ppt.cc/~Zjl

 

 

 

首先安裝Tomcat

 

很簡單 一直按下一步就完成

 

安裝完成後會有個Tomcat圖示在右下角系統列

 

此時你應該可以 http://127.0.0.1:8080 連到Tomcat

 

 

 

接下來安裝ctags

 

也很簡單 隨便解壓縮到任意資料夾即完成安裝

 

例如d:\ctags

 

 

 

然後將opengrok-0.8.1.tar.gz解壓縮到任意temp資料夾

 

不要執行run.bat

 

大致上按照EXAMPLE.txt步驟

 

首先建立如下的資料夾結構(例如)

 

d:\opengrok

 

  |-- bin

 

  |-- data

 

  `-- source

 

然後將OpenGrok,opengrok.jar及lib資料夾複製到d:\opengrok\bin

 

然後將你的source file資料夾複製到d:\opengrok\source

 

執行以下指令產生d:\opengrok\data及configuration.xml

 

> cd d:\opengrok\bin

 

> java -jar opengrok.jar -W "d:\\opengrok\\data\\configuration.xml" -P -S -v -s

 

"d:\\opengrok\\source" -d "d:\\opengrok\\data" -c "d:\\ctags\\ctags.exe"

 

注意最後一個參數是你的ctags.exe執行檔位置

 

然後等一段時間會產生index files在d:\opengrok\data

 

P.S.第一次會run比較久 如果run到一半就停掉請重複執行該指令

 

最後應該會顯示"完成"的訊息

 

之後只需要在source資料夾內檔案有變更時再重run該指令即可

 

或是你可以將該指令加入排程

 

 

 

接下來設定Tomcat

 

在C:\Program Files\Apache Software Foundation\Tomcat 5.5\webapps內

 

新增一個名為source的資料夾

 

將OpenGrok解壓縮資料夾內的source.war複製到該新增的source資料夾

 

將source資料夾內的source.war重新命名為source.war.zip

 

然後將該zip檔選擇"解壓縮至此"

 

編輯.\source\WEB-INF\web.xml

 

將/var/opengrok/etc/configuration.xml修改成

 

d:/opengrok/data/configuration.xml

 

然後重新Restart Tomcat

 

也就是在系統列Tomcat圖示上按右鍵選擇Stop然後再Start

 

你現在應該可以使用下面連結開始使用OpenGrok搜尋你的程式碼

 

http://127.0.0.1:8080/source/

 

！！完成！！

 

 

 

可以使用cross reference(xref)直接瀏覽整個OpenGrok內的程式碼

 

 

 

搜尋語法範例

 

a_function_name_with_no_space

 

all these words exist in a file

 

"the whole sentence"

 

"*the middle of sentence*"

 

"Tomcat eat" OR "OpenGrok search"

 

"some_value="

 

某些特殊字元無法被搜尋

 

更多語法說明請參考OpenGrok搜尋網頁上的Help連結

 

 

 

除了source file外其他文字檔也會被建index 例如makefile, shell script ...

 

 

 

如果有新增刪除d:\opengrok\source內資料夾(也就是OpenGrok搜尋網頁上的Project列表)

 

必須重新Restart Tomcat才會生效