Add pre_warn directive

1 files changed, 19 insertions, 0 deletions

diff --git a/nginx-confgen.pod b/nginx-confgen.pod
index d95c20b..10af518 100644
--- a/nginx-confgen.pod
+++ b/nginx-confgen.pod
@@ -97,6 +97,25 @@ things usually work better without:
     proxy_pass http://$1/;
   }
 
+=head2 pre_warn
+
+This directive, when interpreted, will generate a warning to the standard error
+of nginx-confgen. Can be used to signal that a special configuration is being
+used:
+
+  pre_if -e /etc/offline-mode {
+    pre_warn "Putting website in offline mode!";
+  }
+
+Or to warn about certain directives:
+
+  pre_macro proxy_cache $var {
+    pre_warn "Using proxy_cache with $var violates company policy!";
+
+    # But we can output it anyway.
+    proxy_cache $var;
+  }
+
 =head2 macro
 
 Define a I<macro>, which is a configuration block that you can later refer to.