使用外部版本控制

概览

在 Altium Designer 中,使用外部 Git 或 Subversion 版本控制来跟踪设计变更。本文介绍如何使用已连接的工作区之外的存储库,说明如何访问版本控制命令和文件状态信息,并概述对多用户协同设计的支持。继续阅读,掌握管理设计文件及其修订历史的方法。

- 了解 Git 和 SVN 存储库工作流程之间的基本差异。
- 了解在 Projects 和 Storage Manager 面板中何处查看文件状态、访问修订历史以及执行版本控制操作。
- 探索原理图和 PCB 比较功能如何支持团队协作处理共享设计。
使用 AI 深入了解:

使用受版本控制的项目时,最先进的方式是利用 已连接的工作区的功能。工作区提供了高级项目架构,可简化工作流程和存储、增强协作能力,并提供更多功能。

工作区中的目标 VCS 存储库与工作区及 Altium Designer(登录后)紧密集成,因此无需设置和配置单独的 VCS 存储库。用户访问权限、存储库内容和项目状态均可通过工作区的浏览器界面进行管理。如果您使用的是已连接工作区的内部 VCS,则本页信息不适用于您。

本文档详细介绍了使用外部版本控制的基本方法,即存储库不托管在已连接的工作区中的情况。这包括本地、通过所连接的网络或由专用 VCS 服务器产品提供的版本控制存储库。如果您使用外部 VCS,请继续阅读。

电子创作和编辑环境的最大优势之一,就是能够轻松创建和修改文件。这意味着可以快速记录、探索并完善想法,但也意味着可能难以跟踪源代码和电子设计数据等重要文件的更改。

跟踪文件更改的需求,以及以系统化方式管理电子形式源文件的需求,催生了版本控制系统(VCS)。版本控制系统是一类软件工具,不仅能够保留文件各个版本的历史记录,还支持打开该文件的任意修订版,以及比较文件任意两个版本之间的更改。VCS 通常会通过为文件夹和文件提供额外的版本控制功能和操作,与本地操作系统(OS)集成。

版本控制系统可以完全独立于创建文件时使用的创作和编辑环境运行。它们通常提供一个界面,允许您先添加文件,再将其提交到称为存储库的集中存储区域;此外,还提供将文件从存储库复制到工作文件夹的检出功能、将更改签入存储库的提交功能、记录更改相关信息的方法,以及更多功能。

这些功能可在 Tortoise 客户端 等 Windows Shell 扩展中找到,Altium Designer 本身也包含这些功能。您可以在 Altium Designer 环境中执行 VCS 操作,而无需访问操作系统的文件系统。

了解版本控制系统使用的术语会很有帮助。虽然可用的系统种类繁多,但它们通常使用类似的术语来描述其功能。

版本控制基础

Altium Designer 支持 Subversion(SVN)和 Git 版本控制系统(VCS)。由于内置了对这些系统的支持,您可以直接在 Altium Designer 中使用提交、更新等常见 SVN/Git 文件处理命令,以及创建 SVN 存储库等其他 Subversion 功能。这些功能与原理图和 PCB 比较功能相结合,可轻松快速比较并识别原理图或 PCB 文档两个修订版之间的差异,并可针对 PCB 设计解决并行修订冲突。

使用版本控制系统(VCS)的基本方法是:从存储库获取要处理的项目文件副本,在 Altium Designer 中编辑文件,然后将修改后的文件“提交”回存储库。与存储库的交互通过版本控制系统界面进行,Altium Designer 已将该界面内置于存储管理器面板 和项目面板中。

版本控制系统的工作关键在于,它会通过工作文件夹监控从存储库获取的文件的状态,从而跟踪当前正在处理的修订版,以及该修订版是否已被修改。虽然最终效果相同,但不同类型的版本控制系统(Git 或 SVN)在存储库和工作文件的组织方式上有所不同。

请确保 Altium Designer 中已安装 VCS Provider - SVN 和 VCS Provider - Git 软件扩展。 这些扩展默认随 Altium Designer 一起安装,也可以手动安装或移除。

有关管理扩展的更多信息,请参阅 Extending Your Installation 页面(Altium Designer Develop、Altium Designer Agile、Altium Designer)。

Git VCS

