minor doc updates

diff --git a/ChangeLog b/ChangeLog
index c100fa13931b3017d1e0dec52cb97255efb7f2b9..ce9bc904cad3f3ffcc977c31745623941fec8802 100644 (file)
--- 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 4d60e1f90784720f86bf3ce977ebec12c6943752..bb36e032101b0b0540f10fa55990515214ce0e7a 100644 (file)
--- 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 0d24d19d81e9f7d6aec69047cb958c4916b0bb10..e23bacaafd3ce6e179734b638283d965cbd382b3 100644 (file)
--- 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 421433b4eb382f3ea6c458ce1ab57f952026f80e..363ddcb721b2dc9fb69da491c52809b22e93bec7 100644 (file)
--- 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 }
 };