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。
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 -kb選項按2進位檔案方式匯入(k表示擴充選項,b表示binary),否則有可能出現檔案被破壞的情況
比如:
cvs add -kb new_file.gif
cvs add -kb readme.doc
如果關鍵詞替換屬性在首次匯入時設定錯了怎麼辦?
cvs admin -kkv new_file.css
然後確認修改並注釋
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/get; 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同步。
項目發布匯出不帶CVS目錄的源檔案
做開發的時候你可能注意到了,每個開發目錄下,CVS都建立了一個CVS/目錄。裡面有檔案用於記錄目前的目錄和CVS庫之間的對應資訊。但項目發布的時候你一般不希望把檔案目錄還帶著含有CVS資訊的CVS目錄吧,這個一次性的匯出過程使用cvs export命令,不過export只能針對一個TAG或者日期匯出,比如:
cvs export -r release1 project_name
cvs export -D 20021023 project_name
cvs export -D now project_name
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
CVS的遠程認證通過SSH遠端存取CVS
使用cvs本身基於pserver的遠程認證很麻煩,需要定義伺服器和使用者組,使用者名稱,設定密碼等,
常見的登陸格式如下:
cvs -d :pserver:cvs_user_name@cvs.server.address:/path/to/cvsroot login
例子:
cvs -d :pserver:cvs@samba.org:/cvsroot login
不是很安全,因此一般是作為匿名唯讀CVS訪問的方式。從安全考慮,通過系統本地帳號認證並通過SSH傳輸是比較好的辦法,通過在客戶機的 /etc/profile裡設定一下內容:
CVSROOT=:ext:$USER@cvs.server.address#port:/path/to/cvsroot CVS_RSH=ssh; export CVSROOT CVS_RSH
所有客戶機所有本機使用者都可以映射到CVS伺服器相應同名帳號了。
比如:
CVS伺服器是192.168.0.3,上面CVSROOT路徑是/home/cvsroot,另外一台開發客戶機是192.168.0.4,如果 tom在2台機器上都有同名的帳號,那麼從192.168.0.4上設定了:
export CVSROOT=:ext:tom@192.168.0.3:/home/cvsroot
export CVS_RSH=ssh
tom就可以直接在192.168.0.4上對192.168.0.3的cvsroot進行訪問了(如果有許可權的話)
cvs checkout project_name
cd project_name
cvs update
...
cvs commit
如果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檔案,假設遠程伺服器的SSH連接埠是非預設連接埠:34567
#!/bin/sh
/usr/bin/ssh -p 34567 "$@"
然後:chmod +x /usr/bin/ssh_cvs
並CVS_RSH=ssh_cvs; export CVS_RSH
注意:port是指相應伺服器SSH的連接埠,不是指cvs專用的pserver的連接埠
CVSWEB:提高檔案瀏覽效率
CVSWEB就是CVS的WEB介面,可以大大提高程式員定位修改的效率:
使用的範例可以看:http://www.freebsd.org/cgi/cvsweb.cgi
CVSWEB的下載:CVSWEB從最初的版本已經演化出很多功能介面更豐富的版本,這個是我個人感覺安裝設定比較方便的:
原先在:http://www.spaghetti-code.de/software/linux/cvsweb/,但目前已經刪除,目前仍可以在本站下載CVSWEB,其實最近2年FreeBSD的CVSWeb項目已經有了更好的發展吧,而當初沒有用FreeBSD那個版本主要就是因為沒有彩色的檔案Diff功能。
下載解包:
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: $Id: cvs_card.html,v 1.5 2003/03/09 08:41:46 chedong Exp $
將$Id: cvs_card.html,v 1.9 2003/11/09 07:57:11 chedong Exp $ 加在程式檔案開頭的注釋裡是一個很好的習慣,cvs能夠自動解釋更新其中的內容成:file_name version time user_name 的格式,比如:cvs_card.txt,v 1.1 2002/04/05 04:24:12 chedong Exp,可以這些資訊瞭解檔案的最後修改人和修改時間
幾個常用的預設檔案:
default.php
<?php
/*
* Copyright (c) 2002 Company Name.
* $Header: /home/cvsroot/tech/cvs_card.html,v 1.9 2003/11/09 07:57:11 chedong Exp $
*/
?>
====================================
Default.java: 注意檔案頭一般注釋用 /* 開始 JAVADOC注釋用 /** 開始的區別
/*
* Copyright (c) 2002 MyCompany Name.
* $Header: /home/cvsroot/tech/cvs_card.html,v 1.9 2003/11/09 07:57:11 chedong Exp $
*/
package com.mycompany;
import java.;
/**
* comments here
*/
public class Default {
/**
* Comments here
* @param
* @return
*/
public toString() {
}
}
====================================
default.pl:
#!/usr/bin/perl -w
# Copyright (c) 2002 Company Name.
# $Header: /home/cvsroot/tech/cvs_card.html,v 1.9 2003/11/09 07:57:11 chedong Exp $
# file comments here
use strict;
CVS vs VSS
CVS沒有檔案鎖定模式,VSS在check out同時,同時記錄了檔案被匯出者鎖定。
CVS的update和commit, VSS是get_lastest_version和check in
對應VSS的check out/undo check out的CVS裡是edit和unedit
在CVS中,標記自動更新功能預設是開啟的,這樣也帶來一個潛在的問題,就是不用-kb方式添加binary檔案的話在cvs自動更新時可能會導致檔案失效。
$Header: /home/cvsroot/tech/cvs_card.html,v 1.5 2003/03/09 08:41:46 chedong Exp $ $Date: 2003/11/09 07:57:11 $這樣的標記在Virsual SourceSafe中稱之為Keyword Explaination,預設是關閉的,需要通過OPITION開啟,並指定需要進行源檔案關鍵詞掃描的檔案類型:*.txt,*.java, *.html...
對於Virsual SourceSafe和CVS都通用的TAG有:
$Header: /home/cvsroot/tech/cvs_card.html,v 1.5 2003/03/09 08:41:46 chedong Exp $
$Author: chedong $
$Date: 2003/11/09 07:57:11 $
$Revision: 1.9 $
我建議盡量使用通用的關鍵詞保證代碼在CVS和VSS都能方便的跟蹤。
WinCVS
下載:
cvs Windows用戶端:目前穩定版本為1.2
http://cvsgui.sourceforge.net
ssh Windows用戶端
http://www.networksimplicity.com/openssh/
安裝好以上2個軟體以後:
WinCVS用戶端的admin==>preference設定
1 在general選單裡
設定CVSROOT: username@192.168.0.123:/home/cvsroot
設定Authorization: 選擇SSH server
2 Port選單裡
鉤上:check for alternate rsh name
並設定ssh.exe的路徑,預設是裝在 C:/Program Files/NetworkSimplicity/ssh/ssh.exe
然後就可以使用WinCVS進行cvs操作了,所有操作都會跳出命令列視窗要求你輸入伺服器端的認證密碼。
當然,如果你覺得這樣很煩的話,還有一個辦法就是產生一個沒有密碼的公開金鑰/私密金鑰對,並設定CVS使用基於公開金鑰/私密金鑰的SSH認證(在general 選單裡)。
可以選擇的diff工具:examdiff
下載:
http://www.prestosoft.com/examdiff/examdiff.htm
還是在WinCVS菜單admin==>preference的WinCVS選單裡
選上:Externel diff program
並設定diff工具的路徑,比如:C:/Program Files/ed16i/ExamDiff.exe
在對檔案進行版本diff時,第一次需要將視窗右下角的use externel diff選上。
基於CVSTrac的小組開發環境搭建
作為一個小組級的開發環境,版本控制系統和BUG跟蹤系統等都涉及到使用者認證部分。如何方便的將這些系統整合起來是一個非常困難的事情,畢竟我們不能指望 Linux下有像Source Offsite那樣整合度很高的版本控制/BUG跟蹤整合系統。
我個人是很反對使用pserver模式的遠端使用者認證的,但如果大部分組員使用WINDOWS用戶端進行開發的話,總體來說使用 CVSROOT/passwd認證還是很難避免的,但CVS本身使用者的管理比較麻煩。本來我打算自己用perl寫一個管理介面的,直到我發現了 CVSTrac:一個基於WEB介面的BUG跟蹤系統,它外掛在CVS系統上的BUG跟蹤系統,其中就包括了WEB介面的CVSROOT/passwd檔案的管理,甚至還整合了WIKIWIKI討論群組功能。
這裡首先說一下CVS的pserver模式下的使用者認證,CVS的使用者認證服務是基於inetd中的:
cvspserver stream tcp nowait apache /usr/bin/cvs cvs --allow-root=/home/cvsroot pserver
一般在2401連接埠(這個連接埠號碼很好記:49的平方)
CVS使用者資料庫是基於CVSROOT/passwd檔案,檔案格式:
[username]:[crypt_password]:[mapping_system_user]
由於密碼都用的是UNIX標準的CRYPT加密,這個passwd檔案的格式基本上是apache的htpasswd格式的擴充(比APACHE的 PASSWD檔案多一個系統使用者映射欄位),所以這個檔案最簡單的方法可以用
apache/bin/htpasswd -b myname mypassword
建立。注意:通過htpasswd建立出來的檔案會沒有映射系統使用者的欄位
例如:
new:geBvosup/zKl2
setup:aISQuNAAoY3qw
test:hwEpz/BX.rEDU
映射系統使用者的目的在於:你可以建立一個專門的CVS服務帳號,比如用apache的運行使用者apache,並將/home/cvsroot目錄下的所有許可權賦予這個使用者,然後在passwd檔案裡建立不同的開發使用者帳號,但開發使用者帳號最後的檔案讀寫權限都映射為apache使用者,在SSH模式下多個系統開發使用者需要在同一個組中才可以相互讀寫CVS庫中的檔案。
進一步的,你可以將使用者分別映射到apache這個系統使用者上。
new:geBvosup/zKl2:apache
setup:aISQuNAAoY3qw:apache
test:hwEpz/BX.rEDU:apache
CVSTrac很好的解決了CVSROOT/passwd的管理問題,而且包含了BUG跟蹤報告系統和整合WIKIWIKI交流功能等,使用的 CGI方式的安裝,並且基於GNU Public License:
在inetd裡加入cvspserver服務:
cvspserver stream tcp nowait apache /usr/bin/cvs cvs --allow-root=/home/cvsroot pserver
xietd的設定檔:%cat cvspserver
service cvspserver
{
disable = no
socket_type = stream
wait = no
user = apache
server = /usr/bin/cvs
server_args = -f --allow-root=/home/cvsroot pserver
log_on_failure += USERID
}
注意:這裡的使用者佈建成apache目的是和/home/cvsroot的所有使用者一致,並且必須讓這個這個使用者對/home/cvsroot/下的 CVSROOT/passwd和cvstrac初始化產生的myproj.db有讀取許可權。
安裝過程
- 下載:可以從http://www.cvstrac.org 下載
我用的是已經在Linux上編譯好的應用程式套件組合:cvstrac-1.1.2.bin.gz,
%gzip -d cvstrac-1.1.2.bin.gz
%chmod +x cvstrac-1.1.2.bin
#mv cvstarc-1.1.1.bin /usr/bin/cvstrac
如果是從原始碼編譯:
從 http://www.sqlite.org/download.html 下載SQLITE的rpm包:
rpm -i sqlite-devel-2.8.6-1.i386.rpm
從 ftp://ftp.cvstrac.org/cvstrac/ 下載軟體包
解包,假設解包到/home/chedong/cvstrac-1.1.2下,並規劃將cvstrac安裝到/usr/local/bin目錄下, cd /home/chedong/cvstrac-1.1.2 編輯linux-gcc.mk:
修改:
SRCDIR = /home/chedong/cvstrac-1.1.2
INSTALLDIR = /usr/local/bin
然後
mv linux-gcc.mk Makefile
make
#make install
- 初始化cvstrac資料庫:假設資料庫名是 myproj
在已經裝好的CVS伺服器上(CVS庫這時候應該已經是初始化好了,比如:cvs init初始化在/home/cvsroot裡),運行一下
%cvstrac init /home/cvsroot myproj
運行後,/home/cvsroot裡會有一個的myproj.db庫,使用CVSTRAC服務,/home/cvsroot/myproj.db /home/cvsroot/CVSROOT/readers /home/cvsroot/CVSROOT/writers /home/cvsroot/CVSROOT/passwd這幾個檔案對於web服務的運行使用者應該是可寫的,在RedHat8上,預設就有一個叫 apache使用者和一個apache組,所以在httpd.conf檔案中設定了用apache使用者運行web服務:
User apache
Group apache,
然後設定屬於apache使用者和apache組
#chown -R apache:apache /home/cvsroot
-rw-r--r-- 1 apache apache 55296 Jan 5 19:40 myproj.db
drwxrwxr-x 3 apache apache 4096 Oct 24 13:04 CVSROOT/
drwxrwxr-x 2 apache apache 4096 Aug 30 19:47 some_proj/
此外還在/home/cvsroot/CVSROOT中設定了:
chmod 664 readers writers passwd
- 在apche/cgi-bin目錄中建立指令碼cvstrac:
#!/bin/sh
/usr/bin/cvstrac cgi /home/cvsroot
設定指令碼可執行:
chmod +x /home/apache/cgi-bin/cvstrac
- 從 http://cvs.server.address/cgi-bin/cvstrac/myproj 進入管理介面
預設登入名稱:setup 密碼 setup
對於一般使用者可以從:
http://cvs.server.address/cgi-bin/cvstrac/myproj
- 在setup中重新設定了CVSROOT的路徑後,/home/cvsroot
如果是初次使用需要在/home/cvsroot/CVSROOT下建立passwd, readers, writers檔案
touch passwd readers writers
然後設定屬於apache使用者,
chown apache.apache passwd readers writers
這樣使用setup使用者建立新使用者後會同步更新CVSROOT/passwd下的帳號
修改登入密碼,進行BUG報告等,
更多使用細節可以在使用中慢慢瞭解。
對於前面提到的WinCVS在perference裡設定:
CVSROOT欄輸入:username@ip.address.of.cvs:/home/cvsroot
Authenitication選擇:use passwd file on server side
就可以了從伺服器上進行CVS操作了。
CVS的使用者權限管理
CVS的許可權管理分2種策略:
- 基於系統檔案許可權的系統使用者管理:適合多個在Linux上使用系統帳號的開發人員進行開發。
- 基於CVSROOT/passwd的虛擬使用者管理:適合多個在Windows平台上的開發人員將帳號映射成系統帳號使用。
為什麼使用apache/apache使用者?首先RedHat8中預設就有了,而且使用這個使用者可以方便通過cvstrac進行WEB管理。
chown -R apache.apache /home/cvsroot
chmod 775 /home/cvsroot
Linux上通過ssh串連CVS伺服器的多個開發人員:通過都屬於apache組實現檔案的共用讀寫
開發人員有程式開發伺服器上的系統帳號:sysuser1 sysuser2,設定讓他們都屬於apache組,因為通過cvs新匯入的項目都是對組開放的:664許可權的,這樣無論那個系統使用者匯入的專案檔,只要檔案的組宿主是apache,所有其他同組系統開發使用者就都可以讀寫;基於ssh遠程認證的也是一樣。
apache(system group)
/ | /
sysuser1 sysuser2 sysuser3
Windows上通過cvspserver串連CVS伺服器的多個開發人員:通過在passwd檔案種映射成 apache使用者實現檔案的共用讀寫
他們的帳號通過CVSROOT/passwd和readers writers這幾個檔案管理;通過cvstrac設定所有虛擬使用者都映射到apache使用者上即可。
apache(system user)
/ | /
windev1 windev2 windev3
利用cvs + (WinCVS/cvsweb/cvstrac),構成了一個相對完善的跨平台工作群組開發版本控制環境。
相關資源:
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/
CVS--並行版本系統
http://www.soforge.com/cvsdoc/zh_CN/book1.html
CVS 免費書:
http://cvsbook.red-bean.com/
CVS 命令的速查卡片:
http://www.refcards.com/about/cvs.html
WinCVS:
http://cvsgui.sourceforge.net/
CVSTrac: A Web-Based Bug And Patch-Set Tracking System For CVS
http://www.cvstrac.org
StatCVS:基於CVS的代碼統計工具:按代碼量,按開發人員的統計表等
http://sourceforge.net/projects/statcvs
如何在WEB開發中規劃CVS上:在Google上查 "cvs web development"
http://ccm.redhat.com/bboard-archive/cvs_for_web_development/index.html
一些整合了CVS的IDE環境:
Eclipse
Magic C++