git: bde30a020c - main - mirrors: be consistent with git clone examples.

Warner Losh <[email protected]>
Newsgroups gmane.os.freebsd.devel.cvs.doc
Message-ID <[email protected]>
The branch main has been updated by imp:

URL: https://cgit.FreeBSD.org/doc/commit/?id=bde30a020ca16b58fc2bb07f940352797b6f43ad

commit bde30a020ca16b58fc2bb07f940352797b6f43ad
Author:     Warner Losh <[email protected]>
AuthorDate: 2021-04-10 04:18:42 +0000
Commit:     Warner Losh <[email protected]>
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.
_______________________________________________
[email protected] mailing list
https://lists.freebsd.org/mailman/listinfo/dev-commits-doc-all
To unsubscribe, send any mail to "[email protected]"
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.