下图展示了远程 Git 共享存储库的概念,该存储库保存了一系列设计文件修订版(最高为修订版 5),其内容已复制到本地工作 Git 存储库中,通常是通过克隆远程存储库或将其数据拉取到工作存储库来完成。在 Altium Designer 环境中打开工作存储库中的文件时,Altium Designer 会识别出项目文件受 Git 版本控制,并在 Storage Manager 和 Projects 面板中显示其当前的版本控制状态。

Concept image showing how the files are managed by the Git Version Control System

► 更多信息,请参阅基于 Git 的版本控制页面。

Subversion VCS

下图展示了 Subversion 存储库的概念,该存储库保存了一系列设计文件修订版(最高为修订版 5),其最新副本已检出(File » Check Out)到工作文件夹中。在 Altium Designer 环境中打开工作文件夹中的文件时,Altium Designer 会识别出项目文件受 SVN 版本控制,并在 Storage Manager 和 Projects 面板中显示其当前的版本控制状态。

Concept image showing how the files are managed by the Subversion Version Control System

► 更多信息,请参阅基于 SVN 的版本控制页面。

在上述两种 VCS 系统中,源存储库与工作位置之间的关联均记录在后者的 VCS 数据库中(位于 .svn 或 .git 系统子文件夹中)。

在 Altium Designer 中打开 VCS 工作文件后,您可以通过 Storage Manager 面板(以及 Projects 面板)中的右键菜单执行标准 VCS 操作,例如将已更改的文件提交到中央存储库(SVN)或工作存储库(Git)。

访问版本控制功能

在 Altium Designer 中,可以通过项目和存储管理器面板执行 VCS 相关操作,后者还提供对其他 VCS 命令和信息的直接访问。在 Altium Designer 中打开项目文档后,这些面板会显示项目文档及其相关的 VCS 状态。

可以通过工作区右下角的 按钮菜单,或通过主 View » Panels 菜单打开这些面板。

项目面板

Projects 面板显示当前在 Altium Designer 中打开的所有项目,以及项目所包含的文档和每个文件对应的版本控制状态。

面板中的 VCS 文件状态通过一系列图标表示,这些图标对应于版本控制系统检测到的特定文件状况。一般而言,每个文件的状态都是相对于关联存储库中受版本控制的对应文件而言的。要访问 Projects 面板中的 VCS 命令,请在面板的右键快捷菜单中选择 Version Control 选项。

Projects 面板中显示的版本控制图标Projects 面板中显示的版本控制图标

只有在 Preferences 对话框的 系统 – Projects 面板 页面上选中 Show VCS status 选项(位于 General 下)后,面板才会显示 VCS 状态图标。可能需要重新启动才能使更改生效。

► 有关更多信息,请参阅 Projects 面板页面。

Storage Manager 面板

Storage Manager 面板从文件存储的角度提供活动文档的详细视图,并可用于访问本地文档历史记录功能以及版本控制状态和命令。

面板中的 VCS 文件状态通过一系列说明及对应图标表示,这些说明和图标对应于版本控制系统检测到的特定文件状况。一般而言,每个文件的状态都是相对于关联存储库中受版本控制的对应文件而言的。

Storage Manager 面板Storage Manager 面板

可从右键快捷菜单访问 Storage Manager 面板中的 VCS 命令。要对特定文件执行 VCS 操作,请右键单击面板中该文件的条目,然后选择所需命令,例如提交、更新、解决冲突等。

可以在面板下部查看所选文件的修订历史记录和本地文档历史记录;也可以通过右键菜单选项中的 Switch to Classic View 切换到“经典视图”,查看完整的事件时间线。每次执行 VCS 提交时,显示的修订号都会递增,其中第一个修订(修订版 1)对应于添加文件之前创建 VCS 项目文件夹的操作。

► 有关更多信息,请参阅 Storage Manager 面板页面。

版本控制状态

在 Projects 和 Storage Manager 面板中,每个受版本控制的文件的当前 VCS 状态都会与其条目一起显示在面板中。

版本控制系统主要用于监视工作文件夹中的文件,并将其与设计存储库中的对应文件进行比较。Altium Designer 通过其 VCS 接口向版本控制系统请求信息并与之交换信息,然后根据文件的比较状态作出相应响应。实际使用时,这会体现在 Projects 和 Storage Manager 面板的文件图标、各种 VCS 提示以及可用文件管理命令的相应变化中。

