简体中文 ▾ 主题 ▾ 最新版本 ▾ git-cvsserver 最后更新于 2.50.0

名称

git-cvsserver - Git 的 CVS 服务器模拟器

概要

SSH

export CVS_SERVER="git cvsserver"
cvs -d :ext:user@server/path/repo.git co <HEAD_name>

pserver (/etc/inetd.conf)

cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver

用法

git-cvsserver [<options>] [pserver|server] [<directory> …​]

描述

此应用程序是 Git 的 CVS 仿真层。

它功能强大。然而,并非所有方法都已实现,对于已实现的方法,也并非所有开关都已实现。

测试已使用 CLI CVS 客户端和 Eclipse CVS 插件完成。大多数功能在两者上都运行良好。

选项

所有这些选项显然只有在服务器端强制执行时才有意义。它们被实现为尽可能接近 git-daemon[1] 选项。

--base-path <path>

path 添加到请求的 CVSROOT 前

--strict-paths

不允许递归进入子目录

--export-all

不检查配置中的 gitcvs.enabled。如果你想使用此选项,还必须指定一个允许的目录列表(见下文)。

-V
--version

打印版本信息并退出

-h
-H
--help

打印用法信息并退出

<directory>

其余参数提供一个目录列表。如果没有给定目录,则允许所有目录。这些目录中的仓库仍然需要 gitcvs.enabled 配置选项,除非指定了 --export-all

限制

CVS 客户端无法进行标签、分支或执行 Git 合并。

git-cvsserver 将 Git 分支映射到 CVS 模块。这与大多数 CVS 用户预期的非常不同,因为在 CVS 中,模块通常代表一个或多个目录。

安装

  1. 如果你打算通过 pserver 提供 CVS 访问,请在 /etc/inetd.conf 中添加一行,例如

       cvspserver stream tcp nowait nobody git-cvsserver pserver

    注意:某些 inetd 服务器允许你独立于 argv[0] 的值(即程序假定它被执行的名称)指定可执行文件的名称。在这种情况下,/etc/inetd.conf 中的正确行如下所示

       cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver

    pserver 默认只提供匿名访问。要提交,你必须创建 pserver 账户,只需在你希望 cvsserver 允许写入的仓库的配置文件中添加一个 gitcvs.authdb 设置,例如

       [gitcvs]
    	authdb = /etc/cvsserver/passwd

    这些文件的格式是用户名后跟加密密码,例如

       myuser:sqkNi8zPf01HI
       myuser:$1$9K7FzU28$VfF6EoPYCJEYcVQwATgOP/
       myuser:$5$.NqmNH1vwfzGpV8B$znZIcumu1tNLATgV2l6e1/mY8RzhUDHMOaVOeL1cxV3

    你可以使用 Apache 附带的 htpasswd 工具来创建这些文件,但只能使用 -d 选项(如果你的系统支持,则使用 -B)。

    最好使用管理你平台中密码哈希创建的系统特定工具(例如 Linux 中的 mkpasswd、OpenBSD 中的 encrypt 或 NetBSD 中的 pwhash),并将其粘贴到正确的位置。

    然后通过 pserver 方法提供你的密码,例如

       cvs -d:pserver:someuser:somepassword@server:/path/repo.git co <HEAD_name>

    SSH 访问无需特殊设置,只需将 Git 工具添加到 PATH 中即可。如果你的客户端不接受 CVS_SERVER 环境变量,你可以将 git-cvsserver 重命名为 cvs

    注意:较新的 CVS 版本(>= 1.12.11)也支持直接在 CVSROOT 中指定 CVS_SERVER,例如

       cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co <HEAD_name>

    这有一个优点,它将保存在你的 CVS/Root 文件中,你无需担心总是设置正确的环境变量。受限于 git-shell 的 SSH 用户无需使用 CVS_SERVER 覆盖默认值(也不应该),因为 git-shell 理解 cvs 表示 git-cvsserver,并假装另一端运行的是真正的 cvs,这样更好。

  2. 对于你希望通过 CVS 访问的每个仓库,你需要在仓库中编辑配置并添加以下部分。

       [gitcvs]
            enabled=1
            # optional for debugging
    	logFile=/path/to/logfile

    注意:你需要确保每个将调用 git-cvsserver 的用户对日志文件和数据库(参见数据库后端)具有写入权限。如果你希望通过 SSH 提供写入权限,用户当然还需要对 Git 仓库本身具有写入权限。

    你还需要确保每个仓库都是“裸”的(没有 Git 索引文件),以便 cvs commit 能够工作。参见 gitcvs-migration[7]

    所有配置变量也可以针对特定的访问方法进行覆盖。有效的访问方法名称是“ext”(用于 SSH 访问)和“pserver”。以下示例配置将禁用 pserver 访问,同时仍然允许通过 SSH 访问。

       [gitcvs]
            enabled=0
    
       [gitcvs "ext"]
            enabled=1
  3. 如果你没有直接在检出命令中指定 CVSROOT/CVS_SERVER,并自动将其保存在你的 CVS/Root 文件中,那么你需要明确地在你的环境中设置它们。CVSROOT 应该像往常一样设置,但目录应该指向适当的 Git 仓库。如上所述,对于 受限于 git-shell 的 SSH 客户端,CVS_SERVER 应该设置为 git-cvsserver

       export CVSROOT=:ext:user@server:/var/git/project.git
       export CVS_SERVER="git cvsserver"
  4. 对于将进行提交的 SSH 客户端,请确保其服务器端 .ssh/environment 文件(或 .bashrc 等,根据其特定的 shell)导出 GIT_AUTHOR_NAME、GIT_AUTHOR_EMAIL、GIT_COMMITTER_NAME 和 GIT_COMMITTER_EMAIL 的适当值。对于登录 shell 为 bash 的 SSH 客户端,.bashrc 可能是一个合理的替代方案。

  5. 客户端现在应该能够检出项目。使用 CVS 模块 名称来指示你想要检出哪个 Git head。这也会设置你新检出目录的名称,除非你使用 -d <dir-name> 另行指定。例如,这将把 master 分支检出到 project-master 目录

       cvs co -d project-master master

