From: Gordon Hecker <gh@emlix.com>
Date: Mon, 8 Jun 2009 11:53:13 +0000 (+0200)
Subject: document basic configuration: .e2/e2version, e2/syntax, .e2/extensions
X-Git-Tag: e2factory-2.3.1rc1~3
X-Git-Url: https://git.e2factory.org/?a=commitdiff_plain;h=29c9a06bcd1922243fd8115511c87df170726525;p=e2factory.git

document basic configuration: .e2/e2version, e2/syntax, .e2/extensions

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

diff --git a/README.extensions b/README.extensions
index 0c761f0..0d19f31 100644
--- a/README.extensions
+++ b/README.extensions
@@ -14,6 +14,5 @@ extensions can provide a local and a global part. The requirements are
  * Either part may be empty (i.e. build and install nothing). In other words:
    Extensions may provide code for local install or code for global install
    or both.
- * extensions are configured in .e2/extensions, this config file replaces
-   .e2/e2version in versions of e2factory with extension support.
+ * extensions are configured in .e2/extensions
  * It is planned to provide a plugin interface
diff --git a/doc/manual/Makefile b/doc/manual/Makefile
index 87a6de2..8d52015 100644
--- a/doc/manual/Makefile
+++ b/doc/manual/Makefile
@@ -32,7 +32,7 @@ include $(TOPLEVEL)/make.vars
 
 HTML = manual.html \
 	basic-concepts.html buildid.html \
-	environment.html project.html chroot.html licences.html \
+	basic.html environment.html project.html chroot.html licences.html \
 	sources.html results.html release.html migration.html \
 	faq.html
 
diff --git a/doc/manual/basic.text b/doc/manual/basic.text
new file mode 100644
index 0000000..53d1273
--- /dev/null
+++ b/doc/manual/basic.text
@@ -0,0 +1,40 @@
+Basic configuration
+-------------------
+
+
+*e2factory* requires some basic settings in configuration files in the
+project:
+
+*   .e2/e2version configures the version of e2factory to be used with
+    the project (the local tools)
+*   .e2/syntax holds the syntax version the project requires
+*   .e2/extensions lists zero or more extensions to be installed with
+    e2factory (local tools)
+
+.e2/e2version holds a single line specifying a branch and a tag.
+e2factory (the e2-install-e2 tool) installs the version according to the
+tag unless the special tag '^' is used.
+
+Example:
+
+    master e2factory-2.3.1
+
+.e2/syntax holds a single line specifying the required syntax version
+
+Example:
+
+    2_3_0
+
+.e2/extensions holds a table specifying a list of extensions.
+
+Example:
+
+    extensions {
+      {
+        name="e2factory-extension",
+        ref="refs/tags/e2factory-extension-2.3.1",
+      },
+    }
+
+prev [buildid](buildid.html)
+next [environment](environment.html)
diff --git a/doc/manual/buildid.text b/doc/manual/buildid.text
index 606d1f0..6206f5f 100644
--- a/doc/manual/buildid.text
+++ b/doc/manual/buildid.text
@@ -23,4 +23,4 @@ The picture shows a quick overview of how the buildid is composed:
 ![buildid.png](buildid.png "buildid calculation")
 
 prev [basic-concepts](basic-concepts.html)
-next [environment](environment.html)
+next [basic](basic.html)
diff --git a/doc/manual/environment.text b/doc/manual/environment.text
index 88aba2a..98c1184 100644
--- a/doc/manual/environment.text
+++ b/doc/manual/environment.text
@@ -35,5 +35,5 @@ Examples:
 
     env "proj/more.env"
 
-prev [buildid](buildid.html)
+prev [basic](basic.html)
 next [project](project.html)
diff --git a/doc/manual/manual.text b/doc/manual/manual.text
index b6c7390..44c777a 100644
--- a/doc/manual/manual.text
+++ b/doc/manual/manual.text
@@ -7,6 +7,7 @@ Content
 
 +   Configuration
 
+ *   [basic](basic.html)
  *   [environment](environment.html)
  *   [project](project.html)
  *   [chroot](chroot.html)