有关图标及其含义的说明,请参阅 管理项目文档 页面中的 版本控制状态图标部分。

多用户访问

大多数情况下,公司的版本控制基础架构基于中央 SVN 或 Git 存储库,并通过网络使用某种可用协议(如 svn、svn+ssh、https 等)提供服务。这样,网络上的所有用户都可以根据各自的权限进行访问,并以单一来源为基础协同开发项目。

多用户访问功能使不同团队成员能够独立推进项目工作,而不必等待其他人将文件签入后才能处理该文件。分布式 Git 版本控制系统 进一步扩展了这一优势:您可以在工作过程中将文件提交到本地工作存储库,并在之后的任意时间将已提交的更改“推送”回中央 Git 存储库,因此在推送之前无需连接网络。

不过,适合团队使用的 VCS 必须提供相应的工具和方法,以解决两个用户修改同一文件这一不可避免的情况。具备这些能力后,才能为真正的多用户设计协作及其带来的优势奠定基础。

为支持这种情况,Altium Designer 提供了原理图和 PCB 比较(或称“差异比较”)功能,可通过 Storage Manager 面板访问。

VCS 存储库

要基于一组确定的源文件开展工作,最佳方式是将设计项目存储在受控环境中,例如版本控制存储库。这一点很重要,因为要确保输出来自正确的源文件,唯一的方法是:

  1. 确认源文件集是最新的。
  2. 为这些文件创建快照。
  3. 基于该快照生成输出。

在 Altium Designer 中,这类存储库称为 Design Repository。设计存储库由设计团队管理,详细记录了设计过程的历史,也是设计团队使用的主要协作工具。

设计存储库是一个中央存储库,多名团队成员可以从中签出数据或向其签入数据,同时完整保留设计所有更改的修订历史记录。因此,设计以其组成项目和源文档的一系列版本的形式存储,逐步展现设计人员的设计意图如何随时间演变。使用受版本控制的设计存储库,可以从根本上确保任何设计修订都不会丢失,使身处不同地理位置的团队成员也能安全地协作处理同一设计。版本控制系统本身就能为设计提供审计跟踪。系统清晰记录了谁在何时更改了哪个源文档中的哪些内容,从而实现全面的责任追溯。系统支持多个受版本控制的设计存储库,并通过项目文件夹中的版本控制链接建立与特定存储库的关联。

连接到设计存储库,实际上就是向系统注册该存储库,也就是告知 Altium Designer 该存储库的存在。此外,您无法手动指定非正式或“未经授权”的存储库路径。通过 Altium Designer,您只能与已主动连接到系统的基于 VCS 的设计存储库进行交互。

使用版本控制之前,VCS 和 Altium Designer 都必须将项目文件识别为受版本控制的文件。对于不同的 VCS 方法和应用程序,这一过程可能有所不同,但本质上都涉及创建和/或连接设计存储库,并将设计项目文件添加到该存储库。

设计存储库基于数据库结构,在内部以文件和目录的层次结构存储信息,这种结构称为文件树。您实际连接的存储库可以是中央 SVN 存储库、Git 工作存储库(与远程 Git 存储库关联),也可以是您在可访问位置(例如本地 PC 或共享网络位置)创建的存储库。

已连接工作区 VCS

处理受版本控制的项目时,最先进的方式是利用 的功能。已连接的工作区。工作区提供了高级的项目架构,可简化工作流程和存储、增强协作能力,并提供更多功能。

工作区中的目标 VCS 存储库与工作区和 Altium Designer(登录后)紧密集成,因此无需单独设置和配置 VCS 存储库。您可以通过工作区浏览器界面管理用户访问权限、存储库内容以及项目状态。

将新更改更新到版本控制

将项目添加到版本控制后,其本地工作项目文件夹便会关联到 VCS 存储库中的对应文件夹,Storage Manager面板中项目文件夹条目旁的链接图标即表示这种关联。要确认关联文件夹和存储库的位置,请右键单击面板中的任意文件条目,然后选择 VCS Properties 选项(使用 Git 时不可用)。随后显示的 Properties 对话框包含关联位置的路径以及最新 VCS 修订版的信息。

