From 60a13b64316a79edbf830811cdf113311c6547b7 Mon Sep 17 00:00:00 2001
From: alisdair sullivan <alisdairsullivan@yahoo.ca>
Date: Mon, 6 Jun 2016 21:52:14 -0700
Subject: Compiler: new function env_compiler_options/0

retrieve the value of the environment variable ERL_COMPILER_OPTIONS
in the same manner as used by file/2, forms/2 and output_generated/2
---
 lib/compiler/doc/src/compile.xml | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'lib/compiler/doc')

diff --git a/lib/compiler/doc/src/compile.xml b/lib/compiler/doc/src/compile.xml
index 954750fcdd..0fb09061b6 100644
--- a/lib/compiler/doc/src/compile.xml
+++ b/lib/compiler/doc/src/compile.xml
@@ -39,6 +39,19 @@
   </description>
 
   <funcs>
+    <func>
+      <name>env_compiler_options()</name>
+      <fsummary>
+	Compiler options defined via the environment variable
+	<c>ERL_COMPILER_OPTIONS</c>
+      </fsummary>
+      <desc>
+	<p>Return compiler options given via the environment variable
+	  <c>ERL_COMPILER_OPTIONS</c>. If the value is a list, it is
+	  returned as is. If it is not a list, it is put into a list.
+	</p>
+      </desc>
+    </func>
     <func>
       <name>file(File)</name>
       <fsummary>Compiles a file.</fsummary>
@@ -768,6 +781,10 @@ module.beam: module.erl \
       if you do not want the environment variable to be consulted,
       for example, if you are calling the compiler recursively from
       inside a parse transform.</p>
+
+      <p>The list can be retrieved with
+      <seealso marker="#env_compiler_options/0">env_compiler_options/0</seealso>
+      .</p>
   </section>
 
   <section>
-- 
cgit v1.2.3