From 532a74a36a889e3d7d25004ebce70da62b013755 Mon Sep 17 00:00:00 2001
From: Anthony Jackson <anthony@betaplum.com>
Date: Fri, 3 Mar 2017 10:57:58 +0200
Subject: tools: Allow Emake options to be passed in explicitly

This allows build scripts to use emake without needing to generate
an Emakefile before running make:all/0,1 or make:file/1,2.
---
 lib/tools/doc/src/make.xml | 24 ++++++++++++++----------
 1 file changed, 14 insertions(+), 10 deletions(-)

(limited to 'lib/tools/doc')

diff --git a/lib/tools/doc/src/make.xml b/lib/tools/doc/src/make.xml
index fddf5ebd7b..6b878f72fb 100644
--- a/lib/tools/doc/src/make.xml
+++ b/lib/tools/doc/src/make.xml
@@ -43,15 +43,15 @@
       <fsummary>Compile a set of modules.</fsummary>
       <type>
         <v>Options = [Option]</v>
-        <v>&nbsp;Option = noexec | load | netload | &lt;compiler option&gt;</v>
+	<v>&nbsp;Option = noexec | load | netload | {emake, Emake} | &lt;compiler option&gt;</v>
       </type>
       <desc>
-        <p>This function first looks in the current working directory
-          for a file named <c>Emakefile</c> (see below) specifying the
-          set of modules to compile and the compile options to use. If
-          no such file is found, the set of modules to compile
-          defaults to all modules in the current working
-          directory.</p>
+      <p>This function determines the set of modules to compile and the
+          compile options to use, by first looking for the <c>emake</c> make
+          option, if not present reads the configuration from a file named
+          <c>Emakefile</c> (see below). If no such file is found, the
+          set of modules to compile defaults to all modules in the
+          current working directory.</p>
         <p>Traversing the set of modules, it then recompiles every module for
           which at least one of the following conditions apply:</p>
         <list type="bulleted">
@@ -77,6 +77,9 @@
           <item><c>netload</c>          <br></br>
 
            Net load mode. Loads all recompiled modules on all known nodes.</item>
+          <item><c>{emake, Emake}</c>          <br></br>
+
+           Rather than reading the <c>Emakefile</c> specify configuration explicitly.</item>
         </list>
         <p>All items in <c>Options</c> that are not make options are assumed
           to be compiler options and are passed as-is to
@@ -108,9 +111,10 @@
 
   <section>
     <title>Emakefile</title>
-    <p><c>make:all/0,1</c> and <c>make:files/1,2</c> looks in the
-      current working directory for a file named <c>Emakefile</c>. If
-      it exists, <c>Emakefile</c> should contain elements like this:</p>
+    <p><c>make:all/0,1</c> and <c>make:files/1,2</c> first looks for
+      <c>{emake, Emake}</c> in options, then in the current working directory
+      for a file named <c>Emakefile</c>. If present <c>Emake</c> should
+      contain elements like this:</p>
     <code type="none">
 Modules.
 {Modules,Options}.    </code>
-- 
cgit v1.2.3