带有链接图标的文件,以及包含最新 VCS 修订版信息的相应 Properties 面板 带有链接图标的文件,以及包含最新 VCS 修订版信息的相应 Properties 面板

 Properties 对话框提供以下信息(信息仅供查看,不允许编辑): 

  • Path - 工作文件夹中本地文档的路径。
  • URL - 文档在 VCS 存储库中所在位置的 URL。
  • Repository Root - 存储库根目录。
  • Repository UUID - 存储库 UUID。
  • Revision - 本地工作文件夹中文档的当前修订版。
  • Last Change Author - 最后一次更改的作者。
  • Last Change Revision - 最后一次更改的修订版。
  • Last Change Time - 最后一次更改的日期和时间。
  • Conflicted - 文档是否存在冲突。

通过已建立的 VCS 关联,版本控制系统可以监视并检测本地项目文件夹中的文件与 VCS 存储库文件夹中对应文件之间的任何差异。检测到差异时(例如在 Altium Designer 中编辑并保存设计文件后),版本控制系统会将本地文件的状态更改为 Modified(),并且 Altium Designer 会在面板的右键菜单中提供一组相应的 VCS 命令。

提交更改

在 Altium Designer 中编辑并保存项目文档文件后,该文件会被标记为 Modified,并在 Projects 和 Storage Manager 面板中显示相应标记()。要将这些更改作为新的修订版提交到 VCS,请右键单击面板中的文件条目,然后从上下文菜单中选择 Commit 命令,或从主菜单中选择 Project » History & Version Control » Commit 命令。

提交文件更改时,将打开 编辑注释对话框。使用此对话框添加注释,说明提交原因,帮助其他人了解所做的更改。如果之前添加过注释,您可以快速选择使用其中一条。

Commit 命令Commit 命令

也可以使用 Commit Whole Project 命令,它会提交项目中所有已修改的文件。提交整个项目时,将打开 Commit to Version Control 对话框。

Commit to Version Control 对话框
Commit to Version Control 对话框

  • When using Subversion (SVN): 提交过程会将更新后的文件从本地文件夹复制到存储库,递增 VCS 条目的修订号,并将文件状态重置为 No Modification()。
  • When using Git: 提交过程会更新本地工作存储库中的 VCS,同时递增条目的修订号,并将文件状态设置为 Ahead of Server()。您可以继续在工作存储库中编辑、保存和提交文件,也可以使用 Push 命令更新远程 Git 存储库,确认这些新更改,此时文件状态将恢复为 No Modification()。

请注意,对于基于 Git 的工作区项目,Commit 和 Commit Whole Project 命令不可用。您可以在 Projects 面板中项目条目的右键菜单中使用 Save to Server 命令,一次性将工作区项目提交到本地存储库并推送到远程存储库。

如有需要,可以在高级设置对话框中启用 VCS.AllowGitCommit 选项,使 Commit 和 Commit Whole Project 命令可用。

项目添加到版本控制后,可以使用针对单个文件的 Add to Version Control 和 Commit 命令,逐个添加其他文件并将其提交到版本控制。同样,也可以使用 Remove from Version Control 命令,单独将特定文件从版本控制中移除(但保留在本地工作项目中)。

查看 Storage Manager 面板,可在 VCS Revisions 部分中查看操作序列,其中包括为该文件创建新的 VCS 修订版(修订号递增)的记录,在本例中为修订版 3 及其添加的注释。 图标表示所选文件的最新修订版和当前修订版,用版本控制术语来说就是 Head 修订版。

 Storage Manager 面板的 VCS 修订版本部分 Storage Manager 面板的 VCS 修订版本部分

要同时查看修订版本和历史事件条目,请从右键菜单中选择 Switch to Combined View,切换到单一时间线视图。

从版本控制系统签出

如上所述,已添加到版本控制的本地工程可以通过 Altium Designer 从工程的本地文件夹进行编辑,然后将更改更新到 VCS 仓库。本地文件夹和仓库文件夹由 VCS 关联,并最终保持同步。

