git-tfs 项目技术文档

1. 安装指南

1.1 获取稳定版本

要获取 git-tfs 的稳定版本，您可以选择以下两种方式之一：

• 下载二进制文件：您可以在 release 页面 找到并下载最新的二进制文件。
• 使用 Chocolatey：如果您的计算机上已经安装了 Chocolatey，可以通过运行以下命令来安装 git-tfs：

  choco install gittfs
  

1.2 获取开发版本

如果您需要获取开发版本，可以选择以下两种方式之一：

• 从源代码构建：请参考 Building 部分获取更多信息。
• 下载开发版本包：您可以从 AppVeyor 的构建页面 下载最新的开发版本包（位于 artifacts 部分）。

1.3 配置环境变量

无论您通过哪种方式获取 git-tfs，都需要确保 git-tfs.exe 在您的 PATH 环境变量中。您可以通过以下命令临时设置 PATH 变量：

set PATH=%PATH%;%cd%\GitTfs\bin\Debug

2. 项目的使用说明

2.1 环境要求

在使用 git-tfs 之前，您需要确保以下条件已满足：

• .NET 4.6.2：git-tfs 需要 .NET 4.6.2 运行时。
• Team Explorer：您需要安装 2012 或 2013 版本的 Team Explorer（或 Visual Studio），具体取决于您要连接的 TFS 版本。

2.2 帮助命令

git-tfs 提供了详细的帮助命令，您可以通过以下命令获取帮助信息：

# 列出所有可用命令
git tfs help

# 查看特定命令的使用说明
git tfs help <command>

2.3 克隆 TFS 仓库

您可以通过以下命令克隆 TFS 仓库：

# 列出可克隆的 TFS 分支
git tfs list-remote-branches http://tfs:8080/tfs/DefaultCollection

# 克隆整个仓库（可能需要较长时间）
git tfs clone http://tfs:8080/tfs/DefaultCollection $/some_project <dist_folder_where_to_clone>

# 快速克隆（仅克隆最新变更集）
git tfs quick-clone http://tfs:8080/tfs/DefaultCollection $/some_project <dist_folder_where_to_clone>

2.4 工作流程

在克隆仓库后，您可以开始使用 git 进行工作：

cd some_project
git log # 查看 TFS 历史记录

# 进行工作...

# 从 TFS 获取最新变更
git tfs fetch

2.5 提交变更

您可以通过以下命令将变更提交到 TFS：

# 将所有 git 提交报告到 TFS
git tfs rcheckin

# 使用 TFS 的提交窗口提交
git tfs checkintool

# 提交并附带消息
git tfs checkin -m "Did stuff"

# 暂存变更
git tfs shelve MY_AWESOME_CHANGES

3. 项目API使用文档

git-tfs 提供了丰富的命令行接口，以下是一些常用命令的简要说明：

3.1 仓库设置

• list-remote-branches：列出可克隆或初始化的 TFS 分支。
• clone：克隆 TFS 路径或分支及其历史记录到 git 仓库。
• quick-clone：克隆特定变更集的 TFS 路径或分支。
• bootstrap：引导现有的 git-tfs 仓库。
• init：初始化 git-tfs 仓库（不获取变更集）。

3.2 从 TFS 拉取

• fetch：从 TFS 获取变更集并更新 TFS 远程。
• pull：从 TFS 获取变更集，更新 TFS 远程并更新工作区。
• unshelve：将 TFS 暂存集获取到您的仓库。
• shelve-list：列出 TFS 暂存集。
• labels：获取 TFS 标签。

3.3 推送到 TFS

• rcheckin：将 git 提交复制为 TFS 变更集。
• checkin：将 git 提交作为一个 TFS 变更集提交。
• checkintool：使用 TFS 的提交对话框提交。
• shelve：从 git 提交创建暂存集。
• shelve-delete：删除 TFS 上的暂存集。

3.4 管理 TFS 分支

• branch：管理（初始化、创建、删除）TFS 分支。

3.5 其他命令

• info：获取 git-tfs 和 TFS 的相关信息。
• cleanup：清理 git-tfs 的内部对象。
• cleanup-workspaces：清理由 git-tfs 创建的 TFS 工作区。
• verify：验证已获取的变更集。
• subtree：使用 git-tfs 管理稀疏的 TFS 路径。
• reset-remote：将 TFS 远程重置为之前的变更集以重新获取其历史记录。
• checkout：通过变更集 ID 检出提交。

4. 项目安装方式

4.1 通过 Chocolatey 安装

如果您已经安装了 Chocolatey，可以通过以下命令安装 git-tfs：

choco install gittfs

4.2 从源代码构建

如果您需要从源代码构建 git-tfs，请按照以下步骤操作：

1. 获取源代码：

   git clone git://github.com/git-tfs/git-tfs.git
   cd git-tfs\src
   

2. 使用 Cake 构建并运行单元测试：

   .\build.ps1
   

3. 获取构建目标的帮助信息：

   .\build.ps1 -Target "Help"
   

4.3 下载开发版本

您可以从 AppVeyor 的构建页面 下载最新的开发版本包。

---

通过以上文档，您应该能够顺利安装、使用并了解 git-tfs 项目的各项功能。如有任何问题，请参考项目的 troubleshooting 页面或提交问题报告。