cvs使用手册.docx

1、cvs使用手册CVS使用手册作者：车东 发表于：2002-02-06 18:02 最后更新于：2008-02-15 22:02版权声明：可以任意转载，转载时请务必以超链接形式标明文章原始出处和作者信息及本声明。 CVS是一个C/S系统，多个开发人员通过一个中心版本控制系统来记录文件版本，从而达到保证文件同步的目的。工作模式如下： CVS服务器（文件版本库） / | （版 本 同 步） / | 开发者1 开发者2 开发者3作为一般开发人员挑选2,6看就可以了，CVS的管理员则更需要懂的更多一些，最后还简单介绍了一些Windows下的cvs客户端使用，CVS远 程用户认证的选择及与BUG跟踪系统等

2、开发环境的集成问题。1. CVS环境初始化：CVS环境的搭建 管理员 2. CVS的日常使用：日常开发中最常用的CVS命令， 开发人员 管理员 3. CVS的分支开发：项目按照不同进度和目标并发进行 管理员 4. CVS的用户认证：通过SSH的远程用户认证，安全，简单 管理员 5. CVSWEB：CVS的WEB访问界面大大提高代码版本比较的效率 管理员 6. CVS TAG：将$Id$ 加入代码注释中，方便开发过程的跟踪开发人员 7. CVS vs VSS: CVS和Virsual SourceSafe的比较 开发人员 管理员 8. WinCVS: 通过SSH认证的WinCVS认证设置 9.

3、基于CVSTrac的小组开发环境搭建：通过CVSTrac实现web界面的CVS用户管理,集成的BUG跟踪和WIKI交流 10. CVS中的用户权限管理：基于系统用户的CVS权限管理和基于CVSROOT/passwd的虚拟用户管理 一个系统20%的功能往往能够满足80%的需求，CVS也不例外，以下是CVS最常用的功能，可能还不到它全部命令选项的20%，作为一般开发人员平时会用cvs update和cvs commit就够了，更多的需求在实际应用过程中自然会出现，不时回头看看相关文档经常有意外的收获。CVS环境初始化环境设置：指定CVS库的路径CVSROOT tcshsetenv CVSROOT

4、/path/to/cvsrootbashCVSROOT=/path/to/cvsroot ; export CVSROOT后面还提到远程CVS服务器的设置：CVSROOT=:ext:$USERtest.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执行后：会将所有源文件及目录导入到/pat

5、h/to/cvsroot/project_name目录下vender_tag: 开发商标记release_tag: 版本发布标记项目导出：将代码从CVS库里导出cvs checkout project_namecvs 将创建project_name目录，并将最新版本的源代码导出到相应目录中。这个checkout和Virvual SourceSafe中的check out不是一个概念，相对于Virvual SourceSafe的check out是cvs update， check in是cvs commit。CVS的日常使用 注意：第一次导出以后，就不是通过cvs checkout来同步文件了

6、，而是要进入刚才cvs checkout project_name导出的project_name目录下进行具体文件的版本同步（添加，修改，删除）操作。将文件同步到最新的版本cvs update不制定文件名，cvs将同步所有子目录下的文件，也可以制定某个文件名/目录进行同步cvs update file_name最好每天开始工作前或将自己的工作导入到CVS库里前都要做一次，并养成“先同步 后修改”的习惯，和Virvual SourceSafe不同，CVS里没有文件锁定的概念，所有的冲突是在commit之前解决，如果你修改过程中，有其他人修改并commit到了CVS 库中，CVS会通知你文件冲突，

7、并自动将冲突部分用content on cvs server标记出来，由你确认冲突内容的取舍。版本冲突一般是在多个人修改一个文件造成的，但这种项目管理上的问题不应该指望由CVS来解决。确认修改写入到CVS库里cvs commit -m write some comments here file_name注意：CVS的很多动作都是通过cvs commit进行最后确认并修改的，最好每次只修改一个文件。在确认的前，还需要用户填写修改注释，以帮助其他开发人员了解修改的原因。如果不用写-m comments而直接确认cvs commit file_name 的话，cvs会自动调用系统缺省的文字编辑器(一

8、般是vi)要求你写入注释。注释的质量很重要：所以不仅必须要写，而且必须写一些比较有意义的内容：以方便其他开发人员能够很好的理解不好的注释，很难让其他的开发人员快速的理解：比如： -m bug fixed 甚至 -m 好的注释，甚至可以用中文: -m 在用户注册过程中加入了Email地址校验 修改某个版本注释：每次只确认一个文件到CVS库里是一个很好的习惯，但难免有时候忘了指定文件名，把多个文件以同样注释commit到CVS库里了，以 下命令可以允许你修改某个文件某个版本的注释：cvs admin -m 1.3:write some comments here file_name添加文件创建好新