其他用户无法从工程的源文件夹(位于您的 PC 本地)访问工程,但可以使用克隆(Git)或 签出 (SVN)流程,从托管该工程的 VCS 仓库获取自己的文件副本。所有希望协同进行工程设计的用户都需要连接到这个共用的设计仓库,通常可通过局域网或服务器访问该仓库。

选定的仓库工程文件夹及其包含的文件将被签出到指定的本地文件夹,并在 Altium Designer 中打开。请注意,此本地文件夹是为所选仓库定义的签出文件夹,签出的工程随后会与 VCS 仓库中的对应工程建立关联。VCS 关联会指示版本控制系统监控并检测本地签出文件夹中的文件与 VCS 仓库文件夹中对应文件之间的任何差异。

文件编辑完成后,提交更改,即可同步设计仓库中的文件,使其与签出文件夹中的文件一致,并创建新的 VCS 修订版本。

签出与打开工程的区别

将 local 工程添加到版本控制后,实际上可以通过两种方式对其进行编辑并更新到 VCS:

  • 在 Altium Designer 中打开本地工程(File » Open Project),然后将已保存的更改提交到 VCS 仓库。在这种情况下,本地工程文件夹与仓库中的对应文件夹通过 VCS 关联。

  • 从 VCS 仓库签出工程(File » Check Out),然后将在 Altium Designer 中完成并保存的更改提交回仓库。在这种情况下,指定签出文件夹中的工程与仓库中的对应工程通过 VCS 关联。

本地工程是与其他用户共享的 VCS 工程的源工程。根据您希望采用的工作方式,可以移除此本地源版本,或将其锁定为归档的工程源文件,然后使用 Check Out 方式进行后续编辑。当然,您也可以继续从本地“源”文件夹中打开和处理工程文件(Open Project)。

最佳做法是始终采用一种方式(建议使用签出),因为这两种方式所使用的工作文件夹位置不同:一种是本地源工程文件夹,另一种是指定的 VCS 签出文件夹。反之,如果同时使用这两种方式,本地 PC 上就会存在同一工程的多个活动副本。不过,只要每次编辑后都将这些版本及时提交到集中式 VCS 仓库,仓库就能始终按预期保留工程的最新修订版本。

当本地没有该工程时(例如对于其他用户而言),唯一的选择就是从 VCS 仓库签出工程。

另请注意,工程首次从 VCS 仓库签出后,就会保存在本地,之后可直接从签出文件夹重新打开(File » Open Project)。在这种情况下,同样可以选择从 VCS 签出工程或打开本地版本,但本地始终只有一个副本。从实际的 VCS 操作角度来看,这两种方式非常相似,但在某些情况下表现会有所不同。例如,当本地文件丢失时,签出流程会恢复该文件,而 Open Project 命令则会将其从工程中移除。

版本控制修订版本

在 Altium Designer 中处理受版本控制的设计文档时,从中央(共享)VCS 仓库获取的设计文件代表这些文件的最新修订版本。本地编辑完成并提交(对于 Git,则为推送)回共享 VCS 仓库后,这些文件版本就成为最新修订版本。

因此,随着工程设计的推进,常规的签出、编辑、保存和提交(对于 Git,还包括推送)流程会不断向中央 VCS 添加新的文件修订版本。不过,当多位设计人员协同开发工程时,任何设计人员都可能随时向中央(共享)仓库提交新的修订版本。

过期的修订版本

多位设计人员与中央仓库之间的交互可能体现为多种情况,其中一种就是本地打开的工程不再是最新修订版本:从仓库签出或从本地工作文件夹打开的工程,在 Projects 面板中的状态为 Out of date()。

标记为“过期”的文件标记为“过期”的文件

在这种情况下,自上次在本地编辑该工程以来,其他用户已编辑同一工程并将其提交到仓库。例如,本地用户 Barry 正在处理该工程,并已提交了 Revision 14,但另一位用户 Harold 随后又提交了 Revision 15,如下方的 Storage Manager 面板所示。由于 VCS 检测到本地工作文件夹中的文件与仓库中的对应文件存在差异(在本例中,仓库中的文件较新),系统会将本地最新的 local 修订版本(由 图标指示)判定为过期。

Storage ManagerStorage Manager

中的不同修订版本状态 您可以使用 Altium Designer 的 比较功能来确定文件修订版本之间的差异。