数据库后端

git-cvsserver 为每个 Git head(即 CVS 模块)使用一个数据库来存储仓库信息,以保持一致的 CVS 修订号。每次提交后都需要更新(即写入)数据库。

如果提交是直接通过使用 git 完成的(而不是使用 git-cvsserver),则更新将在 git-cvsserver 的下一次仓库访问时发生,而与访问方法和请求的操作无关。

这意味着即使你只提供读取访问(例如通过使用 pserver 方法),git-cvsserver 也应该对数据库具有写入权限才能可靠地工作(否则你需要确保在执行 git-cvsserver 的任何时候数据库都是最新的)。

默认情况下,它使用 Git 目录中的 SQLite 数据库,命名为 gitcvs.<module-name>.sqlite。请注意,SQLite 后端在写入时会在与数据库文件相同的目录中创建临时文件,因此仅授予使用 git-cvsserver 的用户对数据库文件的写入权限可能不足,还需要授予他们对目录的写入权限。

在它跟踪的分支更改后,数据库无法以一致的形式可靠地重新生成。示例:对于合并的分支,git-cvsserver 只跟踪一个开发分支,在 git merge 之后,增量更新的数据库可能跟踪与从头重新生成的数据库不同的分支,导致 CVS 修订号不一致。git-cvsserver 无法知道如果它在合并前增量运行会选择哪个分支。因此,如果你必须完全或部分(从旧备份)重新生成数据库,你应该对预先存在的 CVS 沙盒持怀疑态度。

你可以使用以下配置变量配置数据库后端

配置数据库后端

git-cvsserver 使用 Perl DBI 模块。在更改这些变量时,也请阅读其文档,特别是关于 DBI->connect()

gitcvs.dbName

数据库名称。确切含义取决于所选的数据库驱动程序,对于 SQLite,这是一个文件名。支持变量替换(见下文)。不能包含分号(;)。默认值:%Ggitcvs.%m.sqlite

gitcvs.dbDriver

使用的 DBI 驱动程序。你可以在此处指定任何可用的驱动程序,但它可能无法工作。cvsserver 已使用 DBD::SQLite 进行测试,据报告可与 DBD::Pg 配合使用,但据报告 不能DBD::mysql 配合使用。请将此视为实验性功能。不能包含冒号(:)。默认值:SQLite

gitcvs.dbuser

数据库用户。仅在设置 dbDriver 时有用,因为 SQLite 没有数据库用户的概念。支持变量替换(见下文)。

gitcvs.dbPass

数据库密码。仅在设置 dbDriver 时有用,因为 SQLite 没有数据库密码的概念。

gitcvs.dbTableNamePrefix

数据库表名前缀。支持变量替换(见下文)。任何非字母字符都将替换为下划线。

所有变量也可以按访问方法设置,参见上文

变量替换

dbDriverdbUser 中,你可以使用以下变量

%G

Git 目录名

%g

Git 目录名,其中除字母数字字符、.- 之外的所有字符都替换为 _(这应该使得在文件名中使用目录名更容易)

%m

CVS 模块/Git head 名称

%a

访问方法(“ext”或“pserver”之一)

%u

运行 git-cvsserver 的用户名。如果无法确定名称,则使用数字 uid。

环境变量

这些变量在某些情况下无需命令行选项,从而可以通过 git-shell 更容易地限制使用。

GIT_CVSSERVER_BASE_PATH

此变量替换 --base-path 的参数。

GIT_CVSSERVER_ROOT

