Appendix A. Obtaining FreeBSD

As of December 2020, FreeBSD uses git as the primary version control system for storing all of FreeBSD’s base source code and documentation.

This section demonstrates how to install Git on a FreeBSD system and use it to create a local copy of a FreeBSD repository. Additional information on the use of Git is included.

Older FreeBSD systems do not have proper root certificates. Installing security/ca_root_nss on these systems allows Git to verify the identity of HTTPS repository servers. The root SSL certificates can be installed from a port:

or as a package:

Git can be installed as a package:

Git can also be installed from the Ports Collection:

To fetch a clean copy of the sources into a local directory, use git. This directory of files is called the working tree.

Git uses URLs to designate a repository, taking the form of protocol://hostname/path. The first component of the path is the FreeBSD repository to access. There are two different repositories, src for the FreeBSD systerm source code, and doc for documentation. In the future a third repository, 'ports' will be available for the FreeBSD ports code. For example, the URL https://git.FreeBSD.org/src.git specifies the main branch of the src repository, using the https protocol.

To get started, clone a copy of the FreeBSD repository:

where:

This example checks out the main branch of the system sources from the FreeBSD repository using the HTTPS protocol, placing the local working copy in /usr/src. If /usr/src is already present but was not created by git, remember to rename or delete it before the checkout. Git will refuse to do anything otherwise.

Because the initial checkout must download the full branch of the remote repository, it can take a while. Please be patient.

After the initial checkout, the local working copy can be updated by running:

To update /usr/src created in the example above, use:

The update is much quicker than a checkout, only transferring files that have changed.

There are also external mirrors maintained by project members available, please refer to the "External mirrors" section.

These are also published as SSHFP records in DNS.

The FreeBSD project currently uses cgit as the web-based repository browser: https://cgit.freebsd.org/ The URL of the indivirual repository is at: https://cgit.freebsd.org/${repo}/

Using git clone and git pull from the official distributed mirrors is recommended. The GeoDNS should direct you to the nearest mirror to you.

This section describes the read-write access for committers to push the commits from developers or contributors. For read-only access, please refer to the users section above.

Those mirrors are not hosted in FreeBSD.org but still maintained by the project members. Users and developers are welcome to pull or browse repositories on those mirrors. The project workflow with those mirrors are still under discussion.

General usage and questions about git in the FreeBSD project: [freebsd-git](https://lists.freebsd.org/mailman/listinfo/freebsd-git)

Commit messages will be sent to the following mailing lists:

For more information, please refer to the "Commit message lists" section of C.2. "Mailing Lists" in handbook: https://www.freebsd.org/doc/en/books/handbook/eresources-mail.html

As of December 2020, FreeBSD uses git as the primary version control system for storing all of FreeBSD’s source code and documentation. Changes from the git repo on the stable/11, stable/12 and related releng branches are exported to the subversion repository. This export will continue through the life of these branches. From July 2012 to March 2021, FreeBSD used Subversion as the only version control system for storing all of FreeBSD’s Ports Collection. As of April 2021, FreeBSD uses git as the only version control system for storing all of FreeBSD’s Ports Collection.

This section demonstrates how to install Subversion on a FreeBSD system and use it to create a local copy of a FreeBSD repository. Additional information on the use of Subversion is included.

FreeBSD systems older than 12.x do not have proper root certificates. Installing security/ca_root_nss on these systems allows Subversion to verify the identity of HTTPS repository servers. The root SSL certificates can be installed from a port:

or as a package:

A lightweight version of Subversion is already installed on FreeBSD as svnlite. The port or package version of Subversion is only needed if the Python or Perl API is needed, or if a later version of Subversion is desired.

The only difference from normal Subversion use is that the command name is svnlite.

If svnlite is unavailable or the full version of Subversion is needed, then it must be installed.

Subversion can be installed from the Ports Collection:

Subversion can also be installed as a package:

To fetch a clean copy of the sources into a local directory, use svn. The files in this directory are called a local working copy.

Subversion uses URLs to designate a repository, taking the form of protocol://hostname/path. The first component of the path is the FreeBSD repository to access. There are three different repositories, base for the FreeBSD base system source code, ports for the Ports Collection, and doc for documentation. For example, the URL https://svn.FreeBSD.org/base/head/ specifies the main branch of the ports repository, using the https protocol.

A checkout from a given repository is performed with a command like this:

where:

This example checks out the Source Tree from the FreeBSD repository using the HTTPS protocol, placing the local working copy in /usr/src. If /usr/src is already present but was not created by svn, remember to rename or delete it before the checkout.

Because the initial checkout must download the full branch of the remote repository, it can take a while. Please be patient.

After the initial checkout, the local working copy can be updated by running:

To update /usr/ports created in the example above, use:

The update is much quicker than a checkout, only transferring files that have changed.

An alternate way of updating the local working copy after checkout is provided by the Makefile in the /usr/ports, /usr/src, and /usr/doc directories. Set SVN_UPDATE and use the update target. For example, to update /usr/src:

The FreeBSD Git repository is:

This is a publicly accessible mirror network that uses GeoDNS to select an appropriate back end server. To view the FreeBSD Subversion repositories through a browser, use https://cgit.freebsd.org.

The FreeBSD Subversion repository is:

This is a publicly accessible mirror network that uses GeoDNS to select an appropriate back end server. To view the FreeBSD Subversion repositories through a browser, use https://svnweb.FreeBSD.org/.

HTTPS is the preferred protocol, but the security/ca_root_nss package will need to be installed in order to automatically validate certificates.

For other information about using Subversion, please see the "Subversion Book", titled Version Control with Subversion, or the Subversion Documentation.