aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/cmd/tap.rb
diff options
context:
space:
mode:
authorMax Nordlund2016-04-08 16:28:43 +0200
committerMartin Afanasjew2016-04-10 22:59:25 +0200
commitfa1fd70a37c4ab843cb3d61c4301e44828c7b5ec (patch)
treec96f4a8b24e229fe6624c6a3a5cb4e6d593a0c85 /Library/Homebrew/cmd/tap.rb
parentb21f699ff2f1691c4f10422c640a9d392cf2d7a7 (diff)
downloadbrew-fa1fd70a37c4ab843cb3d61c4301e44828c7b5ec.tar.bz2
Add all the top level comments
Diffstat (limited to 'Library/Homebrew/cmd/tap.rb')
-rw-r--r--Library/Homebrew/cmd/tap.rb33
1 files changed, 33 insertions, 0 deletions
diff --git a/Library/Homebrew/cmd/tap.rb b/Library/Homebrew/cmd/tap.rb
index 1bd378d69..cd785482a 100644
--- a/Library/Homebrew/cmd/tap.rb
+++ b/Library/Homebrew/cmd/tap.rb
@@ -1,3 +1,36 @@
+#: * `tap`:
+#: List all installed taps.
+#:
+#: * `tap` [`--full`] <user>`/`<repo> [<URL>]:
+#: Tap a formula repository.
+#:
+#: With <URL> unspecified, taps a formula repository from GitHub using HTTPS.
+#: Since so many taps are hosted on GitHub, this command is a shortcut for
+#: `tap <user>/<repo> https://github.com/<user>/homebrew-<repo>`.
+#:
+#: With <URL> specified, taps a formula repository from anywhere, using
+#: any transport protocol that `git` 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.
+#:
+#: By default, the repository is cloned as a shallow copy (`--depth=1`), but
+#: if `--full` is passed, a full clone will be used. To convert a shallow copy
+#: to a full copy, you can retap passing `--full` without first untapping.
+#:
+#: `tap` is re-runnable and exits successfully if there's nothing to do.
+#: However, retapping with a different <URL> will cause an exception, so first
+#: `untap` if you need to modify the <URL>.
+#:
+#: * `tap` `--repair`:
+#: Migrate tapped formulae from symlink-based to directory-based structure.
+#:
+#: * `tap` `--list-official`:
+#: List all official taps.
+#:
+#: * `tap` `--list-pinned`:
+#: List all pinned taps.
+
require "tap"
module Homebrew