Skip to content

Add more details on priv artifacts #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 28, 2025
Merged

Add more details on priv artifacts #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9385af2
Add more details on priv artifacts
jonatanklosko Jan 28, 2025
9eecf28
Up
jonatanklosko Jan 28, 2025
7152f36
Update lib/mix/tasks/compile.elixir_make.ex
josevalim Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion PRECOMPILATION_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Precompilation guide

This guide has two sections, the first one is intended for precompiler module developers. It covers a minimal example of creating a precompiler module. The second section is intended for library developers who want their library to be able to use precompiled artefacts in a simple way.
This guide has two sections, the first one is intended for library developers who want their library to be able to use precompiled artefacts in a simple way. The second section one is intended for precompiler module developers and it covers a minimal example of creating a precompiler module.

- [Library Developer](#library-developer)
- [Precompiler Module Developer](#precompiler-module-developer)
Expand Down
17 changes: 15 additions & 2 deletions lib/mix/tasks/compile.elixir_make.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,21 @@ defmodule Mix.Tasks.Compile.ElixirMake do
Generally speaking, compilation artifacts are written to the `priv`
directory, as that the only directory, besides `ebin`, which are
available to Erlang/OTP applications. Therefore, we recommend the
Makefile top copy any artifact to `$MIX_APP_PATH/priv` or, even
better, to `$MIX_APP_PATH/priv/$MIX_TARGET`.
Makefile to copy any artifact to `$MIX_APP_PATH/priv` and to have
no top-level `priv` directory.

In case you create a top-level `priv` directory, it gets symlinked
to all build directories, in which case you should rather copy the
artifacts to `$MIX_APP_PATH/priv/$MIX_TARGET`. This is relevant for
projects like Nerves that build for several targets and may involve
cross-compilation, so the user ends up with one _build subdirectory
per target and we don't want artifacts in the symlinked `priv` to
override each other. The downside of shared `priv` is that creating
a release would copy all its contents, even with the artifacts not
related to the given target. So, if your compilation is expensive
it may be better to never create top-level `priv` and manage your
own `cache` directory with per-target artifacts and copy them to
`$MIX_APP_PATH/priv`.
"""

use Mix.Task
Expand Down