Taps.md: Update cloning details

Since shallow cloning is now neither recommended nor the default, I've removed all mentions of cloning type.
This commit is contained in:
Adrian Ho 2020-07-16 20:31:05 +08:00 committed by GitHub
parent 831a6605bd
commit a39c0dc49f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -18,7 +18,7 @@ dunn/emacs
<!-- vale Homebrew.Terms = OFF --> <!-- vale Homebrew.Terms = OFF -->
<!-- The `terms` lint suggests changing "repo" to "repository". But we need the abbreviation in the tap syntax and URL example. --> <!-- The `terms` lint suggests changing "repo" to "repository". But we need the abbreviation in the tap syntax and URL example. -->
* `brew tap <user/repo>` makes a shallow clone of the repository at * `brew tap <user/repo>` makes a clone of the repository at
https://github.com/user/homebrew-repo. After that, `brew` will be able to work on https://github.com/user/homebrew-repo. After that, `brew` will be able to work on
those formulae as if they were in Homebrew's canonical repository. You can those formulae as if they were in Homebrew's canonical repository. You can
install and uninstall them with `brew [un]install`, and the formulae are install and uninstall them with `brew [un]install`, and the formulae are
@ -26,15 +26,11 @@ dunn/emacs
about how `brew tap` handles the names of repositories.) about how `brew tap` handles the names of repositories.)
<!-- vale Homebrew.Terms = ON --> <!-- vale Homebrew.Terms = ON -->
* `brew tap <user/repo> <URL>` makes a shallow clone of the repository at URL. * `brew tap <user/repo> <URL>` makes a clone of the repository at URL.
Unlike the one-argument version, URL is not assumed to be GitHub, and it Unlike the one-argument version, URL is not assumed to be GitHub, and it
doesn't have to be HTTP. Any location and any protocol that Git can handle is doesn't have to be HTTP. Any location and any protocol that Git can handle is
fine. fine.
* Add `--full` to either the one- or two-argument invocations above to have Git
make a complete clone rather than a shallow one. Full is the default for
Homebrew developers.
* `brew tap --repair` migrates tapped formulae from a symlink-based to * `brew tap --repair` migrates tapped formulae from a symlink-based to
directory-based structure. (This should only need to be run once.) directory-based structure. (This should only need to be run once.)