aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/cmd/unpack.rb
diff options
context:
space:
mode:
Diffstat (limited to 'Library/Homebrew/cmd/unpack.rb')
-rw-r--r--Library/Homebrew/cmd/unpack.rb11
1 files changed, 11 insertions, 0 deletions
diff --git a/Library/Homebrew/cmd/unpack.rb b/Library/Homebrew/cmd/unpack.rb
index 68b81bd2f..f0d7a555b 100644
--- a/Library/Homebrew/cmd/unpack.rb
+++ b/Library/Homebrew/cmd/unpack.rb
@@ -1,3 +1,14 @@
+#: * `unpack` [`--git`|`--patch`] [`--destdir=`<path>] <formulae>:
+#: Unpack the source files for <formulae> into subdirectories of the current
+#: working directory. If `--destdir=`<path> is given, the subdirectories will
+#: be created in the directory named by `<path>` instead.
+#:
+#: If `--patch` is passed, patches for <formulae> will be applied to the
+#: unpacked source.
+#:
+#: If `--git` is passed, a Git repository will be initalized in the unpacked
+#: source. This is useful for creating patches for the software.
+
require "stringio"
require "formula"