要解决此问题,可以使用 Projects 或 Storage Manager 面板右键菜单中的 Update 命令更新本地文件,使其与中央 VCS 仓库中的文件一致。随后,两个文件版本将保持同步,本地版本(用户 Barry 的版本)会更新为最新修订版本,在本例中为 Revision 15。请注意,如果您对状态为 Out of date 的文件执行 Save,将会导致 VCS Conflict,即 VCS 检测到工作文件夹中某个文件的较早修订版本已被更新。

Storage ManagerStorage Manager

中的中央仓库和本地修订版本您还可以选择 Update Whole Project 命令,打开 Update from Version Control 对话框,在其中选择要从共享仓库签出的文件。 工程中所有已过期或存在冲突的文档都会显示在该对话框中。您可以选择要更新的特定文档,也可以选择一次更新所有文档。所选文档将从仓库更新,默认情况下会选中所有已过期的文档。所有选定文档都将更新为仓库中的最新版本。

Update from Version Control 对话框
Update from Version Control 对话框

 Path 列显示文件目录。 Status 列显示文件的当前状态。如果文件状态显示为 Conflict,单击 OK 更新文件时,将弹出确认对话框。单击 OK 可更新至存储库中的最新版本,或单击 Cancel 退出并将更改保存到存储库中的当前版本。

如果项目是从本地检出文件夹打开,而不是从存储库检出的,则设计文件不会显示 Out of date 状态。Storage Manager 面板中的 Refresh 命令(或 F5 键)可触发 VCS 比较关联文件夹,从而纠正此问题。不过,这种情况也进一步说明,在使用中央 SVN 存储库进行协作时,应从存储库检出项目,而不是直接在本地打开项目。

修订冲突

多位设计人员与中央存储库之间的交互也可能导致以下情况:两位 Altium Designer 用户都在本地编辑并保存了同一个文件,其中一位已提交这些更改。

这意味着,一位设计人员的操作步骤(检出、编辑、保存、提交)与另一位设计人员的操作步骤发生了交错,因此,用户从存储库检出以进行编辑的文件,在编辑过程中可能不再remain为最新修订版——因为另一位用户在此期间更新了修订版。在这种情况下,最先将编辑内容提交到存储库的用户会创建一个新修订版,而另一位编辑并保存了同一文件的用户则会遇到 Conflict 情况,以 图标表示。

修订冲突示例修订冲突示例

从 VCS 的角度来看,它会将工作文件夹中的文件与存储库中的文件进行比较;冲突表示工作文件夹中的某个文件修订版已过时,但又被编辑并保存。

使用 Git 版本控制时,如果两位设计人员都编辑、保存了同一个文件,并将其提交到各自的本地 Git 存储库文件夹,随后其中一位将这些更改推送到中央 Git 存储库(远程存储库),便会产生冲突。请注意,Git VCS 修订版在 Storage 面板中将以 GUID 字符串显示。

Storage Manager 面板中的 Git VCS 修订版Storage Manager 面板中的 Git VCS 修订版

当文件处于 Conflict 状态时,可以使用 Projects 面板的 History & Version Control 右键菜单、 Project » History & Version Control 主菜单以及 Storage Manager 面板中的多个命令选项:

  • Commit – 此选项会触发 Subversion 错误,因为提交本地编辑的修订版(例如 Revision 15)会覆盖另一位用户已提交的较新修订版(Revision 16)。
  • Update – 此选项会将本地文件修订版更新为中央存储库中的最新版本(Revision 16),因此您对 Revision 15 所做的所有本地更改都将丢失。
  • Resolve Conflict – 此选项会丢弃自您上次更新以来提交到存储库的更改。启动该命令后,将出现确认对话框,单击 Yes 继续。工作文件夹中的项目文件将更新为另一位用户检入存储库的最新修订版,但编辑器会保留您对先前修订版所做的更改。因此,本地文件会变为 Modified 状态,您便可使用 Commit 命令或 Commit Whole Project 命令,将这些更改作为新修订版提交到存储库。提交项目文件后,另一位用户会看到文件显示为 Out of date,因为您已在存储库中创建了更新的修订版。

    仅建议在 text 文件发生冲突时使用此选项,因为 Subversion 系统会尝试将差异合并到本地文件中。此过程可能会损坏设计文档等其他类型的文件,因此,解决冲突的最佳方法是更新至最新的源修订版,或还原本地更改。

    使用 Git 时,Resolve Conflict 命令会通过将文件提交到本地存储库文件夹来消除冲突状态。随后将文件推送到远程存储库时,另一位设计人员的文件将被标记为 Out of Date,必须进行更新。不过,与使用 Subversion 时一样,最安全的方法是将冲突文件Update至最新的源修订版(在 Git 中称为拉取),或Revert本地更改。
  • Revert – 此选项会丢弃(撤销)本地更改,将本地文件还原至其基础修订版——此处为 Revision 15。修订冲突由此得到解决,但文件随后将被标记为 Out of date,因为存储库中存在更新的修订版(Revision 16)。