此变量指定单个目录,替换 <directory>... 参数列表。仓库仍然需要 gitcvs.enabled 配置选项,除非指定了 --export-all

设置这些环境变量后,不能使用相应的命令行参数。

Eclipse CVS 客户端说明

要使用 Eclipse CVS 客户端进行检出

  1. 选择“创建新项目 → 从 CVS 检出”

  2. 创建新位置。有关如何选择正确协议的详细信息,请参阅下面的说明。

  3. 浏览可用的 模块。它将为你提供仓库中 head 的列表。你将无法从那里浏览树。只能浏览 head。

  4. 当它询问要检出哪个分支/标签时,选择 HEAD。取消选中“启动提交向导”以避免提交 .project 文件。

协议说明:如果你使用 pserver 进行匿名访问,只需选择它。使用 SSH 访问的用户应选择 ext 协议,并在 Preferences→Team→CVS→ExtConnection 面板上配置 ext 访问。将 CVS_SERVER 设置为“git cvsserver”。请注意,使用 ext 时密码支持不佳,你肯定需要设置 SSH 密钥。

或者,你可以直接使用 Eclipse 提供的非标准 extssh 协议。在这种情况下,CVS_SERVER 将被忽略,你将不得不将服务器上的 cvs 工具替换为 git-cvsserver,或者操作你的 .bashrc,以便调用 cvs 实际上调用 git-cvsserver

已知可用的客户端

  • Debian 上的 CVS 1.12.9

  • MacOSX 上的 CVS 1.11.17(来自 Fink 包)

  • MacOSX 上的 Eclipse 3.0, 3.1.2(参见 Eclipse CVS 客户端说明)

  • TortoiseCVS

支持的操作

支持正常使用所需的所有操作,包括检出、diff、状态、更新、日志、添加、删除、提交。

大多数读取 CVS 标签或修订号的 CVS 命令参数(通常是 -r)都有效,并且还支持任何 git refspec(标签、分支、提交 ID 等)。但是,非默认分支的 CVS 修订号模拟不佳,并且 cvs log 根本不显示标签或分支。(非主分支 CVS 修订号表面上类似于 CVS 修订号,但它们实际上直接编码了 git 提交 ID,而不是表示自分支点以来的修订次数。)

请注意,有两种方法可以检出特定分支。如本页其他地方所述,cvs checkout 的“module”参数被解释为分支名称,并成为主分支。即使你暂时使用 cvs update -r 使另一个分支具有粘性,它对于给定的沙盒仍然是主分支。或者,-r 参数可以指示要实际检出的其他分支,即使模块仍然是“主”分支。权衡(目前实现):每个新“模块”在磁盘上创建一个新数据库,其中包含给定模块的历史记录,数据库创建后,针对该主分支的操作很快。或者,-r 不需要任何额外的磁盘空间,但对于许多操作(如 cvs update)可能会显著变慢。

如果你想引用一个包含 CVS 不允许的字符的 git refspec,你有两个选择。首先,直接将 git refspec 提供给适当的 CVS -r 参数可能就有效;一些 CVS 客户端似乎对参数没有进行太多健全性检查。其次,如果失败,你可以使用一种特殊的字符转义机制,该机制只使用 CVS 标签中有效的字符。形式为(下划线 ("_")、破折号 ("-")、一个或两个字符和破折号 ("-"))的 4 或 5 个字符序列可以根据一个或两个字母编码各种字符:"s" 代表斜杠 ("/"),"p" 代表句点 ("."),"u" 代表下划线 ("_"),或两个十六进制数字代表任何字节值(通常是 ASCII 数字,或者可能是 UTF-8 编码字符的一部分)。

此阶段不支持旧版监控操作(edit、watch 及相关操作)。不支持导出和标记(标签和分支)。

CRLF 行结束符转换

默认情况下,服务器将所有文件的 -k 模式留空,这使得 CVS 客户端将它们视为文本文件,在某些平台上会进行行尾转换。

你可以通过设置 gitcvs.usecrlfattr 配置变量,使服务器使用行尾转换属性来设置文件的 -k 模式。有关行尾转换的更多信息,请参见 gitattributes[5]

或者,如果未启用 gitcvs.usecrlfattr 配置或属性不允许对文件名进行自动检测,则服务器将使用 gitcvs.allBinary 配置作为默认设置。如果设置了 gitcvs.allBinary,则未另行指定的文件将默认为 -kb 模式。否则,-k 模式将留空。但如果 gitcvs.allBinary 设置为“guess”,则将根据文件内容猜测正确的 -k 模式。

为了与 cvs 保持最佳一致性,最好通过将 gitcvs.usecrlfattr 设置为 true,并将 gitcvs.allBinary 设置为“guess”来覆盖默认值。

依赖项

git-cvsserver 依赖于 DBD::SQLite。

GIT

Git[1] 套件的一部分