From 1cf7851ccb002c95c0ef19a67807fb33895b723b Mon Sep 17 00:00:00 2001
From: Tristan Sloughter <t@crashfast.com>
Date: Fri, 26 Jan 2018 17:49:18 -0800
Subject: update create_target.xmlsrc and release structure docs

---
 system/doc/design_principles/release_structure.xml | 6 +++---
 system/doc/system_principles/create_target.xmlsrc  | 8 ++++++++
 2 files changed, 11 insertions(+), 3 deletions(-)

(limited to 'system')

diff --git a/system/doc/design_principles/release_structure.xml b/system/doc/design_principles/release_structure.xml
index a0ab21c43f..8e62ba845f 100644
--- a/system/doc/design_principles/release_structure.xml
+++ b/system/doc/design_principles/release_structure.xml
@@ -208,8 +208,8 @@ releases/ch_rel-1.rel</pre>
       is therefore now instead duplicated in the tar file so no manual
       copying is necessary.</p>
     <p>If a <c>relup</c> file and/or a system configuration file called
-      <c>sys.config</c> is found, these files are also included in
-      the release package. See
+      <c>sys.config</c>, or a <c>sys.config.src</c>, is found, these files
+      are also included in the release package. See
       <seealso marker="release_handling#req">Release Handling</seealso>.</p>
     <p>Options can be set to make the release package include source
       code and the ERTS binary as well.</p>
@@ -240,7 +240,7 @@ $ROOT/lib/App1-AVsn1/ebin
        <item><c>erts-EVsn/bin</c> - Erlang runtime system executables</item>
        <item><c>releases/Vsn</c> - <c>.rel</c> file and boot script
        <c>start.boot</c>; if present in the release package, <c>relup</c>
-       and/or <c>sys.config</c></item>
+       and/or <c>sys.config</c> or <c>sys.config.src</c></item>
        <item><c>bin</c> - Top-level Erlang runtime system executables</item>
      </list>
     <p>Applications are not required to be located under directory
diff --git a/system/doc/system_principles/create_target.xmlsrc b/system/doc/system_principles/create_target.xmlsrc
index f9b27ffc35..dc6cbbe980 100644
--- a/system/doc/system_principles/create_target.xmlsrc
+++ b/system/doc/system_principles/create_target.xmlsrc
@@ -263,6 +263,14 @@ os> <input>/usr/local/erl-target/bin/erl -boot /usr/local/erl-target/releases/FI
       current directory create not only the file <c>mysystem.rel</c>,
       but also file <c>sys.config</c>, the latter file is tacitly
       put in the appropriate directory.</p>
+    <p>However, it can also be convenient to replace variables in
+       within a <c>sys.config</c> on the target after unpacking but
+       before running the release. If you have a <c>sys.config.src</c>
+       it will be included and is not required to be a valid Erlang term
+       file like <c>sys.config</c>. Before running the release you must
+       have a valid <c>sys.config</c> in the same directory, so using
+       <c>sys.config.src</c> requires having some tool to populate what is
+       needed and write <c>sys.config</c> to disk before booting the release.</p>
   </section>
 
   <section>
-- 
cgit v1.2.3