9、文件后，比如：touch new_filecvs add new_file注意：对于图片，Word文档等非纯文本的项目，需要使用cvs add -kb选项按2进制文件方式导入(k表示扩展选项，b表示binary)，否则有可能出现文件被破坏的情况比如：cvs add -kb new_file.gifcvs add -kb readme.doc如果关键词替换属性在首次导入时设置错了怎么办？cvs admin -kkv new_file.css 然后确认修改并注释cvs ci -m write some comments here删除文件将某个源文件物理删除后，比如：rm file_namecvs

10、rm file_name然后确认修改并注释cvs ci -m write some comments here以上面前2步合并的方法为：cvs rm -f file_namecvs ci -m why delete file注意：很多cvs命令都有缩写形式：commit=ci; update=up; checkout=co/get; remove=rm; 添加目录cvs add dir_name查看修改历史cvs log file_namecvs history file_name查看当前文件不同版本的区别cvs diff -r1.3 -r1.5 file_name查看当前文件（可能已经修改了

11、）和库中相应文件的区别cvs diff file_namecvs的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 re

12、name，因为这两个操作是可以由先cvs remove old_file_name，然后cvs add new_file_name实现的。删除/移动目录最方便的方法是让管理员直接移动，删除CVSROOT里相应目录（因为CVS一个项目下的子目录都是独立的，移动到$CVSROOT目录下都可以作为新的 独立项目：好比一颗树，其实砍下任意一枝都能独立存活），对目录进行了修改后，要求其开发人员重新导出项目cvs checkout project_name 或者用cvs update -dP同步。项目发布导出不带CVS目录的源文件做开发的时候你可能注意到了，每个开发目录下，CVS都创建了一个CVS/目录。

13、里面有文件用于记录当前目录和CVS库之间的对应信息。但项目发布的时候 你一般不希望把文件目录还带着含有CVS信息的CVS目录吧，这个一次性的导出过程使用cvs export命令，不过export只能针对一个TAG或者日期导出，比如：cvs export -r release1 project_name cvs export -D 20021023 project_namecvs export -D now project_nameCVS Branch：项目多分支同步开发确认版本里程碑：多个文件各自版本号不一样，项目到一定阶段，可以给所有文件统一指定一个阶段里程碑版本号，方便以后按照这个阶段里程

14、碑版本号导出项目， 同时也是项目的多个分支开发的基础。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_patchcvs rtag -b -r release_1_0 release_1_0_patch proj_dir一些人先在另外一个目录下导出

15、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_1CVS的远程认证通过SSH远程访问CVS使用cvs本身基于pserver的远程认证很麻烦,

16、需要定义服务器和用户组，用户名，设置密码等，常见的登陆格式如下：cvs -d :pserver:cvs_user_namecvs.server.address:/path/to/cvsroot login例子：cvs -d :pserver:cvssamba.org:/cvsroot login不是很安全，因此一般是作为匿名只读CVS访问的方式。从安全考虑，通过系统本地帐号认证并通过SSH传输是比较好的办法，通过在客户机的 /etc/profile里设置一下内容：CVSROOT=:ext:$USERcvs.server.address#port:/path/to/cvsroot CVS_RSH

17、=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:tom192.168.0.3:/home/cvsrootexport CVS_RSH=sshtom就可以直接在192.168.0.4上对192.168.0.3的cvsroot进行访问了（如果有权限的话）cvs checkou

18、t project_namecd project_namecvs update.cvs commit 如果CVS所在服务器的SSH端口不在缺省的22，或者和客户端与CVS服务器端SSH缺省端口不一致，有时候设置了：:ext:$USERtest.server.address#port:/path/to/cvsroot 仍然不行，比如有以下错误信息：ssh: test.server.address#port: Name or service not knowncvs checkout aborted: end of file from server (consult above messages

19、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.freeb

20、sd.org/cgi/cvsweb.cgiCVSWEB的下载：CVSWEB从最初的版本已经演化出很多功能界面更丰富的版本，这个是我个人感觉安装设置比较方便的：原先在：http:/www.spaghetti-code.de/software/linux/cvsweb/，但目前已经删除，目前仍可以在本站下载CVSWEB， 其实最近2年FreeBSD的CVSWeb项目已经有了更好的发展吧，而当初没有用FreeBSD那个版本 主要就是因为没有彩色的文件Diff功能。 下载解包：tar zxf cvsweb.tgz把配置文件cvsweb.conf放到安全的地方（比如和apache的配置放在同一个目录下）

