From 130f34e9dece00f9f0ff785921cdded1914b69de Mon Sep 17 00:00:00 2001
From: Tuncer Ayaz <tuncer.ayaz@gmail.com>
Date: Fri, 19 Aug 2011 17:35:45 +0200
Subject: systools: add warnings_as_errors option

---
 lib/sasl/doc/src/systools.xml | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'lib/sasl/doc')

diff --git a/lib/sasl/doc/src/systools.xml b/lib/sasl/doc/src/systools.xml
index 883c9c372b..8c1c327d74 100644
--- a/lib/sasl/doc/src/systools.xml
+++ b/lib/sasl/doc/src/systools.xml
@@ -45,7 +45,8 @@
         <v>Name = string()</v>
         <v>UpFrom = DownTo = [Name | {Name,Descr}]</v>
         <v>&nbsp;Descr = term()</v>
-        <v>Opt = {path,[Dir]} | restart_emulator | silent | noexec | {outdir,Dir}</v>
+        <v>Opt = {path,[Dir]} | restart_emulator | silent | noexec | {outdir,Dir}
+	| warnings_as_errors</v>
         <v>&nbsp;Dir = string()</v>
         <v>Result = ok | error | {ok,Relup,Module,Warnings} | {error,Module,Error}</v>
         <v>&nbsp;Relup - see relup(4)</v>
@@ -122,6 +123,8 @@
         <p>If the option <c>noexec</c> is provided, the function returns
           the same values as for <c>silent</c> but no <c>relup</c> file
           is created.</p>
+	<p>If the option <c>warnings_as_errors</c> is provided, warnings
+	   are treated as errors.</p>
       </desc>
     </func>
     <func>
@@ -130,7 +133,8 @@
       <fsummary>Generate a boot script <c>.script/.boot</c>.</fsummary>
       <type>
         <v>Name = string()</v>
-        <v>Opt = src_tests | {path,[Dir]} | local | {variables,[Var]} | exref | {exref,[App]}] | silent | {outdir,Dir}</v>
+        <v>Opt = src_tests | {path,[Dir]} | local | {variables,[Var]} | exref | {exref,[App]}]
+	| silent | {outdir,Dir} | warnings_as_errors</v>
         <v>&nbsp;Dir = string()</v>
         <v>&nbsp;Var = {VarName,Prefix}</v>
         <v>&nbsp;&nbsp;VarName = Prefix = string()</v>
@@ -232,6 +236,8 @@
           Warnings and errors can be converted to strings by calling
           <c>Module:format_warning(Warnings)</c> or
           <c>Module:format_error(Error)</c>.</p>
+	<p>If the option <c>warnings_as_errors</c> is provided, warnings
+	   are treated as errors.</p>
       </desc>
     </func>
     <func>
-- 
cgit v1.2.3