diff options
| author | Fred Hebert <mononcqc@ferd.ca> | 2015-04-02 13:40:49 +0000 | 
|---|---|---|
| committer | Fred Hebert <mononcqc@ferd.ca> | 2015-04-02 16:27:36 +0000 | 
| commit | a3274e1bc86214d96b4047b88683a68f516d0997 (patch) | |
| tree | 0adda6f4860d4bfce07ea87376a9798602cbce9c | |
| parent | d1cdbae0fbd49a42252a8967704a21c6d133337f (diff) | |
Fixes #306: help text consistency
| -rw-r--r-- | priv/templates/plugin.erl.dtl | 14 | ||||
| -rw-r--r-- | src/rebar_prv_escriptize.erl | 2 | ||||
| -rw-r--r-- | src/rebar_prv_help.erl | 4 | ||||
| -rw-r--r-- | src/rebar_prv_new.erl | 2 | ||||
| -rw-r--r-- | src/rebar_prv_wtf.erl | 4 | ||||
| -rw-r--r-- | src/rebar_prv_xref.erl | 2 | 
6 files changed, 14 insertions, 14 deletions
| diff --git a/priv/templates/plugin.erl.dtl b/priv/templates/plugin.erl.dtl index d3528c0..abf4648 100644 --- a/priv/templates/plugin.erl.dtl +++ b/priv/templates/plugin.erl.dtl @@ -12,14 +12,14 @@  -spec init(rebar_state:t()) -> {ok, rebar_state:t()}.  init(State) ->      Provider = providers:create([ -            {name, ?PROVIDER},           % The 'user friendly' name of the task -            {module, ?MODULE},           % The module implementation of the task -            {bare, true},                % The task can be run by the user, always true -            {deps, ?DEPS},               % The list of dependencies -            {example, "rebar {{name}}"}, % How to use the plugin -            {opts, []},                  % list of options understood by the plugin +            {name, ?PROVIDER},            % The 'user friendly' name of the task +            {module, ?MODULE},            % The module implementation of the task +            {bare, true},                 % The task can be run by the user, always true +            {deps, ?DEPS},                % The list of dependencies +            {example, "rebar3 {{name}}"}, % How to use the plugin +            {opts, []},                   % list of options understood by the plugin              {short_desc, "{{desc}}"}, -            {desc, ""} +            {desc, "{{desc}}"}      ]),      {ok, rebar_state:add_provider(State, Provider)}. diff --git a/src/rebar_prv_escriptize.erl b/src/rebar_prv_escriptize.erl index 69ac7fe..d17699e 100644 --- a/src/rebar_prv_escriptize.erl +++ b/src/rebar_prv_escriptize.erl @@ -51,7 +51,7 @@ init(State) ->                                  {deps, ?DEPS},                                  {example, "rebar3 escriptize"},                                  {opts, []}, -                                {short_desc, "Generate escript archive"}, +                                {short_desc, "Generate escript archive."},                                  {desc, desc()}                                  ]),      {ok, rebar_state:add_provider(State, Provider)}. diff --git a/src/rebar_prv_help.erl b/src/rebar_prv_help.erl index 9e22530..b450023 100644 --- a/src/rebar_prv_help.erl +++ b/src/rebar_prv_help.erl @@ -58,11 +58,11 @@ format_error(Reason) ->  %% print help/usage string  %%  help(State) -> -    ?CONSOLE("Rebar is a tool for working with Erlang projects.~n~n", []), +    ?CONSOLE("Rebar3 is a tool for working with Erlang projects.~n~n", []),      OptSpecList = rebar3:global_option_spec_list(),      getopt:usage(OptSpecList, "rebar", "", []),      ?CONSOLE("~nSeveral tasks are available:~n", []),      providers:help(rebar_state:providers(State)), -    ?CONSOLE("~nRun 'rebar help <TASK>' for details.~n~n", []). +    ?CONSOLE("~nRun 'rebar3 help <TASK>' for details.~n~n", []). diff --git a/src/rebar_prv_new.erl b/src/rebar_prv_new.erl index 58e27fd..6bc9f53 100644 --- a/src/rebar_prv_new.erl +++ b/src/rebar_prv_new.erl @@ -67,7 +67,7 @@ format_error(Reason) ->  info() ->      io_lib:format( -      "Create rebar project based on template and vars.~n" +      "Create rebar3 project based on template and vars.~n"        "~n"        "Valid command line options:~n"        "  template= [var=foo,...]~n", []). diff --git a/src/rebar_prv_wtf.erl b/src/rebar_prv_wtf.erl index f876760..9be9a4b 100644 --- a/src/rebar_prv_wtf.erl +++ b/src/rebar_prv_wtf.erl @@ -26,8 +26,8 @@ init(State) ->                                                                 {bare, false},                                                                 {deps, ?DEPS},                                                                 {example, "rebar3 wtf \"<task>\""}, -                                                               {short_desc, "Provide a crash report to be sent to the rebar3 issues page"}, -                                                               {desc, "Provide a crash report to be sent to the rebar3 issues page"}, +                                                               {short_desc, "Provide a crash report to be sent to the rebar3 issues page."}, +                                                               {desc, "Provide a crash report to be sent to the rebar3 issues page."},                                                                 {opts, [                                                                        {task, undefined, undefined, string, "Task to print details for."}                                                                        ]}])), diff --git a/src/rebar_prv_xref.erl b/src/rebar_prv_xref.erl index aa1075f..67cd554 100644 --- a/src/rebar_prv_xref.erl +++ b/src/rebar_prv_xref.erl @@ -66,7 +66,7 @@ format_error(Reason) ->  %% ===================================================================  short_desc() -> -    "Run cross reference analysis". +    "Run cross reference analysis.".  desc() ->      io_lib:format( | 
