diff --git a/.gitignore b/.gitignore index d7740bcb3..38087be00 100644 --- a/.gitignore +++ b/.gitignore @@ -25,3 +25,4 @@ env # hex_core artifact apps/rebar/src/vendored/r3_safe_erl_term.erl +apps/rebar/doc diff --git a/README.md b/README.md index 3a223edd7..ffbc9b728 100644 --- a/README.md +++ b/README.md @@ -61,21 +61,21 @@ This list presents the known working version combos between Rebar3 and Erlang/OTP. Always use the latest version your project can tolerate for latest security fixes. -| Rebar3 | Erlang/OTP Support Range | Notes -|- |- | - -| 3.25.1 | 26-28 | issues with newer Windows versions were reported on 3.25.0 and OTP-28 -| 3.24.0 | 25-27 | -| 3.23.0 | 25-27 | -| 3.22.1 | 25-27 | -| 3.21.0 | 24-26 | -| 3.20.0 | 23-25 | -| 3.19.0 | 23-25 | -| 3.18.0 | 22-24 | -| 3.17.0 | 22-24 | -| 3.16.1 | 22-24 | Don't use 3.16.0, see https://ferd.ca/you-ve-got-to-upgrade-rebar3.html -| 3.15.2 | 19-23 | Don't use 3.15.0 or 3.15.1, see https://ferd.ca/you-ve-got-to-upgrade-rebar3.html -| 3.14.1 | 19-23 | -| 3.13.3 | 19-22 | Don't use 3.13.1 or 3.13.2, see https://ferd.ca/you-ve-got-to-upgrade-rebar3.html +| Rebar3 | Erlang/OTP Support Range | Notes | +|- |- | - | +| 3.25.1 | 26-28 | issues with newer Windows versions were reported on 3.25.0 and OTP-28 | +| 3.24.0 | 25-27 | | +| 3.23.0 | 25-27 | | +| 3.22.1 | 25-27 | | +| 3.21.0 | 24-26 | | +| 3.20.0 | 23-25 | | +| 3.19.0 | 23-25 | | +| 3.18.0 | 22-24 | | +| 3.17.0 | 22-24 | | +| 3.16.1 | 22-24 | Don't use 3.16.0, see https://ferd.ca/you-ve-got-to-upgrade-rebar3.html | +| 3.15.2 | 19-23 | Don't use 3.15.0 or 3.15.1, see https://ferd.ca/you-ve-got-to-upgrade-rebar3.html | +| 3.14.1 | 19-23 | | +| 3.13.3 | 19-22 | Don't use 3.13.1 or 3.13.2, see https://ferd.ca/you-ve-got-to-upgrade-rebar3.html | A [getting started guide is maintained on the official documentation website](https://rebar3.org/docs/getting-started), but installing rebar3 can be done by any of the ways described below @@ -139,7 +139,7 @@ others via the plugin ecosystem: | Code Coverage | Various commands can be instrumented to accumulate code coverage data (such as `eunit` or `ct`). Reports can be generated with `rebar3 cover` | | Common Test | The test framework can be run by calling `rebar3 ct` | | Dependencies | Rebar3 maintains local copies of dependencies on a per-project basis. They are fetched deterministically, can be locked, upgraded, fetched from source, packages, or from local directories. See [Dependencies on the documentation website](https://rebar3.org/docs/configuration/dependencies/). Call `rebar3 tree` to show the whole dependency tree. | -| Documentation | Print help for rebar3 itself (`rebar3 help`) or for a specific task (`rebar3 help `). Full reference at [rebar3.org](https://rebar3.org/docs). | +| Documentation | Print help for rebar3 itself (`rebar3 help`) or for a specific task (`rebar3 help `). Full reference at [rebar3 documentation](https://rebar3.org/docs). | | Dialyzer | Run the Dialyzer analyzer on the project with `rebar3 dialyzer`. Base PLTs for each version of the language will be cached and reused for faster analysis | | Edoc | Generate documentation using edoc with `rebar3 edoc` | | 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 | @@ -188,6 +188,6 @@ For bug reports, roadmaps, and issues, visit the [github issues page](https://github.com/erlang/rebar3/issues). General rebar community resources and links can be found at -[rebar3.org/docs/about/about-us/#community](https://rebar3.org/docs/about/about-us/#community) +[Community | About Us](https://rebar3.org/docs/about/about-us/#community) -To contribute to rebar3, please refer to [CONTRIBUTING](CONTRIBUTING.md). +To contribute to rebar3, please refer to [CONTRIBUTING](https://github.com/erlang/rebar3/blob/master/CONTRIBUTING.md). diff --git a/apps/rebar/src/cth_fail_fast.erl b/apps/rebar/src/cth_fail_fast.erl index 13b35570d..970d8b25e 100644 --- a/apps/rebar/src/cth_fail_fast.erl +++ b/apps/rebar/src/cth_fail_fast.erl @@ -1,4 +1,5 @@ -module(cth_fail_fast). +-moduledoc false. %% Callbacks -export([id/1]). diff --git a/apps/rebar/src/cth_retry.erl b/apps/rebar/src/cth_retry.erl index b745c35e9..dac482f15 100644 --- a/apps/rebar/src/cth_retry.erl +++ b/apps/rebar/src/cth_retry.erl @@ -1,4 +1,5 @@ -module(cth_retry). +-moduledoc false. %% Callbacks -export([id/1]). diff --git a/apps/rebar/src/r3.erl b/apps/rebar/src/r3.erl index 5e3b22225..5143c24e9 100644 --- a/apps/rebar/src/r3.erl +++ b/apps/rebar/src/r3.erl @@ -1,6 +1,7 @@ %%% @doc external alias for `rebar_agent' for more convenient %%% calls from a shell. -module(r3). +-moduledoc false. -export([do/1, do/2, do/3, async_do/1, async_do/2, async_do/3, break/0, resume/0]). -export(['$handle_undefined_function'/2]). -include("rebar.hrl"). diff --git a/apps/rebar/src/rebar3.erl b/apps/rebar/src/rebar3.erl index b83f1797c..c90b8f10e 100644 --- a/apps/rebar/src/rebar3.erl +++ b/apps/rebar/src/rebar3.erl @@ -35,6 +35,7 @@ %% accessible to the rest of the run. %% @end -module(rebar3). +-moduledoc false. -export([main/0, main/1, diff --git a/apps/rebar/src/rebar_agent.erl b/apps/rebar/src/rebar_agent.erl index d89a643e9..aeefb1528 100644 --- a/apps/rebar/src/rebar_agent.erl +++ b/apps/rebar/src/rebar_agent.erl @@ -1,6 +1,7 @@ %%% @doc Runs a process that holds a rebar3 state and can be used %%% to statefully maintain loaded project state into a running VM. -module(rebar_agent). +-moduledoc false. -export([start_link/1, do/1, do/2, do/3, async_do/1, async_do/2, async_do/3]). -export(['$handle_undefined_function'/2]). -export([init/1, @@ -290,9 +291,9 @@ reload_modules(Modules0) -> Modules = [M || M <- Modules0, is_changed(M)], reload_modules(Modules, erlang:function_exported(code, prepare_loading, 1)). -%% @spec is_changed(atom()) -> boolean() %% @doc true if the loaded module is a beam with a vsn attribute %% and does not match the on-disk beam file, returns false otherwise. +-spec is_changed(atom()) -> boolean(). is_changed(M) -> try module_vsn(M:module_info(attributes)) =/= module_vsn(code:get_object_code(M)) diff --git a/apps/rebar/src/rebar_app_discover.erl b/apps/rebar/src/rebar_app_discover.erl index 94fb20488..6cc304857 100644 --- a/apps/rebar/src/rebar_app_discover.erl +++ b/apps/rebar/src/rebar_app_discover.erl @@ -1,6 +1,7 @@ %%% @doc utility functions to do the basic discovery of apps %%% and layout for the project. -module(rebar_app_discover). +-moduledoc false. -export([do/2, format_error/1, diff --git a/apps/rebar/src/rebar_app_utils.erl b/apps/rebar/src/rebar_app_utils.erl index f4526e4c5..36859760b 100644 --- a/apps/rebar/src/rebar_app_utils.erl +++ b/apps/rebar/src/rebar_app_utils.erl @@ -25,6 +25,7 @@ %% THE SOFTWARE. %% ------------------------------------------------------------------- -module(rebar_app_utils). +-moduledoc false. -export([find/2, find/3, diff --git a/apps/rebar/src/rebar_compiler.erl b/apps/rebar/src/rebar_compiler.erl index 8e8b2e6bc..66dab2289 100644 --- a/apps/rebar/src/rebar_compiler.erl +++ b/apps/rebar/src/rebar_compiler.erl @@ -1,4 +1,5 @@ -module(rebar_compiler). +-moduledoc false. -export([analyze_all/2, analyze_all_extras/2, diff --git a/apps/rebar/src/rebar_compiler_dag.erl b/apps/rebar/src/rebar_compiler_dag.erl index e147be9aa..968d923cb 100644 --- a/apps/rebar/src/rebar_compiler_dag.erl +++ b/apps/rebar/src/rebar_compiler_dag.erl @@ -1,6 +1,7 @@ %%% Module handling the directed graph required for the analysis %%% of all top-level applications by the various compiler plugins. -module(rebar_compiler_dag). +-moduledoc false. -export([init/4, status/4, maybe_store/5, terminate/1]). -export([prune/5, populate_sources/5, populate_deps/3, propagate_stamps/1, compile_order/4, store_artifact/4]). diff --git a/apps/rebar/src/rebar_compiler_epp.erl b/apps/rebar/src/rebar_compiler_epp.erl index a98554856..67c9e868c 100644 --- a/apps/rebar/src/rebar_compiler_epp.erl +++ b/apps/rebar/src/rebar_compiler_epp.erl @@ -3,6 +3,7 @@ %%% build complete and accurate DAGs %%% @end -module(rebar_compiler_epp). +-moduledoc false. -export([deps/2, resolve_module/2]). %% cache (a la code path storage, but for dependencies not in code path) -export([ensure_started/0, flush/0, resolve_source/2]). diff --git a/apps/rebar/src/rebar_compiler_erl.erl b/apps/rebar/src/rebar_compiler_erl.erl index 98e365c94..9dc16d807 100644 --- a/apps/rebar/src/rebar_compiler_erl.erl +++ b/apps/rebar/src/rebar_compiler_erl.erl @@ -1,4 +1,5 @@ -module(rebar_compiler_erl). +-moduledoc false. -behaviour(rebar_compiler). diff --git a/apps/rebar/src/rebar_compiler_format.erl b/apps/rebar/src/rebar_compiler_format.erl index 32bf1bd21..f29da3c83 100644 --- a/apps/rebar/src/rebar_compiler_format.erl +++ b/apps/rebar/src/rebar_compiler_format.erl @@ -1,5 +1,6 @@ %%% @doc Module handling rich formatting of errors. -module(rebar_compiler_format). +-moduledoc false. -export([format/5]). -include("rebar.hrl"). diff --git a/apps/rebar/src/rebar_compiler_mib.erl b/apps/rebar/src/rebar_compiler_mib.erl index 92be10140..fe9c1c099 100644 --- a/apps/rebar/src/rebar_compiler_mib.erl +++ b/apps/rebar/src/rebar_compiler_mib.erl @@ -1,4 +1,5 @@ -module(rebar_compiler_mib). +-moduledoc false. -behaviour(rebar_compiler). diff --git a/apps/rebar/src/rebar_compiler_xrl.erl b/apps/rebar/src/rebar_compiler_xrl.erl index 15b42ff67..5d6e98796 100644 --- a/apps/rebar/src/rebar_compiler_xrl.erl +++ b/apps/rebar/src/rebar_compiler_xrl.erl @@ -1,4 +1,5 @@ -module(rebar_compiler_xrl). +-moduledoc false. -behaviour(rebar_compiler). diff --git a/apps/rebar/src/rebar_compiler_yrl.erl b/apps/rebar/src/rebar_compiler_yrl.erl index a9740afdc..b1c8fa9b4 100644 --- a/apps/rebar/src/rebar_compiler_yrl.erl +++ b/apps/rebar/src/rebar_compiler_yrl.erl @@ -1,4 +1,5 @@ -module(rebar_compiler_yrl). +-moduledoc false. -behaviour(rebar_compiler). diff --git a/apps/rebar/src/rebar_completion.erl b/apps/rebar/src/rebar_completion.erl index d6f84252c..14e5daff6 100644 --- a/apps/rebar/src/rebar_completion.erl +++ b/apps/rebar/src/rebar_completion.erl @@ -1,4 +1,5 @@ -module(rebar_completion). +-moduledoc false. -export([generate/2]). diff --git a/apps/rebar/src/rebar_completion_bash.erl b/apps/rebar/src/rebar_completion_bash.erl index aa2d019c3..1e79461c8 100644 --- a/apps/rebar/src/rebar_completion_bash.erl +++ b/apps/rebar/src/rebar_completion_bash.erl @@ -1,6 +1,7 @@ %% @doc Completion file generator for bash %% @end -module(rebar_completion_bash). +-moduledoc false. -behavior(rebar_completion). diff --git a/apps/rebar/src/rebar_completion_zsh.erl b/apps/rebar/src/rebar_completion_zsh.erl index 9300b3f72..d61834922 100644 --- a/apps/rebar/src/rebar_completion_zsh.erl +++ b/apps/rebar/src/rebar_completion_zsh.erl @@ -1,6 +1,7 @@ %% @doc Completion file generator for zsh %% @end -module(rebar_completion_zsh). +-moduledoc false. -behavior(rebar_completion). diff --git a/apps/rebar/src/rebar_config.erl b/apps/rebar/src/rebar_config.erl index 02e5c8f22..59b202539 100644 --- a/apps/rebar/src/rebar_config.erl +++ b/apps/rebar/src/rebar_config.erl @@ -25,6 +25,7 @@ %% THE SOFTWARE. %% ------------------------------------------------------------------- -module(rebar_config). +-moduledoc false. -export([consult_root/0 ,consult/1 diff --git a/apps/rebar/src/rebar_core.erl b/apps/rebar/src/rebar_core.erl index 588c2016d..65f05ec83 100644 --- a/apps/rebar/src/rebar_core.erl +++ b/apps/rebar/src/rebar_core.erl @@ -27,6 +27,7 @@ %% @doc Module providing core functionality about command dispatch, namespacing, %% and chaining for rebar3. -module(rebar_core). +-moduledoc false. -export([init_command/2, process_namespace/2, process_command/2, do/2, format_error/1]). diff --git a/apps/rebar/src/rebar_dialyzer_format.erl b/apps/rebar/src/rebar_dialyzer_format.erl index a5e733db9..b7e18fd77 100644 --- a/apps/rebar/src/rebar_dialyzer_format.erl +++ b/apps/rebar/src/rebar_dialyzer_format.erl @@ -13,6 +13,7 @@ %%% the 'red vs green' resambles the diff view 'remove vs add' %%% * blue: argument positions. -module(rebar_dialyzer_format). +-moduledoc false. -include("rebar.hrl"). diff --git a/apps/rebar/src/rebar_digraph.erl b/apps/rebar/src/rebar_digraph.erl index 776d7b8ba..11d594d0b 100644 --- a/apps/rebar/src/rebar_digraph.erl +++ b/apps/rebar/src/rebar_digraph.erl @@ -1,6 +1,7 @@ %%% @doc build a digraph of applications in order to figure out dependency %%% and compile order. -module(rebar_digraph). +-moduledoc false. -export([compile_order/1 ,restore_graph/1 diff --git a/apps/rebar/src/rebar_dist_utils.erl b/apps/rebar/src/rebar_dist_utils.erl index 06063a9c3..6cbda0c3e 100644 --- a/apps/rebar/src/rebar_dist_utils.erl +++ b/apps/rebar/src/rebar_dist_utils.erl @@ -1,6 +1,7 @@ %%% Common functions to boot/stop distributed setups for %%% the rebar3 script. -module(rebar_dist_utils). +-moduledoc false. -export([either/3, short/2, long/2, find_options/1]). -include("rebar.hrl"). diff --git a/apps/rebar/src/rebar_env.erl b/apps/rebar/src/rebar_env.erl index a0b6f4a2f..5cbd9fcf2 100644 --- a/apps/rebar/src/rebar_env.erl +++ b/apps/rebar/src/rebar_env.erl @@ -1,4 +1,5 @@ -module(rebar_env). +-moduledoc false. -export([create_env/1, create_env/2]). diff --git a/apps/rebar/src/rebar_erlc_compiler.erl b/apps/rebar/src/rebar_erlc_compiler.erl index 0667ebb0b..d22cb8e9d 100644 --- a/apps/rebar/src/rebar_erlc_compiler.erl +++ b/apps/rebar/src/rebar_erlc_compiler.erl @@ -25,6 +25,7 @@ %% THE SOFTWARE. %% ------------------------------------------------------------------- -module(rebar_erlc_compiler). +-moduledoc false. -export([compile/1, compile/2, compile/3, compile_dir/3, compile_dir/4, diff --git a/apps/rebar/src/rebar_fetch.erl b/apps/rebar/src/rebar_fetch.erl index 28753a308..ebadeba88 100644 --- a/apps/rebar/src/rebar_fetch.erl +++ b/apps/rebar/src/rebar_fetch.erl @@ -6,6 +6,7 @@ %% %% ------------------------------------------------------------------- -module(rebar_fetch). +-moduledoc false. -export([lock_source/2, download_source/2, diff --git a/apps/rebar/src/rebar_file_utils.erl b/apps/rebar/src/rebar_file_utils.erl index f9ebd07e0..9c3336389 100644 --- a/apps/rebar/src/rebar_file_utils.erl +++ b/apps/rebar/src/rebar_file_utils.erl @@ -25,6 +25,7 @@ %% THE SOFTWARE. %% ------------------------------------------------------------------- -module(rebar_file_utils). +-moduledoc false. -export([try_consult/1, consult_config/2, @@ -86,7 +87,7 @@ consult_config(State, Filename) -> consult_config_terms(State, Config). %% @doc Reads a config file via consult_env_config/2 if the file name has -%% the suffix `.src`, and with consult_config/2 otherwise +%% the suffix `.src', and with consult_config/2 otherwise -spec consult_any_config(rebar_state:t(), file:filename()) -> [[tuple()]]. consult_any_config(State, Filename) -> case is_src_config(Filename) of diff --git a/apps/rebar/src/rebar_git_resource.erl b/apps/rebar/src/rebar_git_resource.erl index 032223b62..5378d3cb2 100644 --- a/apps/rebar/src/rebar_git_resource.erl +++ b/apps/rebar/src/rebar_git_resource.erl @@ -1,6 +1,7 @@ %% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*- %% ex: ts=4 sw=4 et -module(rebar_git_resource). +-moduledoc false. -behaviour(rebar_resource_v2). diff --git a/apps/rebar/src/rebar_git_subdir_resource.erl b/apps/rebar/src/rebar_git_subdir_resource.erl index 9e4236937..b1c0e2c73 100644 --- a/apps/rebar/src/rebar_git_subdir_resource.erl +++ b/apps/rebar/src/rebar_git_subdir_resource.erl @@ -1,6 +1,7 @@ %% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*- %% ex: ts=4 sw=4 et -module(rebar_git_subdir_resource). +-moduledoc false. -behaviour(rebar_resource_v2). diff --git a/apps/rebar/src/rebar_hex_repos.erl b/apps/rebar/src/rebar_hex_repos.erl index 04cdf6870..d64fc4161 100644 --- a/apps/rebar/src/rebar_hex_repos.erl +++ b/apps/rebar/src/rebar_hex_repos.erl @@ -1,4 +1,5 @@ -module(rebar_hex_repos). +-moduledoc false. -export([from_state/2, get_repo_config/2, diff --git a/apps/rebar/src/rebar_hg_resource.erl b/apps/rebar/src/rebar_hg_resource.erl index d92a4aa8e..b5b368ef0 100644 --- a/apps/rebar/src/rebar_hg_resource.erl +++ b/apps/rebar/src/rebar_hg_resource.erl @@ -1,6 +1,7 @@ %% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*- %% ex: ts=4 sw=4 et -module(rebar_hg_resource). +-moduledoc false. -behaviour(rebar_resource_v2). diff --git a/apps/rebar/src/rebar_hooks.erl b/apps/rebar/src/rebar_hooks.erl index 6cbee307c..15a7227d8 100644 --- a/apps/rebar/src/rebar_hooks.erl +++ b/apps/rebar/src/rebar_hooks.erl @@ -1,4 +1,5 @@ -module(rebar_hooks). +-moduledoc false. -export([run_all_hooks/5 ,run_all_hooks/6 diff --git a/apps/rebar/src/rebar_httpc_adapter.erl b/apps/rebar/src/rebar_httpc_adapter.erl index 26318d1ba..d778a2c5b 100644 --- a/apps/rebar/src/rebar_httpc_adapter.erl +++ b/apps/rebar/src/rebar_httpc_adapter.erl @@ -1,6 +1,7 @@ %% Derived from hex_core v0.7.1 for extra flexibility. -module(rebar_httpc_adapter). +-moduledoc false. -behaviour(r3_hex_http). -export([request/5]). diff --git a/apps/rebar/src/rebar_log.erl b/apps/rebar/src/rebar_log.erl index 4942bf7fb..eb8457fe5 100644 --- a/apps/rebar/src/rebar_log.erl +++ b/apps/rebar/src/rebar_log.erl @@ -25,6 +25,7 @@ %% THE SOFTWARE. %% ------------------------------------------------------------------- -module(rebar_log). +-moduledoc false. -export([init/2, crashdump/2, diff --git a/apps/rebar/src/rebar_opts.erl b/apps/rebar/src/rebar_opts.erl index e7d38975d..594b80089 100644 --- a/apps/rebar/src/rebar_opts.erl +++ b/apps/rebar/src/rebar_opts.erl @@ -1,4 +1,5 @@ -module(rebar_opts). +-moduledoc false. -export([get/2, get/3, diff --git a/apps/rebar/src/rebar_otp_app.erl b/apps/rebar/src/rebar_otp_app.erl index e9dcb7886..1734d16c2 100644 --- a/apps/rebar/src/rebar_otp_app.erl +++ b/apps/rebar/src/rebar_otp_app.erl @@ -25,6 +25,7 @@ %% THE SOFTWARE. %% ------------------------------------------------------------------- -module(rebar_otp_app). +-moduledoc false. -export([compile/2, format_error/1]). diff --git a/apps/rebar/src/rebar_packages.erl b/apps/rebar/src/rebar_packages.erl index f7444f296..3a46c4a60 100644 --- a/apps/rebar/src/rebar_packages.erl +++ b/apps/rebar/src/rebar_packages.erl @@ -1,4 +1,5 @@ -module(rebar_packages). +-moduledoc false. -export([get/2 ,get_all_names/1 diff --git a/apps/rebar/src/rebar_parallel.erl b/apps/rebar/src/rebar_parallel.erl index eb4992d0a..95ffb1974 100644 --- a/apps/rebar/src/rebar_parallel.erl +++ b/apps/rebar/src/rebar_parallel.erl @@ -11,6 +11,7 @@ %%% without demanding to know all the tasks to run ahead of time. %%% @end -module(rebar_parallel). +-moduledoc false. -export([queue/5, pool/4, pool/5, pool_task_async/2, pool_terminate/1]). -include("rebar.hrl"). diff --git a/apps/rebar/src/rebar_pkg_resource.erl b/apps/rebar/src/rebar_pkg_resource.erl index d7d4f25a1..b174dd588 100644 --- a/apps/rebar/src/rebar_pkg_resource.erl +++ b/apps/rebar/src/rebar_pkg_resource.erl @@ -1,6 +1,7 @@ %% -*- erlang-indent-level: 4;indent-tabs-mode: nil -*- %% ex: ts=4 sw=4 et -module(rebar_pkg_resource). +-moduledoc false. -behaviour(rebar_resource_v2). diff --git a/apps/rebar/src/rebar_plugins.erl b/apps/rebar/src/rebar_plugins.erl index ad8211a94..1c364a331 100644 --- a/apps/rebar/src/rebar_plugins.erl +++ b/apps/rebar/src/rebar_plugins.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_plugins). +-moduledoc false. -export([project_plugins_install/1 ,top_level_install/1 diff --git a/apps/rebar/src/rebar_prv_alias.erl b/apps/rebar/src/rebar_prv_alias.erl index 41f71ac30..56f258a56 100644 --- a/apps/rebar/src/rebar_prv_alias.erl +++ b/apps/rebar/src/rebar_prv_alias.erl @@ -5,6 +5,7 @@ %%% from a plugin at https://github.com/tsloughter/rebar_alias after %%% years of stability. Only some error checks were added -module(rebar_prv_alias). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_app_discovery.erl b/apps/rebar/src/rebar_prv_app_discovery.erl index 20b7f904d..915255e2d 100644 --- a/apps/rebar/src/rebar_prv_app_discovery.erl +++ b/apps/rebar/src/rebar_prv_app_discovery.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_app_discovery). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_as.erl b/apps/rebar/src/rebar_prv_as.erl index f560113be..e036dc38c 100644 --- a/apps/rebar/src/rebar_prv_as.erl +++ b/apps/rebar/src/rebar_prv_as.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_as). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_bare_compile.erl b/apps/rebar/src/rebar_prv_bare_compile.erl index f1f91ba2f..775d75733 100644 --- a/apps/rebar/src/rebar_prv_bare_compile.erl +++ b/apps/rebar/src/rebar_prv_bare_compile.erl @@ -1,4 +1,5 @@ -module(rebar_prv_bare_compile). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_clean.erl b/apps/rebar/src/rebar_prv_clean.erl index 010d67cad..f0fd66008 100644 --- a/apps/rebar/src/rebar_prv_clean.erl +++ b/apps/rebar/src/rebar_prv_clean.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_clean). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_common_test.erl b/apps/rebar/src/rebar_prv_common_test.erl index a2542cf20..f4df86bdc 100644 --- a/apps/rebar/src/rebar_prv_common_test.erl +++ b/apps/rebar/src/rebar_prv_common_test.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_common_test). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_compile.erl b/apps/rebar/src/rebar_prv_compile.erl index bd774edfc..9c8344032 100644 --- a/apps/rebar/src/rebar_prv_compile.erl +++ b/apps/rebar/src/rebar_prv_compile.erl @@ -1,4 +1,5 @@ -module(rebar_prv_compile). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_completion.erl b/apps/rebar/src/rebar_prv_completion.erl index a1971fd88..719857a6c 100644 --- a/apps/rebar/src/rebar_prv_completion.erl +++ b/apps/rebar/src/rebar_prv_completion.erl @@ -1,6 +1,7 @@ %% @doc Generates shell completion files based on available providers and their opts. %% @end -module(rebar_prv_completion). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_cover.erl b/apps/rebar/src/rebar_prv_cover.erl index 611795d98..4fbae1c9e 100644 --- a/apps/rebar/src/rebar_prv_cover.erl +++ b/apps/rebar/src/rebar_prv_cover.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_cover). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_deps.erl b/apps/rebar/src/rebar_prv_deps.erl index d00a1c8ee..34d725a9c 100644 --- a/apps/rebar/src/rebar_prv_deps.erl +++ b/apps/rebar/src/rebar_prv_deps.erl @@ -1,4 +1,5 @@ -module(rebar_prv_deps). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_deps_tree.erl b/apps/rebar/src/rebar_prv_deps_tree.erl index 3a697be37..59d86c9bd 100644 --- a/apps/rebar/src/rebar_prv_deps_tree.erl +++ b/apps/rebar/src/rebar_prv_deps_tree.erl @@ -1,4 +1,5 @@ -module(rebar_prv_deps_tree). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_dialyzer.erl b/apps/rebar/src/rebar_prv_dialyzer.erl index ca71e3d11..a5923310f 100644 --- a/apps/rebar/src/rebar_prv_dialyzer.erl +++ b/apps/rebar/src/rebar_prv_dialyzer.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_dialyzer). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_do.erl b/apps/rebar/src/rebar_prv_do.erl index 5f7aa124d..c2a883960 100644 --- a/apps/rebar/src/rebar_prv_do.erl +++ b/apps/rebar/src/rebar_prv_do.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_do). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_edoc.erl b/apps/rebar/src/rebar_prv_edoc.erl index c7782d22d..06c29e606 100644 --- a/apps/rebar/src/rebar_prv_edoc.erl +++ b/apps/rebar/src/rebar_prv_edoc.erl @@ -1,4 +1,5 @@ -module(rebar_prv_edoc). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_escriptize.erl b/apps/rebar/src/rebar_prv_escriptize.erl index 43250ed64..e7289055b 100644 --- a/apps/rebar/src/rebar_prv_escriptize.erl +++ b/apps/rebar/src/rebar_prv_escriptize.erl @@ -25,6 +25,7 @@ %% THE SOFTWARE. %% ------------------------------------------------------------------- -module(rebar_prv_escriptize). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_eunit.erl b/apps/rebar/src/rebar_prv_eunit.erl index 16b39f40d..6cc01cb38 100644 --- a/apps/rebar/src/rebar_prv_eunit.erl +++ b/apps/rebar/src/rebar_prv_eunit.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_eunit). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_get_deps.erl b/apps/rebar/src/rebar_prv_get_deps.erl index 020e50bf4..14ead6844 100644 --- a/apps/rebar/src/rebar_prv_get_deps.erl +++ b/apps/rebar/src/rebar_prv_get_deps.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_get_deps). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_help.erl b/apps/rebar/src/rebar_prv_help.erl index 961b21d16..6db05edff 100644 --- a/apps/rebar/src/rebar_prv_help.erl +++ b/apps/rebar/src/rebar_prv_help.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_help). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_install_deps.erl b/apps/rebar/src/rebar_prv_install_deps.erl index 5331c4cbc..73145c61d 100644 --- a/apps/rebar/src/rebar_prv_install_deps.erl +++ b/apps/rebar/src/rebar_prv_install_deps.erl @@ -25,6 +25,7 @@ %% THE SOFTWARE. %% ------------------------------------------------------------------- -module(rebar_prv_install_deps). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_local_install.erl b/apps/rebar/src/rebar_prv_local_install.erl index a01ab7b3e..8a669b66e 100644 --- a/apps/rebar/src/rebar_prv_local_install.erl +++ b/apps/rebar/src/rebar_prv_local_install.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_local_install). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_local_upgrade.erl b/apps/rebar/src/rebar_prv_local_upgrade.erl index 74d198da6..9e65aee55 100644 --- a/apps/rebar/src/rebar_prv_local_upgrade.erl +++ b/apps/rebar/src/rebar_prv_local_upgrade.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_local_upgrade). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_lock.erl b/apps/rebar/src/rebar_prv_lock.erl index eb8b96ade..79bbd0df0 100644 --- a/apps/rebar/src/rebar_prv_lock.erl +++ b/apps/rebar/src/rebar_prv_lock.erl @@ -1,4 +1,5 @@ -module(rebar_prv_lock). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_manifest.erl b/apps/rebar/src/rebar_prv_manifest.erl index 272a14c8a..3d8a0e3bd 100644 --- a/apps/rebar/src/rebar_prv_manifest.erl +++ b/apps/rebar/src/rebar_prv_manifest.erl @@ -3,6 +3,7 @@ %% =================================================================== -module(rebar_prv_manifest). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_new.erl b/apps/rebar/src/rebar_prv_new.erl index 6368303a6..7c852b4ab 100644 --- a/apps/rebar/src/rebar_prv_new.erl +++ b/apps/rebar/src/rebar_prv_new.erl @@ -1,4 +1,5 @@ -module(rebar_prv_new). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_packages.erl b/apps/rebar/src/rebar_prv_packages.erl index a6a2c81b0..a905e2d63 100644 --- a/apps/rebar/src/rebar_prv_packages.erl +++ b/apps/rebar/src/rebar_prv_packages.erl @@ -1,4 +1,5 @@ -module(rebar_prv_packages). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_path.erl b/apps/rebar/src/rebar_prv_path.erl index dd0608c1a..9ba23d812 100644 --- a/apps/rebar/src/rebar_prv_path.erl +++ b/apps/rebar/src/rebar_prv_path.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_path). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_plugins.erl b/apps/rebar/src/rebar_prv_plugins.erl index 6fd10b262..d76db77ce 100644 --- a/apps/rebar/src/rebar_prv_plugins.erl +++ b/apps/rebar/src/rebar_prv_plugins.erl @@ -1,4 +1,5 @@ -module(rebar_prv_plugins). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_plugins_upgrade.erl b/apps/rebar/src/rebar_prv_plugins_upgrade.erl index e525e3822..fdd7ade46 100644 --- a/apps/rebar/src/rebar_prv_plugins_upgrade.erl +++ b/apps/rebar/src/rebar_prv_plugins_upgrade.erl @@ -1,4 +1,5 @@ -module(rebar_prv_plugins_upgrade). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_release.erl b/apps/rebar/src/rebar_prv_release.erl index f44a488c2..12dfec58c 100644 --- a/apps/rebar/src/rebar_prv_release.erl +++ b/apps/rebar/src/rebar_prv_release.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_release). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_relup.erl b/apps/rebar/src/rebar_prv_relup.erl index 814604194..c5f7bdebd 100644 --- a/apps/rebar/src/rebar_prv_relup.erl +++ b/apps/rebar/src/rebar_prv_relup.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_relup). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_report.erl b/apps/rebar/src/rebar_prv_report.erl index 73e962470..e263b5f43 100644 --- a/apps/rebar/src/rebar_prv_report.erl +++ b/apps/rebar/src/rebar_prv_report.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_report). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_repos.erl b/apps/rebar/src/rebar_prv_repos.erl index 051591069..d807de418 100644 --- a/apps/rebar/src/rebar_prv_repos.erl +++ b/apps/rebar/src/rebar_prv_repos.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_repos). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_shell.erl b/apps/rebar/src/rebar_prv_shell.erl index 587162aa2..4f6f6bb99 100644 --- a/apps/rebar/src/rebar_prv_shell.erl +++ b/apps/rebar/src/rebar_prv_shell.erl @@ -26,6 +26,7 @@ %% ------------------------------------------------------------------- -module(rebar_prv_shell). +-moduledoc false. -author("Kresten Krab Thorup "). -author("Fred Hebert "). diff --git a/apps/rebar/src/rebar_prv_state.erl b/apps/rebar/src/rebar_prv_state.erl index 4fbcb6759..056efd1ab 100644 --- a/apps/rebar/src/rebar_prv_state.erl +++ b/apps/rebar/src/rebar_prv_state.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_state). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_tar.erl b/apps/rebar/src/rebar_prv_tar.erl index e54ab6de5..6d00d53b4 100644 --- a/apps/rebar/src/rebar_prv_tar.erl +++ b/apps/rebar/src/rebar_prv_tar.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_tar). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_unlock.erl b/apps/rebar/src/rebar_prv_unlock.erl index f0b2298d7..7e94415ee 100644 --- a/apps/rebar/src/rebar_prv_unlock.erl +++ b/apps/rebar/src/rebar_prv_unlock.erl @@ -1,4 +1,5 @@ -module(rebar_prv_unlock). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_update.erl b/apps/rebar/src/rebar_prv_update.erl index 4c820c5b3..1b1c44a12 100644 --- a/apps/rebar/src/rebar_prv_update.erl +++ b/apps/rebar/src/rebar_prv_update.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_update). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_upgrade.erl b/apps/rebar/src/rebar_prv_upgrade.erl index 63ad951e3..450917448 100644 --- a/apps/rebar/src/rebar_prv_upgrade.erl +++ b/apps/rebar/src/rebar_prv_upgrade.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_upgrade). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_vendor.erl b/apps/rebar/src/rebar_prv_vendor.erl index 7e1cafb27..456076480 100644 --- a/apps/rebar/src/rebar_prv_vendor.erl +++ b/apps/rebar/src/rebar_prv_vendor.erl @@ -1,4 +1,5 @@ -module(rebar_prv_vendor). +-moduledoc false. -behaviour(provider). -export([init/1, diff --git a/apps/rebar/src/rebar_prv_version.erl b/apps/rebar/src/rebar_prv_version.erl index bcc5f6c66..fc635dc73 100644 --- a/apps/rebar/src/rebar_prv_version.erl +++ b/apps/rebar/src/rebar_prv_version.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_version). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_prv_xref.erl b/apps/rebar/src/rebar_prv_xref.erl index e2d504e2b..a7223ad8c 100644 --- a/apps/rebar/src/rebar_prv_xref.erl +++ b/apps/rebar/src/rebar_prv_xref.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_prv_xref). +-moduledoc false. -behaviour(provider). diff --git a/apps/rebar/src/rebar_relx.erl b/apps/rebar/src/rebar_relx.erl index bfb4674d0..6c152eeba 100644 --- a/apps/rebar/src/rebar_relx.erl +++ b/apps/rebar/src/rebar_relx.erl @@ -2,6 +2,7 @@ %% ex: ts=4 sw=4 et -module(rebar_relx). +-moduledoc false. -export([do/2, opt_spec_list/0, diff --git a/apps/rebar/src/rebar_string.erl b/apps/rebar/src/rebar_string.erl index 24989e7fb..a45c62cbf 100644 --- a/apps/rebar/src/rebar_string.erl +++ b/apps/rebar/src/rebar_string.erl @@ -3,6 +3,7 @@ %%% %%% Also contains other useful string functionality. -module(rebar_string). +-moduledoc false. %% Compatibility exports -export([join/2, split/2, lexemes/2, trim/1, trim/3, uppercase/1, lowercase/1, chr/2]). %% Util exports diff --git a/apps/rebar/src/rebar_templater.erl b/apps/rebar/src/rebar_templater.erl index ce1959397..0507b1188 100644 --- a/apps/rebar/src/rebar_templater.erl +++ b/apps/rebar/src/rebar_templater.erl @@ -25,6 +25,7 @@ %% THE SOFTWARE. %% ------------------------------------------------------------------- -module(rebar_templater). +-moduledoc false. -export([new/4, list_templates/1, diff --git a/apps/rebar/src/rebar_uri.erl b/apps/rebar/src/rebar_uri.erl index ac32f95ce..24f1a740a 100644 --- a/apps/rebar/src/rebar_uri.erl +++ b/apps/rebar/src/rebar_uri.erl @@ -1,5 +1,6 @@ %%% @doc multi-OTP version compatibility shim for working with URIs -module(rebar_uri). +-moduledoc false. -export([ parse/1, parse/2, scheme_defaults/0, diff --git a/apps/rebar/src/rebar_user.erl b/apps/rebar/src/rebar_user.erl index f20142dc1..89a2820a6 100644 --- a/apps/rebar/src/rebar_user.erl +++ b/apps/rebar/src/rebar_user.erl @@ -27,6 +27,7 @@ %% %CopyrightEnd% %% -module(rebar_user). +-moduledoc false. -compile(inline). %% Basic standard i/o server for user interface port. diff --git a/apps/rebar/src/vendored/r3_hex_api.erl b/apps/rebar/src/vendored/r3_hex_api.erl index 33d4f8b28..149d8856a 100644 --- a/apps/rebar/src/vendored/r3_hex_api.erl +++ b/apps/rebar/src/vendored/r3_hex_api.erl @@ -3,6 +3,7 @@ %% @doc %% Hex HTTP API -module(r3_hex_api). +-moduledoc false. -export([ delete/2, diff --git a/apps/rebar/src/vendored/r3_hex_api_key.erl b/apps/rebar/src/vendored/r3_hex_api_key.erl index bd549eda1..25f315e7d 100644 --- a/apps/rebar/src/vendored/r3_hex_api_key.erl +++ b/apps/rebar/src/vendored/r3_hex_api_key.erl @@ -3,6 +3,7 @@ %% @doc %% Hex HTTP API - Keys. -module(r3_hex_api_key). +-moduledoc false. -export([ list/1, get/2, diff --git a/apps/rebar/src/vendored/r3_hex_api_package.erl b/apps/rebar/src/vendored/r3_hex_api_package.erl index 7cbbdf472..2bc8a5918 100644 --- a/apps/rebar/src/vendored/r3_hex_api_package.erl +++ b/apps/rebar/src/vendored/r3_hex_api_package.erl @@ -3,6 +3,7 @@ %% @doc %% Hex HTTP API - Packages. -module(r3_hex_api_package). +-moduledoc false. -export([get/2, search/3]). %% @doc diff --git a/apps/rebar/src/vendored/r3_hex_api_package_owner.erl b/apps/rebar/src/vendored/r3_hex_api_package_owner.erl index 7bcd0f276..bf5520728 100644 --- a/apps/rebar/src/vendored/r3_hex_api_package_owner.erl +++ b/apps/rebar/src/vendored/r3_hex_api_package_owner.erl @@ -3,6 +3,7 @@ %% @doc %% Hex HTTP API - Package Owners. -module(r3_hex_api_package_owner). +-moduledoc false. -export([ add/5, delete/3, diff --git a/apps/rebar/src/vendored/r3_hex_api_release.erl b/apps/rebar/src/vendored/r3_hex_api_release.erl index f10585dc5..13490a908 100644 --- a/apps/rebar/src/vendored/r3_hex_api_release.erl +++ b/apps/rebar/src/vendored/r3_hex_api_release.erl @@ -3,6 +3,7 @@ %% @doc %% Hex HTTP API - Releases. -module(r3_hex_api_release). +-moduledoc false. -export([ delete/3, get/3, diff --git a/apps/rebar/src/vendored/r3_hex_api_user.erl b/apps/rebar/src/vendored/r3_hex_api_user.erl index 70545c349..8a487db5f 100644 --- a/apps/rebar/src/vendored/r3_hex_api_user.erl +++ b/apps/rebar/src/vendored/r3_hex_api_user.erl @@ -3,6 +3,7 @@ %% @doc %% Hex HTTP API - Users. -module(r3_hex_api_user). +-moduledoc false. -export([ create/4, get/2, diff --git a/apps/rebar/src/vendored/r3_hex_core.erl b/apps/rebar/src/vendored/r3_hex_core.erl index 441d2b50d..0ff097795 100644 --- a/apps/rebar/src/vendored/r3_hex_core.erl +++ b/apps/rebar/src/vendored/r3_hex_core.erl @@ -62,6 +62,7 @@ %% `134_217_728' (128 MiB). Set to `infinity' to not enforce the limit. -module(r3_hex_core). +-moduledoc false. -export([default_config/0]). -export_type([config/0]). diff --git a/apps/rebar/src/vendored/r3_hex_erl_tar.erl b/apps/rebar/src/vendored/r3_hex_erl_tar.erl index cfd62bc8b..a1fb28655 100644 --- a/apps/rebar/src/vendored/r3_hex_erl_tar.erl +++ b/apps/rebar/src/vendored/r3_hex_erl_tar.erl @@ -43,6 +43,7 @@ %% http://www.gnu.org/software/tar/manual/html_node/Standard.html %% http://pubs.opengroup.org/onlinepubs/9699919799/utilities/pax.html -module(r3_hex_erl_tar). +-moduledoc false. -export([init/3, create/2, create/3, diff --git a/apps/rebar/src/vendored/r3_hex_filename.erl b/apps/rebar/src/vendored/r3_hex_filename.erl index d3ff344c1..b6febe254 100644 --- a/apps/rebar/src/vendored/r3_hex_filename.erl +++ b/apps/rebar/src/vendored/r3_hex_filename.erl @@ -28,6 +28,7 @@ %% -module(r3_hex_filename). +-moduledoc false. -export([safe_relative_path/1]). safe_relative_path(Path) -> diff --git a/apps/rebar/src/vendored/r3_hex_http.erl b/apps/rebar/src/vendored/r3_hex_http.erl index 5e79a8ae1..26438c152 100644 --- a/apps/rebar/src/vendored/r3_hex_http.erl +++ b/apps/rebar/src/vendored/r3_hex_http.erl @@ -3,6 +3,7 @@ %% @doc %% HTTP contract. -module(r3_hex_http). +-moduledoc false. -export([request/5]). -ifdef(TEST). -export([user_agent/1]). diff --git a/apps/rebar/src/vendored/r3_hex_http_httpc.erl b/apps/rebar/src/vendored/r3_hex_http_httpc.erl index 3af77e2c1..a9f2cde0e 100644 --- a/apps/rebar/src/vendored/r3_hex_http_httpc.erl +++ b/apps/rebar/src/vendored/r3_hex_http_httpc.erl @@ -13,6 +13,7 @@ %% {@link httpc:request/5} for a list of available HTTP options. -module(r3_hex_http_httpc). +-moduledoc false. -behaviour(r3_hex_http). -export([request/5]). diff --git a/apps/rebar/src/vendored/r3_hex_licenses.erl b/apps/rebar/src/vendored/r3_hex_licenses.erl index ba42b071b..7270f98e3 100644 --- a/apps/rebar/src/vendored/r3_hex_licenses.erl +++ b/apps/rebar/src/vendored/r3_hex_licenses.erl @@ -5,6 +5,7 @@ %% File generated by https://github.com/supersimple/spdx. Do not edit manually. -module(r3_hex_licenses). +-moduledoc false. -export([valid/1]). diff --git a/apps/rebar/src/vendored/r3_hex_pb_names.erl b/apps/rebar/src/vendored/r3_hex_pb_names.erl index e05ed1ce2..c1d916406 100644 --- a/apps/rebar/src/vendored/r3_hex_pb_names.erl +++ b/apps/rebar/src/vendored/r3_hex_pb_names.erl @@ -7,6 +7,7 @@ %% Generated by gpb_compile version 4.21.1 %% Version source: file -module(r3_hex_pb_names). +-moduledoc false. -export([encode_msg/2, encode_msg/3]). -export([decode_msg/2, decode_msg/3]). diff --git a/apps/rebar/src/vendored/r3_hex_pb_package.erl b/apps/rebar/src/vendored/r3_hex_pb_package.erl index 03eeae97a..3533be7eb 100644 --- a/apps/rebar/src/vendored/r3_hex_pb_package.erl +++ b/apps/rebar/src/vendored/r3_hex_pb_package.erl @@ -7,6 +7,7 @@ %% Generated by gpb_compile version 4.21.1 %% Version source: file -module(r3_hex_pb_package). +-moduledoc false. -export([encode_msg/2, encode_msg/3]). -export([decode_msg/2, decode_msg/3]). diff --git a/apps/rebar/src/vendored/r3_hex_pb_signed.erl b/apps/rebar/src/vendored/r3_hex_pb_signed.erl index d3891a41f..1ef6c2124 100644 --- a/apps/rebar/src/vendored/r3_hex_pb_signed.erl +++ b/apps/rebar/src/vendored/r3_hex_pb_signed.erl @@ -7,6 +7,7 @@ %% Generated by gpb_compile version 4.21.1 %% Version source: file -module(r3_hex_pb_signed). +-moduledoc false. -export([encode_msg/2, encode_msg/3]). -export([decode_msg/2, decode_msg/3]). diff --git a/apps/rebar/src/vendored/r3_hex_pb_versions.erl b/apps/rebar/src/vendored/r3_hex_pb_versions.erl index b9c5d8f60..aac8df1c9 100644 --- a/apps/rebar/src/vendored/r3_hex_pb_versions.erl +++ b/apps/rebar/src/vendored/r3_hex_pb_versions.erl @@ -7,6 +7,7 @@ %% Generated by gpb_compile version 4.21.1 %% Version source: file -module(r3_hex_pb_versions). +-moduledoc false. -export([encode_msg/2, encode_msg/3]). -export([decode_msg/2, decode_msg/3]). diff --git a/apps/rebar/src/vendored/r3_hex_registry.erl b/apps/rebar/src/vendored/r3_hex_registry.erl index 3d17fa37c..3d33a8fbf 100644 --- a/apps/rebar/src/vendored/r3_hex_registry.erl +++ b/apps/rebar/src/vendored/r3_hex_registry.erl @@ -3,6 +3,7 @@ %% @doc %% Functions for encoding and decoding Hex registries. -module(r3_hex_registry). +-moduledoc false. -export([ encode_names/1, decode_names/2, diff --git a/apps/rebar/src/vendored/r3_hex_repo.erl b/apps/rebar/src/vendored/r3_hex_repo.erl index cd26291ce..04d8bfecf 100644 --- a/apps/rebar/src/vendored/r3_hex_repo.erl +++ b/apps/rebar/src/vendored/r3_hex_repo.erl @@ -3,6 +3,7 @@ %% @doc %% Repo API. -module(r3_hex_repo). +-moduledoc false. -export([ get_names/1, get_versions/1, diff --git a/apps/rebar/src/vendored/r3_hex_tarball.erl b/apps/rebar/src/vendored/r3_hex_tarball.erl index 233b922a3..1bce3b0ae 100644 --- a/apps/rebar/src/vendored/r3_hex_tarball.erl +++ b/apps/rebar/src/vendored/r3_hex_tarball.erl @@ -3,6 +3,7 @@ %% @doc %% Functions for creating and unpacking Hex tarballs. -module(r3_hex_tarball). +-moduledoc false. -export([ create/2, create/3, create_docs/1, create_docs/2, diff --git a/apps/rebar/src/vendored/r3_safe_erl_term.xrl b/apps/rebar/src/vendored/r3_safe_erl_term.xrl index 2f3cd22f8..2b3f15c6a 100644 --- a/apps/rebar/src/vendored/r3_safe_erl_term.xrl +++ b/apps/rebar/src/vendored/r3_safe_erl_term.xrl @@ -24,7 +24,7 @@ Rules. {WS}+ : skip_token. Erlang code. - +-moduledoc false. -export([terms/1]). terms(Tokens) -> diff --git a/docs/about/about-us.md b/docs/about/about-us.md new file mode 100644 index 000000000..c85d0132a --- /dev/null +++ b/docs/about/about-us.md @@ -0,0 +1,16 @@ +# About Us +## Community + +- [Issue Tracker](https://github.com/erlang/rebar3/issues) +- [Github Discussions](https://github.com/erlang/rebar3/discussions) +- Slack: #rebar3 on [Erlang Slack](https://erlef.org/slack-invite/erlanger) +- IRC: #rebar on freenode +- [Contribution guidelines](https://github.com/erlang/rebar3/blob/master/CONTRIBUTING.md) + +## Credits + +- [Source Contributors](https://github.com/rebar/rebar3/blob/master/THANKS) *(including rebar 2.x contributors prior to forking)* +- Rebar3 logo by [Francis Tseng](https://twitter.com/frnsys). +- Maintainers with admin rights: + - [@tsloughter](https://github.com/tsloughter/) + - [@ferd](https://github.com/ferd/) diff --git a/docs/about/security-policy.md b/docs/about/security-policy.md new file mode 100644 index 000000000..2a7e0a813 --- /dev/null +++ b/docs/about/security-policy.md @@ -0,0 +1,45 @@ +# Security Policy +## Security Caveats + +Rebar3 is a build tool that by design allows arbitrary code execution from downloaded components. Scripts can be executed in all kinds of areas of a regular project workflow including (but not limited to): scripts to modify configuration files, "parse transforms" (macros), plugins, provider and shell hooks, and so on. + +Users of Rebar3 should be aware of the nature of its model, and issues related to these parts of its design will not be considered to be security issues nor vulnerabilities. + +## Reporting a Security Issue + +All security issues should be reported to one or more of the current maintainers: + +- [Fred Hebert](https://keybase.io/mononcqc) ([@ferd](https://github.com/ferd/)) +- [Tristan Sloughter](https://keybase.io/tsloughter) ([@tsloughter](https://github.com/tsloughter/)) + +E-Mail addresses are available in GitHub profiles, and PGP public keys in Keybase profiles. + +If you have not received a reply to your query within 48 hours, or have not heard from one of the maintainers for the past five days, there are a few steps you can take: + +- One of the authenticated channels in the maintainers Keybase profiles +- Open a GitHub issue directly +- Ask on #rebar3 on the [official Erlang Slack team](https://erlef.org/slack-invite/erlanger) +- Ask on #rebar on IRC on libera.chat + +Please note that the GitHub issues, mailing list, and chat channels are public areas. When escalating in these venues, please do not discuss details of your issue. Simply say that you’re trying to get a hold of someone from the maintainer team. + +## Disclosure Policy + +We're a small project of volunteers working in whatever free time they have, with limited mechanisms to reach developers from other communication channels. + +Disclosure will be fairly ad-hoc and made to reach as many people as possible. + +Nevertheless, the expected steps are: + +1. The issue is received and discussed privately by the maintainers +2. A fix is prepared and reviewed between maintainers +3. When ready, the fix will be committed to the repository and a release will be cut +4. An announcement will be made about the new release on the public channels associated to the project + +## Receiving Security Updates + +The best way to know about security updates is to subscribe to any of the communication channels of the project. + +## Comments on This Policy + +If you have any suggestions to improve this policy, please contact the maintainers or open a GitHub issue. diff --git a/docs/basic_usage.md b/docs/basic_usage.md new file mode 100644 index 000000000..201a7eae0 --- /dev/null +++ b/docs/basic_usage.md @@ -0,0 +1,195 @@ +# Basic Usage + +## New App or Release + +There are two main ways to organize code with rebar3 projects: either as a single application, or as an umbrella project. + +Single application projects contain a lone top-level application at the root of the directory, with its Erlang source modules directly inside a `src/` directory. This format is applicable to libraries to be published on GitHub or in hex with the objective of making them shareable to the world, but can also be used with [Releases](deployment/releases.md), which allow to ship an Erlang runtime system that boots the application directly. + +Umbrella projects' defining characteristic is that they can contain multiple top-level Erlang/OTP applications, usually within a top-level `apps/` or `lib/` directory. Each of these applications may contain its own rebar.config file. This format is applicable to only for releases with one or more top-level applications. + +Rebar3 comes with templates for creating either types of project, callable through the `rebar3 new