From: Russ Combs <rucombs@cisco.com>
Date: Tue, 14 Oct 2014 14:43:08 +0000 (-0400)
Subject: minor doc updates
X-Git-Tag: 3.0.0-233~1384^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fe5a630451d9d4d5175c1bbdec27358c62b1cd81;p=thirdparty%2Fsnort3.git

minor doc updates
---

diff --git a/ChangeLog b/ChangeLog
index c100fa139..ce9bc904c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -7,6 +7,7 @@
 -- silenced bogus -O2 warnings
 -- updated ChangeLog terms; added env vars
 -- latest from Tom
+-- minor doc updates
 
 124
 -- valgrind cleanup
diff --git a/doc/overview.txt b/doc/overview.txt
index 4d60e1f90..bb36e0321 100644
--- a/doc/overview.txt
+++ b/doc/overview.txt
@@ -13,7 +13,7 @@ goals for Snort++:
 * Use a shared configuration and attribute table
 * Use a simple, scriptable configuration
 * Make key components pluggable
-* Autogenerate low-level documentation
+* Autogenerate reference documentation
 * Autodetect services for portless configuration
 * Support sticky buffers in rules
 * Provide better cross platform support
diff --git a/doc/tips.txt b/doc/tips.txt
index 0d24d19d8..e23bacaaf 100644
--- a/doc/tips.txt
+++ b/doc/tips.txt
@@ -127,9 +127,12 @@ include::errors.txt[]
 
 === Gotchas
 
-* A table with a nil key will not caught, eg: 
+* A nil key in a table will not caught.  Neither will a nil value in a
+  table.  Neither of the following will cause errors, nor will they 
+  actually set http_server.post_depth:
 
-    stream_tcp = { show_rebuilt_packets }
+    http_server = { post_depth }
+    http_server = { post_depth = undefined_symbol }
 
 * Snort can't tell you the exact filename or line number of a semantic
   error but it will tell you the fully qualified name.
diff --git a/src/ips_options/ips_priority.cc b/src/ips_options/ips_priority.cc
index 421433b4e..363ddcb72 100644
--- a/src/ips_options/ips_priority.cc
+++ b/src/ips_options/ips_priority.cc
@@ -42,7 +42,7 @@
 static const Parameter s_params[] =
 {
     { "~", Parameter::PT_INT, "1:", nullptr,
-      "generator id" },
+      "relative severity level; 1 is highest priority" },
 
     { nullptr, Parameter::PT_MAX, nullptr, nullptr, nullptr }
 };