CVS使用手册.docx
《CVS使用手册.docx》由会员分享,可在线阅读,更多相关《CVS使用手册.docx(12页珍藏版)》请在冰豆网上搜索。
![CVS使用手册.docx](https://file1.bdocx.com/fileroot1/2022-12/7/d79adab9-17f0-4c47-bb2c-fc16e926d655/d79adab9-17f0-4c47-bb2c-fc16e926d6551.gif)
CVS使用手册
CVS是一个C/S系统,多个开发人员通过一个中心版本控制系统来记录文件版本,从而达到保证文件同步的目的。
工作模式如下:
CVS服务器(文件版本库)
/|\
(版本同步)
/|\
开发者1开发者2开发者3
作为一般开发人员挑选2,6看就可以了,CVS的管理员则更需要懂的更多一些,最后还简单介绍了一些Windows下的cvs客户端使用,CVS远程用户认证的选择及与BUG跟踪系统等开发环境的集成问题。
1.CVS环境初始化:
CVS环境的搭建管理员
2.CVS的日常使用:
日常开发中最常用的CVS命令,开发人员管理员
3.CVS的分支开发:
项目按照不同进度和目标并发进行管理员
4.CVS的用户认证:
通过SSH的远程用户认证,安全,简单管理员
5.CVSWEB:
CVS的WEB访问界面大大提高代码版本比较的效率管理员
6.CVSTAG:
将$Id$加入代码注释中,方便开发过程的跟踪开发人员
7.CVSvsVSS:
CVS和VirsualSourceSafe的比较开发人员管理员
8.WinCVS:
通过SSH认证的WinCVS认证设置
9.基于CVSTrac的小组开发环境搭建:
通过CVSTrac实现web界面的CVS用户管理,集成的BUG跟踪和WIKI交流
10.CVS中的用户权限管理:
基于系统用户的CVS权限管理和基于CVSROOT/passwd的虚拟用户管理
一个系统20%的功能往往能够满足80%的需求,CVS也不例外,以下是CVS最常用的功能,可能还不到它全部命令选项的20%,作为一般开发人员平时会用cvsupdate和cvscommit就够了,更多的需求在实际应用过程中自然会出现,不时回头看看相关文档经常有意外的收获。
CVS环境初始化
环境设置:
指定CVS库的路径CVSROOT
tcsh
setenvCVSROOT/path/to/cvsroot
bash
CVSROOT=/path/to/cvsroot;exportCVSROOT
后面还提到远程CVS服务器的设置:
CVSROOT=:
ext:
$USER@test.server.address#port:
/path/to/cvsrootCVS_RSH=ssh;exportCVSROOTCVS_RSH
初始化:
CVS版本库的初始化。
cvsinit
一个项目的首次导入
cvsimport-m"writesomecommentshere"project_namevendor_tagrelease_tag
执行后:
会将所有源文件及目录导入到/path/to/cvsroot/project_name目录下
vender_tag:
开发商标记
release_tag:
版本发布标记
项目导出:
将代码从CVS库里导出
cvscheckoutproject_name
cvs将创建project_name目录,并将最新版本的源代码导出到相应目录中。
这个checkout和VirvualSourceSafe中的checkout不是一个概念,相对于VirvualSourceSafe的checkout是cvsupdate,checkin是cvscommit。
CVS的日常使用
注意:
第一次导出以后,就不是通过cvscheckout来同步文件了,而是要进入刚才cvscheckoutproject_name导出的project_name目录下进行具体文件的版本同步(添加,修改,删除)操作。
将文件同步到最新的版本
cvsupdate
不制定文件名,cvs将同步所有子目录下的文件,也可以制定某个文件名/目录进行同步
cvsupdatefile_name
最好每天开始工作前或将自己的工作导入到CVS库里前都要做一次,并养成“先同步后修改”的习惯,和VirvualSourceSafe不同,CVS里没有文件锁定的概念,所有的冲突是在commit之前解决,如果你修改过程中,有其他人修改并commit到了CVS库中,CVS会通知你文件冲突,并自动将冲突部分用
>>>>>>
contentoncvsserver
<<<<<<
contentinyourfile
>>>>>>
标记出来,由你确认冲突内容的取舍。
版本冲突一般是在多个人修改一个文件造成的,但这种项目管理上的问题不应该指望由CVS来解决。
确认修改写入到CVS库里
cvscommit-m"writesomecommentshere"file_name
注意:
CVS的很多动作都是通过cvscommit进行最后确认并修改的,最好每次只修改一个文件。
在确认的前,还需要用户填写修改注释,以帮助其他开发人员了解修改的原因。
如果不用写-m"comments"而直接确认`cvscommitfile_name`的话,cvs会自动调用系统缺省的文字编辑器(一般是vi)要求你写入注释。
注释的质量很重要:
所以不仅必须要写,而且必须写一些比较有意义的内容:
以方便其他开发人员能够很好的理解
不好的注释,很难让其他的开发人员快速的理解:
比如:
-m"bugfixed"甚至-m""
好的注释,甚至可以用中文:
-m"在用户注册过程中加入了Email地址校验"
修改某个版本注释:
每次只确认一个文件到CVS库里是一个很好的习惯,但难免有时候忘了指定文件名,把多个文件以同样注释commit到CVS库里了,以下命令可以允许你修改某个文件某个版本的注释:
cvsadmin-m1.3:
"writesomecommentshere"file_name
添加文件
创建好新文件后,比如:
touchnew_file
cvsaddnew_file
注意:
对于图片,Word文档等非纯文本的项目,需要使用cvsadd-kb选项按2进制文件方式导入(k表示扩展选项,b表示binary),否则有可能出现文件被破坏的情况
比如:
cvsadd-kbnew_file.gif
cvsadd-kbreadme.doc
如果关键词替换属性在首次导入时设置错了怎么办?
cvsadmin-kkvnew_file.css
然后确认修改并注释
cvsci-m"writesomecommentshere"
删除文件
将某个源文件物理删除后,比如:
rmfile_name
cvsrmfile_name
然后确认修改并注释
cvsci-m"writesomecommentshere"
以上面前2步合并的方法为:
cvsrm-ffile_name
cvsci-m"whydeletefile"
注意:
很多cvs命令都有缩写形式:
commit=>ci;update=>up;checkout=>co/get;remove=>rm;
添加目录
cvsadddir_name
查看修改历史
cvslogfile_name
cvshistoryfile_name
查看当前文件不同版本的区别
cvsdiff-r1.3-r1.5file_name
查看当前文件(可能已经修改了)和库中相应文件的区别
cvsdifffile_name
cvs的web界面提供了更方便的定位文件修改和比较版本区别的方法,具体安装设置请看后面的cvsweb使用
正确的通过CVS恢复旧版本的方法:
如果用cvsupdate-r1.2file.name
这个命令是给file.name加一个STICKTAG:
"1.2",虽然你的本意只是想将它恢复到1.2版本
正确的恢复版本的方法是:
cvsupdate-p-r1.2file_name>file_name
如果不小心已经加成STICKTAG的话:
用cvsupdate-A解决
移动文件/文件重命名
cvs里没有cvsmove或cvsrename,因为这两个操作是可以由先cvsremoveold_file_name,然后cvsaddnew_file_name实现的。
删除/移动目录
最方便的方法是让管理员直接移动,删除CVSROOT里相应目录(因为CVS一个项目下的子目录都是独立的,移动到$CVSROOT目录下都可以作为新的独立项目:
好比一颗树,其实砍下任意一枝都能独立存活),对目录进行了修改后,要求其开发人员重新导出项目cvscheckoutproject_name或者用cvsupdate-dP同步。
项目发布导出不带CVS目录的源文件
做开发的时候你可能注意到了,每个开发目录下,CVS都创建了一个CVS/目录。
里面有文件用于记录当前目录和CVS库之间的对应信息。
但项目发布的时候你一般不希望把文件目录还带着含有CVS信息的CVS目录吧,这个一次性的导出过程使用cvsexport命令,不过export只能针对一个TAG或者日期导出,比如:
cvsexport-rrelease1project_name
cvsexport-D20021023project_name
cvsexport-Dnowproject_name
CVSBranch:
项目多分支同步开发
确认版本里程碑:
多个文件各自版本号不一样,项目到一定阶段,可以给所有文件统一指定一个阶段里程碑版本号,方便以后按照这个阶段里程碑版本号导出项目,同时也是项目的多个分支开发的基础。
cvstagrelease_1_0
开始一个新的里程碑:
cvscommit-r2标记所有文件开始进入2.x的开发
注意:
CVS里的revsion和软件包的发布版本可以没有直接的关系。
但所有文件使用和发布版本一致的版本号比较有助于维护。
版本分支的建立
在开发项目的2.x版本的时候发现1.x有问题,但2.x又不敢用,则从先前标记的里程碑:
release_1_0导出一个分支release_1_0_patch
cvsrtag-b-rrelease_1_0release_1_0_patchproj_dir
一些人先在另外一个目录下导出release_1_0_patch这个分支:
解决1.0中的紧急问题,
cvscheckout-rrelease_1_0_patch
而其他人员仍旧在项目的主干分支2.x上开发
在release_1_0_patch上修正错误后,标记一个1.0的错误修正版本号
cvstagrelease_1_0_patch_1
如果2.0认为这些错误修改在2.0里也需要,也可以在2.0的开发目录下合并release_1_0_patch_1中的修改到当前代码中:
cvsupdate-jrelease_1_0_patch_1
CVS的远程认证通过SSH远程访问CVS
使用cvs本身基于pserver的远程认证很麻烦,需要定义服务器和用户组,用户名,设置密码等,
常见的登陆格式如下:
cvs-d:
pserver:
cvs_user_name@cvs.server.address:
/path/to/cvsrootlogin
例子:
cvs-d:
pserver:
cvs@samba.org:
/cvsrootlogin
不是很安全,因此一般是作为匿名只读CVS访问的方式。
从安全考虑,通过系统本地帐号认证并通过SSH传输是比较好的办法,通过在客户机的/etc/profile里设置一下内容:
CVSROOT=:
ext:
$USER@cvs.server.address#port:
/path/to/cvsrootCVS_RSH=ssh;exportCVSROOTCVS_RSH
所有客户机所有本地用户都可以映射到CVS服务器相应同名帐号了。
比如:
CVS服务器是192.168.0.3,上面CVSROOT路径是/home/cvsroot,另外一台开发客户机是192.168.0.4,如果tom在2台机器上都有同名的帐号,那么从192.168.0.4上设置了:
exportCVSROOT=:
ext:
tom@192.168.0.3:
/home/cvsroot
exportCVS_RSH=ssh
tom就可以直接在192.168.0.4上对192.168.0.3的cvsroot进行访问了(如果有权限的话)
cvscheckoutproject_name
cdproject_name
cvsupdate
...
cvscommit
如果CVS所在服务器的SSH端口不在缺省的22,或者和客户端与CVS服务器端SSH缺省端口不一致,有时候设置了:
:
ext:
$USER@test.server.address#port:
/path/to/cvsroot
仍然不行,比如有以下错误信息:
ssh:
test.server.address#port:
Nameorservicenotknown
cvs[checkoutaborted]:
endoffilefromserver(consultabovemessagesifany)
解决的方法是做一个脚本指定端口转向(不能使用alias,会出找不到文件错误):
创建一个/usr/bin/ssh_cvs文件,假设远程服务器的SSH端口是非缺省端口:
34567
#!
/bin/sh
/usr/bin/ssh-p34567"$@"
然后:
chmod+x/usr/bin/ssh_cvs
并CVS_RSH=ssh_cvs;exportCVS_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功能。
下载解包:
tarzxfcvsweb.tgz
把配置文件cvsweb.conf放到安全的地方(比如和apache的配置放在同一个目录下),
修改:
cvsweb.cgi让CGI找到配置文件:
$config=$ENV{'CVSWEB_CONFIG'}||'/path/to/apache/conf/cvsweb.conf';
转到/path/to/apache/conf下并修改cvsweb.conf:
1.修改CVSROOT路径设置:
%CVSROOT=(
'Development'=>'/path/to/cvsroot',#<==修改指向本地的CVSROOT
);
2.缺省不显示已经删除的文档:
"hideattic"=>"1",#<==缺省不显示已经删除的文档
3.在配置文件cvsweb.conf中还可以定制页头的描述信息,你可以修改$long_intro成你需要的文字
CVSWEB可不能随便开放给所有用户,因此需要使用WEB用户认证:
先生成passwd:
/path/to/apache/bin/htpasswd-ccvsweb.passwduser
修改httpd.conf:
增加
AuthName"CVSAuthorization"
AuthTypeBasic
AuthUserFile/path/to/cvsweb.passwd
requirevalid-user
CVSTAGS:
$Id$
将$Id$加在程序文件开头的注释里是一个很好的习惯,cvs能够自动解释更新其中的内容成:
file_nameversiontimeuser_name的格式,比如:
cvs_card.txt,v1.12002/04/0504:
24:
12chedongExp,可以这些信息了解文件的最后修改人和修改时间。
几个常用的缺省文件:
default.php
php
/*
*Copyright(c)2002CompanyName.
*$Header$
*/
?
>
====================================
Default.java:
注意文件头一般注释用/*开始JAVADOC注释用/**开始的区别
/*
*Copyright(c)2002MyCompanyName.
*$Header$
*/
packagecom.mycompany;
importjava.;
/**
*commentshere
*/
publicclassDefault{
/**
*Commentshere
*@param
*@return
*/
publictoString(){
}
}
====================================
default.pl:
#!
/usr/bin/perl-w
#Copyright(c)2002CompanyName.
#$Header$
#filecommentshere
usestrict;
CVSvsVSS
CVS没有文件锁定模式,VSS在checkout同时,同时记录了文件被导出者锁定。
CVS的update和commit,VSS是get_lastest_version和checkin
对应VSS的checkout/undocheckout的CVS里是edit和unedit
在CVS中,标记自动更新功能缺省是打开的,这样也带来一个潜在的问题,就是不用-kb方式添加binary文件的话在cvs自动更新时可能会导致文件失效。
$Header$$Date$这样的标记在VirsualSourceSafe中称之为KeywordExplaination,缺省是关闭的,需要通过OPITION打开,并指定需要进行源文件关键词扫描的文件类型:
*.txt,*.java,*.html...
对于VirsualSourceSafe和CVS都通用的TAG有:
$Header$
$Author$
$Date$
$Revision$
我建议尽量使用通用的关键词保证代码在CVS和VSS都能方便的跟踪。
WinCVS
下载:
cvsWindows客户端:
目前稳定版本为1.2
sshWindows客户端
安装好以上2个软件以后:
WinCVS客户端的admin==>preference设置
1在general选单里
设置CVSROOT:
username@192.168.0.123:
/home/cvsroot
设置Authorization:
选择SSHserver
2Port选单里
钩上:
checkforalternatershname
并设置ssh.exe的路径,缺省是装在C:
\ProgramFiles\NetworkSimplicity\ssh\ssh.exe
然后就可以使用WinCVS进行cvs操作了,所有操作都会跳出命令行窗口要求你输入服务器端的认证密码。
当然,如果你觉得这样很烦的话,还有一个办法就是生成一个没有密码的公钥/私钥对,并设置CVS使用基于公钥/私钥的SSH认证(在general选单里)。
可以选择的diff工具:
examdiff
下载:
还是在WinCVS菜单admin==>preference的WinCVS选单里
选上:
Externeldiffprogram
并设置diff工具的路径,比如:
C:
\ProgramFiles\ed16i\ExamDiff.exe
在对文件进行版本diff时,第一次需要将窗口右下角的useexterneldiff选上。
基于CVSTrac的小组开发环境搭建
作为一个小组级的开发环境,版本控制系统和BUG跟踪系统等都涉及到用户认证部分。
如何方便的将这些系统集成起来是一个非常困难的事情,毕竟我们不能指望Linux下有像SourceOffsite那样集成度很高的版本控制/BUG跟踪集成系统。
我个人是很反对使用pserver模式的远程用户认证的,但如果大部分组员使用WINDOWS客户端进行开发的话,总体来说使用CVSROOT/passwd认证还是很难避免的,但CVS本身用户的管理比较麻烦。
本来我打算自己用perl写一个管理界面的,直到我发现了CVSTrac:
一个基于WEB界面的BUG跟踪系统,它外挂在CVS系统上的BUG跟踪系统,其中就包括了WEB界面的CVSROOT/passwd文件的管理,甚至还集成了WIKIWIKI讨论组功能。
这里首先说一下CVS的pserver模式下的用户认证,CVS的用户认证服务是基于inetd中的:
cvspserverstreamtcpnowaitapache/usr/bin/cvscvs--allow-root=/home/cvsrootpserver
一般在2401端口(这个端口号很好记:
49的平方)
CVS用户数据库是基于CVSROOT/passwd文件,文件格式:
[username]:
[crypt_password]:
[mapping_system_user]
由于密码都用的是UNIX标准的CRYPT加密,这个passwd文件的格式基本上是apache的htpasswd格式的扩展(比APACHE的PASSWD文件多一个系统用户映射字段),所以这个文件最简单的方法可以用
apache/bin/htpasswd-bmynamemypassword
创建。
注意:
通过htpasswd创建出来的文件会没有映射系统用户的字段
例如:
new:
geBvosup/zKl2
setup:
aISQuNAAoY3qw
test:
hwEpz/BX.rEDU
映射系统用户的目的在于:
你可以创建一个专门的CVS服务帐号,比如用apache的运行用户apache,并将/home/cvsroot目录下的所有权限赋予这个用户,然后在passwd文件里创建不同的开发用户帐号,但开发用户帐号最后的文件读写权限都映射为apache用户,在SSH模式下多个系统开发用户需要在