比较修订版

使用版本控制的一大优势是能够比较设计文件的历史修订版。Altium Designer 内置的差异比较器提供了此功能,可从 存储管理器 面板访问。结合使用 差异 面板,可对 VCS 修订版进行逻辑或图形比较,同时以交互方式查看受影响的对象。原理图和 PCB 的修订版均可进行比较。

要比较两个修订版,请在 Storage Manager 面板的 VCS Revisions 列表中选择这两个条目(使用标准的 Ctrl+click 方法),然后从面板的右键上下文菜单中选择 Compare 命令。

您也可以使用 Projects 面板中文档右键菜单中的 History & Version Control » Compare with Head 命令,将当前选中的文档与 VCS 存储库中该文档的最新修订版进行比较。

Storage Manager 面板中的 Compare 命令Storage Manager 面板中的 Compare 命令

两个文件修订版将以分屏模式打开,供您直观比较。显示哪些差异取决于 Options for Project 对话框的 比较器选项卡中为物理比较类型选择的选项——Project » Project Options。

定位和查看比较差异的关键在于 Differences 面板,该面板提供了文档之间逻辑或图形差异的可选列表。面板中各文档修订版的条目与编辑器联动,选择某个检测到的差异(例如对象移动)时,编辑器会以图形方式高亮显示该差异。

在 Differences 面板中定位和查看比较差异在 Differences 面板中定位和查看比较差异

比较功能不仅适用于原理图和文本文档的修订版,也适用于 PCB 文档的修订版。

  • 对于原理图或 PCB(设计或库)文档,系统会进行图形比较,并在 Differences 面板中列出检测到的差异。文档的两个版本在设计编辑器窗口中并排打开后,您便可通过图形方式仔细查看差异。单击某个检测到的差异所对应的顶层文件夹,会在两个文档中同时高亮显示该差异。
  • 对于基于文本的 ASCII 文档, CompareForm 对话框将会出现,以图形方式显示文档两个版本之间的“差异”。所选文档并排显示。此对话框仅用于比较,无法修改已加载的文档。对话框通过颜色编码突出显示两个文档版本之间的各种差异:新增的行(粉色)、修改的行(绿色)和删除的行(蓝色)。对话框左下角显示更改摘要和颜色编码图例。

比较功能比较功能

Compare 命令可用于任意两个修订版之间的比较,包括当前本地修订版(位于工作文件夹中)与存储库中较新的修订版。在这种情况下,最新的本地修订版在 Storage Manager 面板中显示为 Out of date(),但仍可将其与其他用户添加到存储库中的较新修订版进行比较。

本地修订版在 Storage Manager 面板中显示为“已过期”本地修订版在 Storage Manager 面板中显示为“已过期”

通过这种方式,您可以直观地预览更新到新修订版后将引入的更改。在上方示例图中,当前本地修订版(由 图标指示)为 Revision 19,但另一位用户已向存储库提交了新的修订版(Revision 22)。对 Revision 19 和 Revision 22 进行可视化比较后,您便可以在充分了解差异的基础上,决定是否接受存储库中的新更改,进而决定是执行 Update 命令,还是通过重新保存本地文件来引发冲突,并在解决冲突时保留本地版本,从而覆盖存储库中的更改。

版本控制术语

术语 含义
Base

从存储库中检出、用作本地 Working Copy 的修订版。也称为已检出的修订版。

Check-in

将文件的工作副本保存到存储库中。在 Altium Designer 中称为 Commit。

