git: a3ad91f11f - main - Handbook: adjust for the various git migrations.
Rene Ladan
rene at FreeBSD.org
Tue Apr 6 19:11:02 UTC 2021
The branch main has been updated by rene:
URL: https://cgit.FreeBSD.org/doc/commit/?id=a3ad91f11fea5cc457eb053c46c26e4dd43df599
commit a3ad91f11fea5cc457eb053c46c26e4dd43df599
Author: Rene Ladan <rene at FreeBSD.org>
AuthorDate: 2021-04-06 18:59:06 +0000
Commit: Rene Ladan <rene at FreeBSD.org>
CommitDate: 2021-04-06 19:00:09 +0000
Handbook: adjust for the various git migrations.
- prefer to install git as a package over building it oneself.
- update dates in in the introduction
- let some Subversion URLs move to the src repository, as it is the only
repository with an Subversion exporter active.
- let the user install git instead of subversion for doing ports work.
Reviewed by: emaste, mat
Differential Revision: https://reviews.freebsd.org/D29450
---
.../en/books/handbook/cutting-edge/_index.adoc | 2 +-
.../content/en/books/handbook/mirrors/_index.adoc | 21 ++++++++++---------
.../content/en/books/handbook/ports/_index.adoc | 24 +++++++++++-----------
3 files changed, 24 insertions(+), 23 deletions(-)
diff --git a/documentation/content/en/books/handbook/cutting-edge/_index.adoc b/documentation/content/en/books/handbook/cutting-edge/_index.adoc
index ee11b2951b..fe9e5503fb 100644
--- a/documentation/content/en/books/handbook/cutting-edge/_index.adoc
+++ b/documentation/content/en/books/handbook/cutting-edge/_index.adoc
@@ -656,7 +656,7 @@ Read [.filename]#/usr/src/UPDATING#. Any manual steps that must be performed bef
=== Updating the Source
FreeBSD source code is located in [.filename]#/usr/src/#.
-The preferred method of updating this source is through the Subversion version control system.
+The preferred method of updating this source is through the Git version control system.
Verify that the source code is under version control:
[source,shell]
diff --git a/documentation/content/en/books/handbook/mirrors/_index.adoc b/documentation/content/en/books/handbook/mirrors/_index.adoc
index dc6d122428..f0be132b3c 100644
--- a/documentation/content/en/books/handbook/mirrors/_index.adoc
+++ b/documentation/content/en/books/handbook/mirrors/_index.adoc
@@ -427,19 +427,19 @@ or as a package:
[[git-install]]
=== Installation
-Git can be installed from the Ports Collection:
+Git can be installed as a package:
[source,shell]
....
-# cd /usr/ports/devel/git
-# make install clean
+# pkg install git
....
-Git can also be installed as a package:
+Git can also be installed from the Ports Collection:
[source,shell]
....
-# pkg install git
+# cd /usr/ports/devel/git
+# make install clean
....
[[git-usage]]
@@ -706,10 +706,11 @@ For more information, please refer to the "Commit message lists" section of C.2.
[[svn-intro]]
=== Introduction
-As of July 2012, FreeBSD uses Subversion as the only version control system for storing all of FreeBSD's Ports Collection.
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.
[NOTE]
====
@@ -778,7 +779,7 @@ Move or delete an existing destination directory before using `checkout` for the
Checkout over an existing non-`svn` directory can cause conflicts between the existing files and those brought in from the repository.
====
-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/ports/head/` specifies the main branch of the ports repository, using the `https` protocol.
+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:
@@ -793,11 +794,11 @@ where:
* _branch_ depends on the repository used. `ports` and `doc` are mostly updated in the `head` branch, while `base` maintains the latest version of -CURRENT under `head` and the respective latest versions of the -STABLE branches under `stable/9` (9._x_) and `stable/10` (10._x_).
* _lwcdir_ is the target directory where the contents of the specified branch should be placed. This is usually [.filename]#/usr/ports# for `ports`, [.filename]#/usr/src# for `base`, and [.filename]#/usr/doc# for `doc`.
-This example checks out the Ports Collection from the FreeBSD repository using the HTTPS protocol, placing the local working copy in [.filename]#/usr/ports#. If [.filename]#/usr/ports# is already present but was not created by `svn`, remember to rename or delete it before the checkout.
+This example checks out the Source Tree from the FreeBSD repository using the HTTPS protocol, placing the local working copy in [.filename]#/usr/src#. If [.filename]#/usr/src# is already present but was not created by `svn`, remember to rename or delete it before the checkout.
[source,shell]
....
-# svn checkout https://svn.FreeBSD.org/ports/head /usr/ports
+# svn checkout https://svn.FreeBSD.org/base/head /usr/src
....
Because the initial checkout must download the full branch of the remote repository, it can take a while. Please be patient.
@@ -813,7 +814,7 @@ To update [.filename]#/usr/ports# created in the example above, use:
[source,shell]
....
-# svn update /usr/ports
+# svn update /usr/src
....
The update is much quicker than a checkout, only transferring files that have changed.
diff --git a/documentation/content/en/books/handbook/ports/_index.adoc b/documentation/content/en/books/handbook/ports/_index.adoc
index 2da3bfaabc..7df5c7c6d4 100644
--- a/documentation/content/en/books/handbook/ports/_index.adoc
+++ b/documentation/content/en/books/handbook/ports/_index.adoc
@@ -610,40 +610,40 @@ When using `fetch`, the `extract` or the `update` operation may be run consecuti
....
****
-[[ports-using-subversion-method]]
+[[ports-using-git-method]]
[.procedure]
****
-*Procedure: Subversion Method*
+*Procedure: Git Method*
-If more control over the ports tree is needed or if local changes need to be maintained, Subversion can be used to obtain the Ports Collection. Refer to link:{committers-guide}#subversion-primer[the Subversion Primer] for a detailed description of Subversion.
+If more control over the ports tree is needed or if local changes need to be maintained, Git can be used to obtain the Ports Collection. Refer to link:{committers-guide}#git-primer[the Git Primer] for a detailed description of Git.
-. Subversion must be installed before it can be used to check out the ports tree. If a copy of the ports tree is already present, install Subversion like this:
+. Git must be installed before it can be used to check out the ports tree. If a copy of the ports tree is already present, install Git like this:
+
[source,shell]
....
-# cd /usr/ports/devel/subversion
+# cd /usr/ports/devel/git
# make install clean
....
+
-If the ports tree is not available, or pkg is being used to manage packages, Subversion can be installed as a package:
+If the ports tree is not available, or pkg is being used to manage packages, Git can be installed as a package:
+
[source,shell]
....
-# pkg install subversion
+# pkg install git
....
+
. Check out a copy of the ports tree:
+
[source,shell]
....
-# svn checkout https://svn.FreeBSD.org/ports/head /usr/ports
+# git clone https://git.FreeBSD.org/ports.git /usr/ports
....
+
-. As needed, update [.filename]#/usr/ports# after the initial Subversion checkout:
+. As needed, update [.filename]#/usr/ports# after the initial Git checkout:
+
[source,shell]
....
-# svn update /usr/ports
+# git -C /usr/ports pull
....
****
@@ -806,7 +806,7 @@ It is recommended to read the messages as the port is uninstalled. If the port h
Over time, newer versions of software become available in the Ports Collection. This section describes how to determine which software can be upgraded and how to perform the upgrade.
-To determine if newer versions of installed ports are available, ensure that the latest version of the ports tree is installed, using the updating command described in either <<ports-using-portsnap-method, “Portsnap Method”>> or <<ports-using-subversion-method, “Subversion Method”>>. On FreeBSD 10 and later, or if the system has been converted to pkg, the following command will list the installed ports which are out of date:
+To determine if newer versions of installed ports are available, ensure that the latest version of the ports tree is installed, using the updating command described in either <<ports-using-portsnap-method, “Portsnap Method”>> or <<ports-using-git-method, “Git Method”>>. On FreeBSD 10 and later, or if the system has been converted to pkg, the following command will list the installed ports which are out of date:
[source,shell]
....
@@ -1049,7 +1049,7 @@ Scanning //usr/share/certs/trusted for certificates...
[source,shell]
....
-# poudriere ports -c -p local -m svn+https
+# poudriere ports -c -p local -m git+https
[00:00:00] Creating local fs at /poudriere/ports/local... done
[00:00:00] Checking out the ports tree... done
....
More information about the dev-commits-doc-all
mailing list