From nobody Wed May 29 15:24:09 2024 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4VqCpd3h5Mz5Mht9 for ; Wed, 29 May 2024 15:24:09 +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 4VqCpd2gNGz4Ykl; Wed, 29 May 2024 15:24:09 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1716996249; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=+bAos3tO7uh8I/PtHHXuJkGtmhqzILvROvfj5Pa1q4g=; b=gJtwlCbkFhelR4NOq1o08zhqzhOJIAD3dJ90PYc5j7LjW8CJZot9GLesfMCwJqh1rF14m1 0V4o77IHQlXLzRpX4VcBgdDOcDzcJGMZN0ocI8/458GCMDZQ02GLddgFWOTsArsk46PEwO 45SVn9YlrSWYxFr8K754Tgotu+CrryYtH7zDzRfVEBXr+dgjI2u5KanNwG91PrQKhGlWBJ vxAZTaFOMmnzn/s6x7VZQdLJ3KgWAnjs1J9UNHliwnw6ODAqhww8iGyi1bZdvyoED23xdT 7frrYrh6l/EAZ46ZazzPc44ANdU6RGsX/52glA4IiHpoElqqGkG6djHp6nC5tw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1716996249; a=rsa-sha256; cv=none; b=m5KLTPavprA3fSV8UpQEUG74hQSVSUcoH6zPiYjLD0bxoUIlCDNlSc2kliLmTV2ldp3nt+ D7OJUQqKlMVJkbMKY/OIWWHNz0orsqdHmhM8GKZwS/S9hsAwzXUpH15WQceC5PADBkbvYQ 3aQtffBYd2qvrUx/Xvl8oIkSq2S75Kk6OfuLuIgE07WPKHyng5SH7Hbwc3Zn+LV2c7WZab bgb/OL2aMn1KcuthKXiruzwZsw9T3QYH8QyDqx4CsMVRwGsDlJBXyztxbL7tMi4y4IyzAx DtTISdo2yWXc6WEar8EcrxZCp8ujxy4OTOPotdd0dHHAUShvpa+sZrakSgyKCQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1716996249; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=+bAos3tO7uh8I/PtHHXuJkGtmhqzILvROvfj5Pa1q4g=; b=GO7SlZwtWbk3EEne8RG+xrZiVGfBqrih9dwNThChRqVa2uGD2pk1m3XyOOS2uyHEX1WR3n 7H2Kvk0J+GHd2JH8TwvsqhjksodtVqsgRg2rzj2EOWw7o8QSE8NbF6SNwNpq196wyWthno Gn6dXWSbL358+2s5ApwPSg9ykgg3BrM+1Ab8XEThn1cF/Ja/zRCLDhHHqevTVVpfzFLQZy sjQyQfd1+UFnPteyBunZj1BHsH9/9vsT0U900H2iSEe3NKQclroTGmLMBf6YLDQQKI3SfA CSkHB9/YJKCg06LvWAeeXgNEnKPvQVwBcCwe2NLIhIDZOOOuHuH/XA3X9Nc48g== 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 4VqCpd2FxQz12G9; Wed, 29 May 2024 15:24:09 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 44TFO9me082293; Wed, 29 May 2024 15:24:09 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 44TFO905082290; Wed, 29 May 2024 15:24:09 GMT (envelope-from git) Date: Wed, 29 May 2024 15:24:09 GMT Message-Id: <202405291524.44TFO905082290@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Benedict Reuschling Subject: git: cbe1572983 - main - Reduce depth of git pull when checking out ports List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: bcr X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: cbe1572983c139a36fb0357e16df0dd01e1318ad Auto-Submitted: auto-generated The branch main has been updated by bcr: URL: https://cgit.FreeBSD.org/doc/commit/?id=cbe1572983c139a36fb0357e16df0dd01e1318ad commit cbe1572983c139a36fb0357e16df0dd01e1318ad Author: Benedict Reuschling AuthorDate: 2024-05-29 15:19:28 +0000 Commit: Benedict Reuschling CommitDate: 2024-05-29 15:19:28 +0000 Reduce depth of git pull when checking out ports An initial 'git clone' of the ports tree takes a long time. The checkout we had before this change contained all the commit history, which would normally not be necessary nor be interesting for people who simply want to compile ports without doing any kind of development. To reduce the clone time add the '--depth 1' parameter in this change. Additionally, for people that do work on ports, a sentence about removing that option was added. --- documentation/content/en/books/handbook/ports/_index.adoc | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/documentation/content/en/books/handbook/ports/_index.adoc b/documentation/content/en/books/handbook/ports/_index.adoc index 7ef3b47c7d..a32b0608ba 100644 --- a/documentation/content/en/books/handbook/ports/_index.adoc +++ b/documentation/content/en/books/handbook/ports/_index.adoc @@ -680,6 +680,9 @@ If more control over the ports tree is needed or if local changes need to be mai Git can be used to obtain the Ports Collection. Refer to extref:{committers-guide}[the Git Primer, git-primer] for a detailed description of Git. +We add --depth 1 to the git command line to clone the tree without obtaining the commit history, which saves time and is acceptable for most users. +If you have your own changes to the ports tree, or need the history for any reason, omit the --depth 1 argument below. + . 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] @@ -699,14 +702,14 @@ If the ports tree is not available, or pkg is being used to manage packages, Git + [source,shell] .... -# git clone https://git.FreeBSD.org/ports.git /usr/ports +# git clone --depth 1 https://git.FreeBSD.org/ports.git /usr/ports .... + . Or, check out a copy of a quarterly branch: + [source,shell] .... -# git clone https://git.FreeBSD.org/ports.git -b 2023Q1 /usr/ports +# git clone --depth 1 https://git.FreeBSD.org/ports.git -b 2023Q1 /usr/ports .... + . As needed, update `/usr/ports` after the initial Git checkout: