版權聲明:可以任意轉載,轉載時請務必以超鏈接形式標明文章原始出處和作者信息及本聲明 http://www.chedong.com/tech/cvs_card.html
關鍵詞:CVS CVSWeb CVSTrac WinCVS CVSROOT
內容摘要:
CVS是一個C/S系統,多個開發人員通過一個中心版本控制系統來記錄文件版本,從而達到保證文件同步的目的。工作模式如下: CVS服務器(文件版本庫)
/ | \
(版 本 同 步)
/ | \
開發者1 開發者2 開發者3
開發人員入門可以主要挑選2,6看就可以了,CVS的管理員則更需要懂的更多一些,最后還簡單介紹了一些Windows下的cvs客戶端使用,遠程用戶認證的選擇,及與BUG跟蹤系統等開發環境的集成問題。
- CVS環境初始化:CVS環境的搭建 管理員
- CVS的日常使用:日常開發中最常用的CVS命令, 開發人員 管理員
- CVS的分支開發:項目按照不同進度和目標并發進行 管理員
- CVS的用戶認證:通過SSH的遠程用戶認證,安全,簡單 管理員
- CVSWEB:CVS的WEB訪問界面大大提高代碼版本比較的效率 管理員
- CVS TAG:將$Id$加入代碼注釋中,方便開發過程的跟蹤開發人員
- CVS vs VSS: CVS和Virsual SourceSafe的比較 開發人員 管理員
- WinCVS: 通過SSH認證的WinCVS認證設置
- 基于CVSTrac的小組開發環境搭建:通過CVSTrac實現web界面的CVS用戶管理,集成的BUG跟蹤和WIKI交流
- CVS中的用戶權限管理:基于系統用戶的CVS權限管理和基于CVSROOT/passwd的虛擬用戶管理
一個系統20%的功能往往能夠滿足80%的需求,CVS也不例外,以下是CVS最常用的功能,可能還不到它全部命令選項的20%,更多的功能在實際應用過程中體會,你想用多少就學多少,不時回頭看看經常有意外的收獲。
環境設置:指定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 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 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 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本身基于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文件: #!/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的端口
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>
將$Id: cvs_card.html,v 1.6 2003/04/19 03:34:39 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.6 2003/04/19 03:34:39 chedong Exp $
*/
?>
====================================
Default.java: 注意文件頭一般注釋用 /* 開始 JAVADOC注釋用 /** 開始的區別
/*
* Copyright (c) 2002 MyCompany Name.
* $Header: /home/cvsroot/tech/cvs_card.html,v 1.6 2003/04/19 03:34:39 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.6 2003/04/19 03:34:39 chedong Exp $
# file comments here
use strict;
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/04/19 03:34:39 $這樣的標記在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/04/19 03:34:39 $ $Revision: 1.6 $
我建議盡量使用通用的關鍵詞保證代碼在CVS和VSS都能方便的跟蹤。
下載:
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選上。
作為一個小組級的開發環境,版本控制系統和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
- 初始化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的權限管理分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
原文出處:<a >http://www.chedong.com/tech/cvs_card.html</a>
|