aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)Author
2018-12-04Fix and document Dialyzer against beam filesLoïc Hoguin
2018-12-04Document cross compilingLoïc Hoguin
2018-12-04Add ci.erlang.mk to the plugin listLoïc Hoguin
2018-12-03Add version.mk to the plugins listLoïc Hoguin
2018-12-03Don't rebuild dependencies by defaultLoïc Hoguin
Unless it's a symbolic link, it's built directly, FULL=1 is set or the file ebin/dep_built in the dependency is removed. See the documentation changes for more details. This provides immense build speed gains, for example on a RabbitMQ project it went from 10s to 1s for the 2nd+ builds.
2018-11-30Document selecting RELX_CONFIG for prod/devLoïc Hoguin
2018-11-30Document that DEPS has precedence over TEST_DEPS etc.Loïc Hoguin
And a workaround to force a specific version to be downloaded.
2018-11-29Add the target help-plugins to document external pluginsLoïc Hoguin
It's better than extending help:: because this gets printed at the end instead of before Erlang.mk's own help.
2018-11-28Document parallel buildingLoïc Hoguin
2018-11-28Rename the rel/ directory to config/ by defaultLoïc Hoguin
2018-11-26Allow running test cases without groups in CTLoïc Hoguin
2018-11-26Add a guide section about dealing with duplicate modulesLoïc Hoguin
While the solution is not the best we could do it's better than nothing.
2018-11-26Document the requirement on flock for parallel buildsLoïc Hoguin
2018-11-24Add the git-subfolder fetch methodLoïc Hoguin
It clones and checkouts like the git fetch method, but does so in the Erlang.mk temporary directory. It then creates a symbolic link to the subfolder for the dependency.
2018-11-24Document building EDoc on all apps in multi-apps projectsLoïc Hoguin
2018-07-05Document ERLANG_MK_REPO and ERLANG_MK_COMMITKrzysztof Jurewicz
2018-06-04Add basic documentation for Triq pluginKrzysztof Jurewicz
This is based on the documentation of the EUnit plugin.
2018-05-31Add $(TEST_DIR) to the default value of SHELL_PATHSKrzysztof Jurewicz
2018-05-14Document PROJECT_ENV usage with/without fileAlexander Clouter
LH: I have added the example without a separate file and tweaked the wording a bit.
2018-04-25Add gen_statem templatejuhlig
[skip ci]
2018-01-24On Alpine gawk is requiredLoïc Hoguin
2018-01-24Tweak the new Sphinx plugin's documentationLoïc Hoguin
2018-01-24Add support for Sphinx documentation builderStanislaw Klekot
2017-10-07docs: use `make` instead of deprecated homebrew `homebrew/dupes/mak`rheza
2017-09-17Add trick for exporting C build flags to sub-MakefilesLoïc Hoguin
Thanks to dozzie on IRC for the suggestion.
2017-08-28Tweak newly added docsLoïc Hoguin
2017-08-28Document CI and OTP version management/pinningLoïc Hoguin
2017-05-26Fix a typoLoïc Hoguin
Thanks to Eric Pailleau for reporting it!
2017-05-25Edit the previous doc additionLoïc Hoguin
2017-05-25Document workaround with relx semver valueStanislav Ovchar
2017-05-17Add a note about Windows CRLF2017.05.18Loïc Hoguin
2017-05-15Add tweaks and tests for the WITHOUT featureLoïc Hoguin
2017-05-15Add WITHOUT variable to exclude components on buildbenoitc
This allows to ignore lines from the default build.config if needed. For example to not include packages run make WITHOUT=index
2017-05-15Support plugins local to the applicationJean-Sébastien Pédron
If the application's Makefile specify either: DEP_PLUGINS = $(PROJECT) or e.g.: DEP_PLUGINS = $(PROJECT)/mk/dist.mk then load the plugin from the application instead of a dependency. This helps when you have an application with common Erlang modules and Erlang.mk plugins: your common application can load Erlang.mk plugins exactly like other applications depending on the common application.
2017-05-15Add dep_fetch_lnderwinlu
2017-05-15Make autopatch of Erlang.mk projects less obtrusiveLoïc Hoguin
We do not touch the erlang.mk file anymore. We only patch the Makefile to include the top-level Erlang.mk by changing the 'include erlang.mk' line to look for ERLANG_MK_FILENAME if it is defined. The modified Makefile can be committed safely.
2017-05-12Support early-stage plugins through `$(DEP_EARLY_PLUGINS)`Jean-Sébastien Pédron
Regular plugins (`$(DEP_PLUGINS)`) are loaded near the end of Erlang.mk. This is fine when you want to modify variables initialized earlier in Erlang.mk or add new targets and variables. However, it doesn't allow you to declare more dependencies because they are loaded too late for that. This commit introduces a new variable, `$(DEP_EARLY_PLUGINS)`, which can be used to list plugins meant to be loaded near the beginning of Erlang.mk. Those allow to append to the list of dependencies. They work exactly like regular plugins otherwise. The default filename loaded is `early-plugins.mk`.
2017-04-25compile apps in the right order by looking at their LOCAL_DEPSJeffrey Griffin
we also use LOCAL_DEPS at the top-level, if it exists, to determine which local apps to compile, in the interest of saving compile time for projects that have many apps and multiple release configurations
2017-02-08Fix Archlinux Installation Instructionsderwinlu
Suggesting -Sy is a terrible idea[1]. This commit replaces it with -S which is the default on how packages should be added on Archlinux. Resolves #662. [1]: https://bbs.archlinux.org/viewtopic.php?id=89328
2017-01-12Set ASN.1 compilation options using ERLC_ASN1_OPTS2017.01.12Klas Johansson
`ERLC_ASN1_OPTS` can be used to pass compiler options when compiling ASN.1 files. By default, Erlang.mk will leave this empty, but it can be redefined in a Makefile.
2016-11-26Add CT_LOGS_DIRnevar
2016-11-03Clarify gmake commands on FreeBSD/HomebrewLoïc Hoguin
[ci skip]
2016-11-01Document ESCRIPT_ZIP=zip and Ubuntu's p7zip-fullLoïc Hoguin
[ci-skip]
2016-10-30Greatly improve the escript supportLoïc Hoguin
The plugin can now easily generate escripts as complex as relx or rebar/rebar3. It generates a proper structure and allows embedding extra files by extending the escript-zip target. Documentation and tests have been added.
2016-10-29Add chapter about self-extracting releasesLoïc Hoguin
[ci-skip]
2016-10-28Add "make relup"Loïc Hoguin
The initial documentation is a bit rough. It's getting late and I'd like to have this in sooner rather than later. :-)
2016-10-25Simplify the curl method to get erlang.mkLoïc Hoguin
2016-10-25core/deps-tools.mk: New targets `fetch-deps` and `list-deps`Jean-Sébastien Pédron
.. to fetch and list deps recurvively. Therefore, they work on direct dependencies, dependencies' dependencies, and so on. Nothing is built with those targets. The following targets are also available to work on other kinds of dependencies: make fetch-doc-deps make fetch-rel-deps make fetch-test-deps make fetch-shell-deps make list-doc-deps make list-rel-deps make list-test-deps make list-shell-deps In all cases, they include "normal" and eg. "test" dependencies of the top-level project, then only "normal" dependencies' dependencies. It's possible to include several kinds in one go: make fetch-deps DEP_TYPES='doc test' make list-deps DEP_TYPES='doc test' As it may be difficult to use the output of `make list-*` because the list could appear after other targets output (like dependencies fetching), the list is available in files pointed by the following variables: $(ERLANG_MK_RECURSIVE_DEPS_LIST) $(ERLANG_MK_RECURSIVE_DOC_DEPS_LIST) $(ERLANG_MK_RECURSIVE_REL_DEPS_LIST) $(ERLANG_MK_RECURSIVE_TEST_DEPS_LIST) $(ERLANG_MK_RECURSIVE_SHELL_DEPS_LIST) Internally, `list-deps` is simply implemented on top of `fetch-deps`: the latter fills a sorted log with all the directories it traversed. `list-deps` finally just prints the log file to stdout. Fixes #560.
2016-10-25installation.asciidoc: Fix Erlang package name on FreeBSDJean-Sébastien Pédron
2016-10-23Support PROJECT_APP_EXTRA_KEYS to add keys to the .app fileJean-Sébastien Pédron
This allows to add standard keys which do not have a corresponding `PROJECT_` Makefile variable, as well as non-standard keys.