From: Gordon Hecker <gh@emlix.com>
Date: Tue, 3 Nov 2009 11:40:54 +0000 (+0100)
Subject: documentation: document release_id and name variables in project
X-Git-Tag: e2factory-2.3.2rc1~4
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=dcdb16eaa6628747f72309d94efdf59e45378a05;p=e2factory.git

documentation: document release_id and name variables in project
configuration

Signed-off-by: Gordon Hecker <gh@emlix.com>
---

diff --git a/doc/manual/project.text b/doc/manual/project.text
index 987df14..9bb3f1b 100644
--- a/doc/manual/project.text
+++ b/doc/manual/project.text
@@ -19,6 +19,12 @@ The table may specify the following additional keys:
 *   chroot\_arch string: architecture to use when running the build process
     x86\_64 or x86\_32 may be used, the latter is the builtin default.
 
+The `release_id` and `name` settings appear as `E2_RELEASE_ID` and
+`E2_PROJECT_NAME` respectively in the environment when the build script runs.
+The `release_id` is used to compute the path where the results are stored
+when building in release mode. The `name` is used to compute the path to
+the chroot build environment.
+
 Example:
 
     e2project {