Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

tap: update docs to note non-shallow default. #7053

Merged
merged 1 commit into from Feb 19, 2020
Merged

tap: update docs to note non-shallow default. #7053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 3 additions & 4 deletions Library/Homebrew/cmd/tap.rb
View file
Open in desktop
Expand Up @@ -22,12 +22,11 @@ def tap_args
any transport protocol that `git`(1) handles. The one-argument form of `tap`
simplifies but also limits. This two-argument command makes no
assumptions, so taps can be cloned from places other than GitHub and
using protocols other than HTTPS, e.g. SSH, GIT, HTTP, FTP(S), RSYNC.
using protocols other than HTTPS, e.g. SSH, git, HTTP, FTP(S), rsync.
EOS
switch "--full",
description: "Use a full clone when tapping a repository. By default, the repository is "\
"cloned as a shallow copy (`--depth=1`). To convert a shallow copy to a "\
"full copy, you can retap by passing `--full` without first untapping."
description: "Convert a shallow clone to a full clone without untapping. By default, taps are no "\
"longer cloned as shallow clones."
switch "--force-auto-update",
description: "Auto-update tap even if it is not hosted on GitHub. By default, only taps "\
"hosted on GitHub are auto-updated (for performance reasons)."
Expand Down
4 changes: 2 additions & 2 deletions docs/Manpage.md
View file
Open in desktop
Expand Up @@ -496,10 +496,10 @@ With *`URL`* specified, tap a formula repository from anywhere, using any
transport protocol that `git`(1) handles. The one-argument form of `tap`
simplifies but also limits. This two-argument command makes no assumptions, so
taps can be cloned from places other than GitHub and using protocols other than
HTTPS, e.g. SSH, GIT, HTTP, FTP(S), RSYNC.
HTTPS, e.g. SSH, git, HTTP, FTP(S), rsync.

* `--full`:
Use a full clone when tapping a repository. By default, the repository is cloned as a shallow copy (`--depth=1`). To convert a shallow copy to a full copy, you can retap by passing `--full` without first untapping.
Convert a shallow clone to a full clone without untapping. By default, taps are no longer cloned as shallow clones.
* `--force-auto-update`:
Auto-update tap even if it is not hosted on GitHub. By default, only taps hosted on GitHub are auto-updated (for performance reasons).
* `--repair`:
Expand Down
4 changes: 2 additions & 2 deletions manpages/brew.1
View file
Open in desktop
Expand Up @@ -627,11 +627,11 @@ If no arguments are provided, list all installed taps\.
With \fIURL\fR unspecified, tap a formula repository from GitHub using HTTPS\. Since so many taps are hosted on GitHub, this command is a shortcut for \fBbrew tap\fR \fIuser\fR\fB/\fR\fIrepo\fR \fBhttps://github\.com/\fR\fIuser\fR\fB/homebrew\-\fR\fIrepo\fR\.
.
.P
With \fIURL\fR specified, tap a formula repository from anywhere, using any transport protocol that \fBgit\fR(1) handles\. The one\-argument form of \fBtap\fR simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\. SSH, GIT, HTTP, FTP(S), RSYNC\.
With \fIURL\fR specified, tap a formula repository from anywhere, using any transport protocol that \fBgit\fR(1) handles\. The one\-argument form of \fBtap\fR simplifies but also limits\. This two\-argument command makes no assumptions, so taps can be cloned from places other than GitHub and using protocols other than HTTPS, e\.g\. SSH, git, HTTP, FTP(S), rsync\.
.
.TP
\fB\-\-full\fR
Use a full clone when tapping a repository\. By default, the repository is cloned as a shallow copy (\fB\-\-depth=1\fR)\. To convert a shallow copy to a full copy, you can retap by passing \fB\-\-full\fR without first untapping\.
Convert a shallow clone to a full clone without untapping\. By default, taps are no longer cloned as shallow clones\.
.
.TP
\fB\-\-force\-auto\-update\fR
Expand Down