CVS 使用手冊

  CVS環境初始化
============
環境設定：指定CVS庫的路徑CVSROOT
tcsh
setenv CVSROOT /path/to/cvsroot
bash
CVSROOT=/path/to/cvsroot ; export CVSROOT
後面還提到遠程CVS伺服器的設定：
CVSROOT=:ext:$USER@test.server.address#port:/path/to/cvsroot CVS_RSH=ssh; export CVSROOT CVS_RSH

初始化：CVS版本庫的初始化。
cvs init
一個項目的首次匯入
cvs import -m "write some comments here" project_name vendor_tag release_tag
執行後：會將所有源檔案及目錄匯入到/path/to/cvsroot/project_name目錄下
vender_tag: 開發商標記
release_tag: 版本發布標記
項目匯出：將代碼從CVS庫裡匯出
cvs checkout project_name
cvs 將建立project_name目錄，並將最新版本的原始碼匯出到相應目錄中。這個checkout和 Virvual SourceSafe中的check out不是一個概念，相對於Virvual SourceSafe的check out是 cvs update， check in是cvs commit。

2   CVS的日常使用  
=============
注意：第一次匯出以後，就不是通過cvs checkout來同步檔案了，而是要進入剛才cvs checkout project_name匯出的project_name目錄下進行具體檔案的版本同步（添加，修改，刪除）操作。
將檔案同步到最新的版本：
cvs update
不制定檔案名稱，cvs將同步所有子目錄下的檔案，也可以制定某個檔案名稱/目錄進行同步
cvs update file_name
最好每天開始工作前或將自己的工作匯入到CVS庫裡前都要做一次，並養成“先同步 後修改”的習慣，和Virvual SourceSafe不 同，CVS裡沒有檔案鎖定的概念，所有的衝突是在commit之前解決，如果你修改過程中，有其他人修改並commit到了CVS庫中，CVS會通知你文 件衝突，並自動將衝突部分用
>>>>>>
content on cvs server
<<<<<<
content in your file
>>>>>>
標記出來，由你確認衝突內容的取捨。
版本衝突一般是在多個人修改一個檔案造成的，但這種專案管理上的問題不應該指望由CVS來解決。

確認修改寫入到CVS庫裡：
cvs commit -m "write some comments here" file_name

注意：CVS的很多動作都是通過cvs commit進行最後確認並修改的，最好每次只修改一個檔案。在確認的前，還需要使用者填寫修改注釋，以幫 助其他開發人員瞭解修改的原因。如果不用寫-m "comments"而直接確認`cvs commit file_name` 的話，cvs會自動調用 系統預設的文字編輯器(一般是vi)要求你寫入注釋。
注釋的品質很重要：所以不僅必須要寫，而且必須寫一些比較有意義的內容：以方便其他開發人員能夠很好的理解
不好的注釋，很難讓其他的開發人員快速的理解：比如： -m "bug fixed" 甚至 -m ""
好的注釋，甚至可以用中文: -m "在使用者註冊過程中加入了Email地址校正" 

修改某個版本注釋：每次只確認一個檔案到CVS庫裡是一個很好的習慣，但難免有時候忘了指定檔案名稱，把多個檔案以同樣注釋commit到CVS庫裡了，以下命令可以允許你修改某個檔案某個版本的注釋：
cvs admin -m 1.3:"write some comments here" file_name

添加檔案
建立好新檔案後，比如：touch new_file
cvs add new_file
注意：對於圖片，Word文檔等非純文字的項目，需要使用cvs add -b選項，否則有可能出現檔案被破壞的情況
比如：cvs add -kb new_file.gif
然後確認修改並注釋 
cvs ci -m "write some comments here"

刪除檔案：
將某個源檔案物理刪除後，比如：rm file_name
cvs rm file_name
然後確認修改並注釋
cvs ci -m "write some comments here"
以上面前2步合并的方法為：
cvs rm -f file_name
cvs ci -m "why delete file"

注意：很多cvs命令都有縮寫形式：commit=>ci; update=>up; checkout=>co; remove=>rm;

添加目錄：
cvs add dir_name
查看修改曆史：cvs log file_name
cvs history file_name
查看當前檔案不同版本的區別
cvs diff -r1.3 -r1.5 file_name
查看當前檔案（可能已經修改了）和庫中相應檔案的區別
cvs diff file_name
cvs的web介面提供了更方便的定位檔案修改和比較版本區別的方法，具體安裝設定請看後面的cvsweb使用

正確的通過CVS恢複舊版本的方法：
如果用cvs update -r1.2 file.name
這個命令是給file.name加一個STICK TAG： "1.2" ，雖然你的本意只是想將它恢複到1.2版本
正確的恢複版本的方法是：cvs update -p -r1.2 file_name >file_name
如果不小心已經加成STICK TAG的話：用cvs update -A 解決

移動檔案：檔案重新命名
cvs裡沒有cvs move或cvs rename，因為這兩個操作是先cvs remove old_file_name，然後cvs add new_file_name實現的。

刪除，移動目錄：
最方便的方法是讓管理員直接移動，刪除CVSROOT裡相應目錄（因為CVS一個項目下的子目錄都是獨立的，移動到$CVSROOT目錄下都可以 作為新的獨立項目：好比一顆樹，其實砍下任意一枝都能獨立存活），對目錄進行了修改後，要求其開發人員重新匯出項目 cvs checkout project_name 或者用cvs update -dP同步。

3  CVS Branch：項目多分支同步開發
=============================
確認版本裡程碑：多個檔案各自版本號碼不一樣，項目到一定階段，可以給所有檔案統一指定一個階段裡程碑版本號碼，方便以後按照這個階段裡程碑版本號碼匯出項目，同時也是項目的多個分支開發的基礎。
cvs tag release_1_0
開始一個新的裡程碑：
cvs commit -r 2 標記所有檔案開始進入2.x的開發
注意：CVS裡的revsion和軟體包的發布版本可以沒有直接的關係。但所有檔案使用和發布版本一致的版本號碼比較有助於維護。
在開發項目的2.x版本的時候發現1.x有問題，但2.x又不敢用，則從先前標記的裡程碑：release_1_0匯出一個分支release_1_0_patch
cvs rtag -b -r release_1_0 release_1_0_patch proj_dir

一些人先在另外一個目錄下匯出release_1_0_patch這個分支：解決1.0中的緊急問題，
cvs checkout -r release_1_0_patch
而其他人員仍舊在項目的主幹分支2.x上開發
在release_1_0_patch上修正錯誤後，標記一個1.0的錯誤修正版本號碼
cvs tag release_1_0_patch_1

如果2.0認為這些錯誤修改在2.0裡也需要，也可以在2.0的開發目錄下合并release_1_0_patch_1中的修改到當前代碼中：
cvs update -j release_1_0_patch_1

4 CVS的遠程認證：通過SSH遠端存取CVS
================================
使用cvs本身的遠程認證很麻煩,需要定義伺服器和使用者組，使用者名稱，設定密碼等，而且不安全，因此和系統本地帳號認證並通過SSH傳輸是比較好的辦法，通過在客戶機的/etc/profile裡設定一下內容：
CVSROOT=:ext:$USER@test.server.address#port:/path/to/cvsroot CVS_RSH=ssh; export CVSROOT CVS_RSH
所有客戶機所有本機使用者都可以映射到CVS伺服器相應同名帳號了。
如果CVS所在伺服器的SSH連接埠不在預設的22，或者和用戶端與CVS伺服器端SSH預設連接埠不一致，有時候設定了：
:ext:$USER@test.server.address#port:/path/to/cvsroot 
仍然不行，比如有以下錯誤資訊：
ssh: test.server.address#port: Name or service not known
cvs [checkout aborted]: end of file from server (consult above messages if any)

解決的方法是做一個指令碼指定連接埠轉向（不能使用alias，會出找不到檔案錯誤）：
建立一個/usr/bin/ssh_cvs檔案：
#!/usr/bin/sh
/path/to/ssh -p 34567 "$@"
然後：chmod +x /usr/bin/ssh_cvs
並CVS_RSH=ssh_cvs; export CVS_RSH

注意：port是指相應伺服器SSH的連接埠，不是cvs pserver的連接埠

5  CVSWEB：提高程式員比較檔案修改效率
================================
CVSWEB就是CVS的WEB介面，可以大大提高程式員定位修改的效率:
使用的範例可以看：http://www.freebsd.org/cgi/cvsweb.cgi

CVSWEB的下載：CVSWEB從最初的版本已經演化出很多功能介面更豐富的版本，這個是個人感覺覺得安裝設定比較方便的：
http://www.spaghetti-code.de/software/linux/cvsweb/
下載解包：
tar zxf cvsweb.tgz
把設定檔cvsweb.conf放到安全的地方（比如和apache的配置放在同一個目錄下），
修改：cvsweb.cgi讓CGI找到設定檔：
$config = $ENV{'CVSWEB_CONFIG'} || '/path/to/apache/conf/cvsweb.conf';

轉到/path/to/apache/conf下並修改cvsweb.conf：

修改CVSROOT路徑設定：
%CVSROOT = (
'Development' => '/path/to/cvsroot', #<==修改指向本地的CVSROOT
); 
預設不顯示已經刪除的文檔：
"hideattic" => "1",#<==預設不顯示已經刪除的文檔 
在設定檔cvsweb.conf中還可以定製頁頭的描述資訊，你可以修改$long_intro成你需要的文字 
CVSWEB可不能隨便開放給所有使用者，因此需要使用WEB使用者認證：
先產生 passwd:
/path/to/apache/bin/htpasswd -c cvsweb.passwd user

修改httpd.conf: 增加
<Directory "/path/to/apache/cgi-bin/cvsweb/">
AuthName "CVS Authorization"
AuthType Basic
AuthUserFile /path/to/cvsweb.passwd
require valid-user
</Directory>

CVS TAGS: who? when?
====================
將$Id$ 加在程式檔案開頭的注釋裡是一個很好的習慣，cvs能夠自動解釋更新其中的內容成： file_name version time user_name 的格式，比如：cvs_card.txt, v 1.1 2002/04/05 04:24:12 chedong Exp，可以這些資訊瞭解檔案的最後修改人和修改時間

CVS HOME：http://www.cvshome.org
CVS FAQ：http://www.loria.fr/~molli/cvs-index.html
http://directory.google.com/Top/Computers/Software/Configuration_Management/Tools/Concurrent_Versions_System/
http://cvsbook.red-bean.com/
CVS 命令的卡片：http://www.refcards.com/about/cvs.html