From ec402f692d1640b356811868f0286bc2089f75aa Mon Sep 17 00:00:00 2001 From: "Paulo F. Oliveira" Date: Wed, 14 Oct 2020 22:01:10 +0100 Subject: [PATCH] Reword references to pkgs --- README.md | 2 +- priv/shell-completion/fish/rebar3.fish | 4 ++-- priv/shell-completion/zsh/_rebar3 | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 933d2d3f..75fa79f9 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ others via the plugin ecosystem: | Escript generation | Rebar3 can be used to generate [escripts](http://www.erlang.org/doc/man/escript.html) providing an easy way to run all your applications on a system where Erlang is installed | | Eunit | The test framework can be run by calling `rebar3 eunit` | | Locked dependencies | Dependencies are going to be automatically locked to ensure repeatable builds. Versions can be changed with `rebar3 upgrade` or `rebar3 upgrade `, or locks can be released altogether with `rebar3 unlock`. | -| Packages | [Hex packages](https://hex.pm) can be listed with `rebar3 pkgs`. They can be used as dependencies, will be cached locally for faster usage, and a local index will be used and updated with `rebar3 update`. | +| Packages | A given [Hex package](https://hex.pm) can be inspected `rebar3 pkgs `. This will output its description and available versions | | Path | While paths are managed automatically, you can print paths to the current build directories with `rebar3 path`. | | Plugins | Rebar3 can be fully extended with [plugins](https://rebar3.org/docs/configuration/plugins/). List or upgrade plugins by using the plugin namespace (`rebar3 plugins`). | | Profiles | Rebar3 can have subconfiguration options for different profiles, such as `test` or `prod`. These allow specific dependencies or compile options to be used in specific contexts. See [Profiles](https://rebar3.org/docs/configuration/profiles) in the docs. | diff --git a/priv/shell-completion/fish/rebar3.fish b/priv/shell-completion/fish/rebar3.fish index e578b963..9b68269c 100644 --- a/priv/shell-completion/fish/rebar3.fish +++ b/priv/shell-completion/fish/rebar3.fish @@ -45,7 +45,7 @@ end ## help Display a list of tasks or help for a given task or subtask. ## new Create new project from templates. ## path Print paths to build dirs in current profile. -## pkgs List available packages. +## pkgs Get information on a given package. ## release Build release of project. ## relup Create relup of releases. ## report Provide a crash report to be sent to the rebar3 issues page. @@ -158,7 +158,7 @@ complete -f -c 'rebar3' -n '__fish_rebar3_needs_command paths' -s s -l separator complete -f -c 'rebar3' -n '__fish_rebar3_needs_command paths' -l src -d "Return the `src` path of the current profile`s applications." complete -f -c 'rebar3' -n '__fish_rebar3_needs_command paths' -l rel -d "Return the `rel` path of the current profile." -complete -f -c 'rebar3' -n '__fish_rebar3_needs_command' -a pkgs -d "List available packages." +complete -f -c 'rebar3' -n '__fish_rebar3_needs_command' -a pkgs -d "List information for a hex package." complete -f -c 'rebar3' -n '__fish_rebar3_needs_command' -a release -d "Build release of project." complete -f -c 'rebar3' -n '__fish_rebar3_needs_command' -a relup -d "Create relup of releases." complete -f -c 'rebar3' -n '__fish_rebar3_needs_command' -a report -d "Provide a crash report to be sent to the rebar3 issues page." diff --git a/priv/shell-completion/zsh/_rebar3 b/priv/shell-completion/zsh/_rebar3 index 8ae8777a..2ceeacac 100644 --- a/priv/shell-completion/zsh/_rebar3 +++ b/priv/shell-completion/zsh/_rebar3 @@ -121,7 +121,7 @@ _rebar3 () { && ret=0 ;; (pkgs) - _message 'List available packages.' && ret=0 + _message 'List information for a given package.' && ret=0 ;; (plugins) _arguments \ @@ -251,7 +251,7 @@ _rebar3_tasks() { 'eunit:Run EUnit Tests.' 'help:Display a list of tasks or help for a given task or subtask.' 'new:Create new project from templates.' - 'pkgs:List available packages.' + 'pkgs:List information for a given package.' 'plugins:List or upgrade plugins.' 'release:Build release of project.' 'relup:Create relup from 2 releases.'