Term |
Meaning |
Base |
The revision in the repository that you checked out to be your local Working Copy. Also called the checked out revision.
|
Check-in
|
To save your working copy of the file into the repository. Referred to as Commit in Altium Designer.
|
Check-out
|
To take a copy of a file from the VCS repository into a working folder. This is generally the latest revision of the file, but all earlier revisions can also be checked out. Depending on the VCS, the file can be flagged as simply checked-out, or checked-out exclusively (locked).
|
Clone
|
A Git command that copies (clones) a remote Git repository to a working Git repository in a local folder, while automatically checking out the HEAD (latest) version to the folder. The local repository includes the link reference to the remote repository (origin in this case), so files that are updated in the local working repository may be uploaded to the remote repository using the Push command.
|
Commit
|
Save the working copy of the file back into the repository. Referred to as Check-in in some version control systems. In Altium Design Software, the normal Save command saves an edited file to the working folder, whereas Commit saves that folder file to the repository as a new revision (version).
|
Conflict
|
The situation when two Altium Designer users attempt to commit changes that affect the same region of the same file. These must be resolved, either using a Merge tool, manually, or by determining which version will dominate (become the new revision).
|
Database
|
The master storage of all the files under version (or source) control - also known as the Repository in practice.
|
Git
|
Git is an open-source version control system. Altium Designer incorporates Git capabilities (through the VCS Provider - Git extension), allowing revisions to be directly tracked and accessed from its Storage Manager and Projects panels.
|
Head
|
The latest revision committed to the version control system.
|
Log message
|
A comment about changes made to a revision when it is checked back in (committed) to the repository. The log messages can be used as a summary of the progress of changes in a file.
|
Project
|
Many version control systems support the concept of a project. A VCS project is a set of related files that can be checked in/out as a set. The VCS may also support other project-type features, such as setting a version number on all files in a project. This is distinct from the concept of an Altium Designer project, which can be added to Version Control using the Add Project Folder to Version Control command.
|
Push
|
To update a remote Git repository with the file(s) in its local working repository – to synchronize the local and remote repositories. This command is available when a file in the local Git repository is newer than its counterpart in the remote Git repository. Notionally the compliment of a Git Pull command.
|
Repository
|
The master storage of all the files under version (or source) control - can also be known as the Database.
|
Revision
|
A committed change in the history of a file or set of files. This is the alpha-numerical reference supplied by the VCS to track the different editions (versions) it is holding of the file.
|
Sandbox
|
The folder where files are checked out to from the repository, so they can be worked on - also referred to as the Working Folder. Files checked out from Altium Design Software are automatically loaded.
|
SVN |
Subversion is an open source version control system. Altium Designer incorporates SVN capabilities (through the VCS Provider - SVN extension), allowing revisions to be directly tracked and accessed from its Storage Manager and Projects panels.
|
Update
|
The act of checking for and 'pulling in' changes from the repository version of a file to a working copy (the complement of Commit, or Check-in). The process of merging in any differences requires a Merge tool, or manual updating.
|
VCS
|
Version Control System: A generic term applied to any tool that is capable of managing file version history and file retrieval.
|
Version
|
The term version is normally used to refer to the external reference number allocated by a human to the controlled files, or their output (such as in the case of source code). Most often this is considered as a revision. |
Working Copy
|
The 'local' copy of a file that changes are made to - normally resides in the Working Folder.
|
Working Folder
|
The folder to which files are checked out from the repository so they can be worked on – with Git, this is a local Working Repository. Files checked out from Altium Designer are automatically loaded.
|