From 797d11439d9b2a498604782c3049a775b0340f2c Mon Sep 17 00:00:00 2001 From: isaac yonemoto Date: Sat, 10 Aug 2024 16:52:11 -0500 Subject: [PATCH] documentation on staging directory info --- lib/zig.ex | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/lib/zig.ex b/lib/zig.ex index 07036764..c5f725d9 100644 --- a/lib/zig.ex +++ b/lib/zig.ex @@ -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 @@ -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.