Skip to content

Commit

Permalink
documentation on staging directory info
Browse files Browse the repository at this point in the history
  • Loading branch information
ityonemo committed Aug 10, 2024
1 parent bcaaa5f commit 797d114
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion lib/zig.ex
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ defmodule Zig do
end
```
### Custom source location
### Advanced Usage: Custom source location
By default, Zigler places generated source code in the same directory
as the module that uses Zigler, however, you may specify a different
Expand All @@ -271,6 +271,15 @@ defmodule Zig do
end
```
### Advanced usage: change staging directory location
By default, zigler stages files in `/tmp/{modulename}` directory. In some cases
this will cause user collisions and permissions errors when trying to build modules
on multitenant systems. If you need to change the staging directory, set the
`ZIGLER_STAGING_ROOT` environment variable to the desired directory. The
recommended staging directory is `~/.cache/zigler`. NB: In the future, this
may become the default staging directory.
"""
# default release modes.
# you can override these in your `use Zigler` statement.
Expand Down

0 comments on commit 797d114

Please sign in to comment.