summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJared Morrow <jared@basho.com>2014-02-25 07:50:09 -0700
committerJared Morrow <jared@basho.com>2014-02-25 07:50:09 -0700
commit3b08e93ef97361a97a35d48d0e45489048a0d72a (patch)
treed3223de18db55b360ce11b0826fd0a0bf6823ae7
parent289a71e208f84d04a4d0b7c4806daf25f76c655d (diff)
parenta554744fc04708eb622974313ef342e07d386c53 (diff)
Merge pull request #232 from tuncer/doc-abbrev-cmd
Document support for abbreviated commands
-rw-r--r--src/rebar.erl12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/rebar.erl b/src/rebar.erl
index 833e397..a1abfe3 100644
--- a/src/rebar.erl
+++ b/src/rebar.erl
@@ -184,10 +184,22 @@ help() ->
"[var=value,...] <command,...>",
[{"var=value", "rebar global variables (e.g. force=1)"},
{"command", "Command to run (e.g. compile)"}]),
+
+ ?CONSOLE("To see a list of built-in commands, execute rebar -c.~n~n", []),
?CONSOLE(
"Type 'rebar help <CMD1> <CMD2>' for help on specific commands."
"~n~n", []),
?CONSOLE(
+ "rebar allows you to abbreviate the command to run:~n"
+ "$ rebar co # same as rebar compile~n"
+ "$ rebar eu # same as rebar eunit~n"
+ "$ rebar g-d # same as rebar get-deps~n"
+ "$ rebar x eu # same as rebar xref eunit~n"
+ "$ rebar l-d # same as rebar list-deps~n"
+ "$ rebar l-d l-t # same as rebar list-deps list-templates~n"
+ "$ rebar list-d l-te # same as rebar list-deps list-templates~n"
+ "~n", []),
+ ?CONSOLE(
"Core rebar.config options:~n"
" ~p~n"
" ~p~n"