21、，修改：cvsweb.cgi让CGI找到配置文件：$config = $ENVCVSWEB_CONFIG | /path/to/apache/conf/cvsweb.conf;转到/path/to/apache/conf下并修改cvsweb.conf：1. 修改CVSROOT路径设置：%CVSROOT = (Development = /path/to/cvsroot, # 1,#=缺省不显示已经删除的文档 3. 在配置文件cvsweb.conf中还可以定制页头的描述信息，你可以修改$long_intro成你需要的文字 CVSWEB可不能随便开放给所有用户，因此需要使用WEB用户认证：先生成

22、passwd:/path/to/apache/bin/htpasswd -c cvsweb.passwd user修改httpd.conf: 增加AuthName CVS AuthorizationAuthType BasicAuthUserFile /path/to/cvsweb.passwdrequire valid-userCVS TAGS: $Id$将$Id$ 加在程序文件开头的注释里是一个很好的习惯，cvs能够自动解释更新其中的内容成：file_name version time user_name 的格式，比如：cvs_card.txt,v 1.1 2002/04/05 04:24

23、:12 chedong Exp，可以这些信息了解文件的最后修改人和修改时间。几个常用的缺省文件：default.php=Default.java: 注意文件头一般注释用 /* 开始 JAVADOC注释用 /* 开始的区别/* * Copyright (c) 2002 MyCompany Name. * $Header$ */package com.mycompany;import java.;/* * comments here */public class Default /* * Comments here * param * return */ public toString() =de

24、fault.pl:#!/usr/bin/perl -w# Copyright (c) 2002 Company Name.# $Header$# file comments hereuse strict;CVS vs VSSCVS没有文件锁定模式，VSS在check out同时，同时记录了文件被导出者锁定。 CVS的update和commit， VSS是get_lastest_version和check in 对应VSS的check out/undo check out的CVS里是edit和unedit 在CVS中，标记自动更新功能缺省是打开的，这样也带来一个潜在的问题，就是不用-kb方式添加

25、binary文件的话在cvs自动更新时可能会导致 文件失效。$Header$ $Date$这样的标记在Virsual SourceSafe中称之为Keyword Explaination，缺省是关闭的，需要通过OPITION打开，并指定需要进行源文件关键词扫描的文件类型：*.txt,*.java, *.html.对于Virsual SourceSafe和CVS都通用的TAG有：$Header$Author$Date$ $Revision$ 我建议尽量使用通用的关键词保证代码在CVS和VSS都能方便的跟踪。 WinCVS下载：cvs Windows客户端：目前稳定版本为1.2ssh Window

26、s客户端安装好以上2个软件以后：WinCVS客户端的admin=preference设置1 在general选单里设置CVSROOT： username192.168.0.123:/home/cvsroot设置Authorization: 选择SSH server2 Port选单里钩上：check for alternate rsh name并设置ssh.exe的路径，缺省是装在 C:Program FilesNetworkSimplicitysshssh.exe 然后就可以使用WinCVS进行cvs操作了，所有操作都会跳出命令行窗口要求你输入服务器端的认证密码。 当然，如果你觉得这样很烦的话

27、，还有一个办法就是生成一个没有密码的公钥/私钥对，并设置CVS使用基于公钥/私钥的SSH认证（在general 选单里）。可以选择的diff工具：examdiff下载：还是在WinCVS菜单admin=preference的WinCVS选单里选上：Externel diff program并设置diff工具的路径，比如：C:Program Filesed16iExamDiff.exe在对文件进行版本diff时，第一次需要将窗口右下角的use externel diff选上。 基于CVSTrac的小组开发环境搭建作为一个小组级的开发环境，版本控制系统和BUG跟踪系统等都涉及到用户认证部分。如何方

28、便的将这些系统集成起来是一个非常困难的事情，毕竟我们不能指望 Linux下有像Source Offsite那样集成度很高的版本控制/BUG跟踪集成系统。我个人是很反对使用pserver模式的远程用户认证的，但如果大部分组员使用WINDOWS客户端进行开发的话，总体来说使用 CVSROOT/passwd认证还是很难避免的，但CVS本身用户的管理比较麻烦。本来我打算自己用perl写一个管理界面的，直到我发现了 CVSTrac： 一个基于WEB界面的BUG跟踪系统，它外挂在CVS系统上的BUG跟踪系统，其中就包括了WEB界面的CVSROOT/passwd文件的管理，甚至还 集成了WIKIWIKI讨论

29、组功能。 这里首先说一下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/zKl2setup:aISQuNAAoY3qwtest:hwEpz/BX.rEDU 映射系统用户