From owner-dev-commits-doc-all@freebsd.org Sat Apr 10 04:20:40 2021 Return-Path: Delivered-To: dev-commits-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 75D195CEAC9 for ; Sat, 10 Apr 2021 04:20:40 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4FHMHX2JcNz3Lpd; Sat, 10 Apr 2021 04:20:40 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 40A722953; Sat, 10 Apr 2021 04:20:40 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 13A4Kedn078497; Sat, 10 Apr 2021 04:20:40 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 13A4KeaP078496; Sat, 10 Apr 2021 04:20:40 GMT (envelope-from git) Date: Sat, 10 Apr 2021 04:20:40 GMT Message-Id: <202104100420.13A4KeaP078496@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Warner Losh Subject: git: bde30a020c - main - mirrors: be consistent with git clone examples. MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: imp X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: bde30a020ca16b58fc2bb07f940352797b6f43ad Auto-Submitted: auto-generated X-BeenThere: dev-commits-doc-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the doc repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 10 Apr 2021 04:20:40 -0000 The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/doc/commit/?id=bde30a020ca16b58fc2bb07f940352797b6f43ad commit bde30a020ca16b58fc2bb07f940352797b6f43ad Author: Warner Losh AuthorDate: 2021-04-10 04:18:42 +0000 Commit: Warner Losh CommitDate: 2021-04-10 04:19:13 +0000 mirrors: be consistent with git clone examples. Make sure that all the git clone examples have -o freebsd so that many of the other examples work. --- documentation/content/en/books/handbook/mirrors/_index.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/documentation/content/en/books/handbook/mirrors/_index.adoc b/documentation/content/en/books/handbook/mirrors/_index.adoc index 3ee176235b..1ae2cc9cc0 100644 --- a/documentation/content/en/books/handbook/mirrors/_index.adoc +++ b/documentation/content/en/books/handbook/mirrors/_index.adoc @@ -487,7 +487,7 @@ To get started, clone a copy of the FreeBSD repository: [source,shell] .... -# git clone [ -b branch ] https://git.FreeBSD.org/repo.git wcdir +# git clone -o freebsd [ -b branch ] https://git.FreeBSD.org/repo.git wcdir .... where: @@ -497,6 +497,8 @@ where: `ports` and `doc` are mostly updated in the `main` branch, while `src` maintains the latest version of -CURRENT under `main` and the respective latest versions of the -STABLE branches under `stable/12` (12._x_) and `stable/13` (13._x_). * _wcdir_ 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 `src`, and [.filename]#/usr/doc# for `doc`. +* _freebsd_ is the name of the origin to use. +By convention in the FreeBSD documentation, the origin is assumed to be `freebsd`. 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 [.filename]#/usr/src#. If [.filename]#/usr/src# is already present but was not created by `git`, remember to rename or delete it before the checkout. @@ -504,7 +506,7 @@ Git will refuse to do anything otherwise. [source,shell] .... -# git clone https://git.FreeBSD.org/src.git /usr/src +# git clone -o freebsd https://git.FreeBSD.org/src.git /usr/src .... Because the initial checkout must download the full branch of the remote repository, it can take a while.