Check-out

将文件的副本从 VCS 存储库提取到工作文件夹中。通常提取的是文件的最新修订版,但也可以检出所有较早的修订版。根据所用的 VCS,文件可以标记为普通检出或独占检出(锁定)。

Clone

一种 Git 命令,用于将远程 Git 存储库复制(克隆)到本地文件夹中的工作 Git 存储库,同时自动将 HEAD(最新)版本检出到该文件夹中。本地存储库包含指向远程存储库的链接引用(此处为 origin),因此,可以使用 Push 命令将本地工作存储库中更新的文件上传到远程存储库。

Commit

将文件的工作副本保存回存储库。在某些版本控制系统中称为 Check-in。在 Altium 设计软件中,常规的 Save 命令将编辑后的文件保存到工作文件夹,而 Commit 则将该文件夹中的文件作为新的修订版(版本)保存到存储库。

Conflict

两位 Altium Designer 用户尝试提交的更改影响同一文件的同一区域时出现的情况。必须使用合并工具、手动处理,或通过确定以哪个版本为准(使其成为新的修订版)来解决这些冲突。

Database

集中存储所有受版本(或源代码)控制的文件的位置,实际使用中也称为 Repository 。

Git

Git 是一种开源版本控制系统。Altium Designer 通过 VCS Provider - Git 扩展集成了 Git 功能,支持直接从 存储管理器和 项目面板跟踪和访问修订版。

Head

提交到版本控制系统的最新修订版。

Log message

将修订版签入(提交)回存储库时,对该修订版所做更改的说明。日志消息可用作文件更改进展的摘要。

Project

许多版本控制系统都支持项目这一概念。VCS 项目是一组相关文件,可以作为一个整体进行签入或检出。VCS 还可能支持其他项目类功能,例如为项目中的所有文件设置版本号。这与 Altium Designer 项目的概念不同,后者可以使用 将项目文件夹添加到版本控制命令添加到版本控制中。

Push

使用本地工作存储库中的文件更新远程 Git 存储库,使本地和远程存储库同步。当本地 Git 存储库中的文件比远程 Git 存储库中的对应文件更新时,此命令可用。从概念上讲,它与 Git Pull 命令互为补充。

Repository

集中存储所有受版本(或源代码)控制的文件的位置,也称为 Database。

Revision

文件或一组文件历史记录中已提交的一次更改。它是 VCS 提供的字母数字标识,用于跟踪系统保存的文件的不同版本。

Sandbox

从存储库检出的文件所存放的文件夹,以便对文件进行处理,也称为 Working Folder。从 Altium 设计软件中检出的文件会自动加载。

SVN

Subversion 是一种开源版本控制系统。Altium Designer 通过 VCS Provider - SVN 扩展集成了 SVN 功能,支持直接从 存储管理器和 项目面板跟踪和访问修订版。

Update

检查存储库中的文件版本是否有更改,并将更改“拉取”到工作副本的操作(与 Commit 或 Check-in 互为补充)。合并差异的过程需要使用合并工具或手动更新。

VCS

版本控制系统:泛指能够管理文件版本历史记录和文件检索的任何工具。

Version

“版本”通常指由人工为受控文件或其输出(例如源代码的输出)分配的外部参考编号。大多数情况下,它被视为修订版。

Working Copy

用于进行更改的文件“本地”副本,通常位于 Working Folder 中。

Working Folder

从存储库检出的文件所存放的文件夹,以便对文件进行处理。对于 Git,这是本地工作存储库。从 Altium Designer 中检出的文件会自动加载。

参考资料

AI-LocalizedAI 翻译
如您发现任何问题,请选中相关文本/图片,并按 Ctrl + Enter 键向我们提交反馈。
Contents
功能可用性

您可使用的功能取决于您所采用的 Altium 解决方案——Altium Develop、Altium Agile Teams、Altium Agile Enterprise,或 Altium Designer(在有效订阅期内)。

如果您在实际软件中未看到文档中介绍的某项功能, 请联系 Altium Sales 了解更多信息。

旧版文档

Altium Designer 文档不再提供版本区分。如果您需要访问 Altium Designer 旧版本的文档,请前往其他安装程序页面的旧版文档部分。

Contents