fixed warnings and updated manual

diff --git a/ChangeLog b/ChangeLog
index 76e7e07da9c72106432e3f1e13dfa5e9e74eb434..ca80d993344d7cc5c121ed3849241cdfad3e60ef 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -22,6 +22,8 @@
 -- updated config_changes.txt
 -- fixed doc format and added errors.txt
 -- revised help options (again) to be more consistent with other (gnu style) programs
+-- added overview page to documentation
+-- pulled in latest from Josh
 
 121
 -- valgrind fixes

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index 5577f056ab53a9ca6f6daddf55ff8d27f10ef56d..0dc489d56886436af698dd62420b85b6533872c7 100644 (file)
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -28,11 +28,12 @@ set(BUILT_SOURCES
 
 set (UNBUILT_SOURCES
     snort_manual.txt
+    overview.txt
     errors.txt
     differences.txt
+    plugins.txt
     style.txt
     tips.txt
-    plugins.txt
 #   config_changes.txt  If ruby executable is NOT found
 )
 

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 4c559b6a2f07fe1e596e37cb192664981daf9ea2..a89bb2d81ca63e2020ca9225b7b85e95ce147b54 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -13,6 +13,7 @@ version.txt
 
 unbuilt_sources = \
 snort_manual.txt \
+overview.txt \
 config_changes.txt \
 errors.txt \
 differences.txt \
@@ -54,7 +55,7 @@ config.txt: $(snort)
        $(snort) --markup --help-config | sort -k 3 > $@
 
 gids.txt: $(snort)
-       $(snort) --markup --help-gids | sort -n  -k 1.4 > $@
+       $(snort) --markup --list-gids | sort -n  -k 1.4 > $@
 
 modules.txt: $(snort)
        for m in `$(snort) --list-modules` ; do \

diff --git a/doc/plugins.txt b/doc/plugins.txt
index 2bcc314f4dc751e59dd13c5f1017f2ef0fbb1110..954c984fbee0608871e18e824587ffa5568af1d3 100644 (file)
--- a/doc/plugins.txt
+++ b/doc/plugins.txt
@@ -1,4 +1,4 @@
-Snort++ uses a variety of plugins to accomplish much of its processing
+Snort\++ uses a variety of plugins to accomplish much of its processing
 objectives, including:
 
 * Codec - to decode and encode packets
@@ -19,7 +19,7 @@ The BaseApi includes type, name, API version, plugin version, and function
 pointers for constructing and destructing a Module.  The specific API add
 various other data and functions for their given roles.
 
-The Module is pervasive in Snort\+\+.  It is how everything, including
+The Module is pervasive in Snort++.  It is how everything, including
 plugins, are configured.  It also provides access to builtin rules.  And as
 the glue that binds functionality to Snort++, the capabilities of a Module
 are expected to grow to include statistics support, etc.

diff --git a/doc/snort_manual.txt b/doc/snort_manual.txt
index d7afc4abb289691bf66cc342157535a59ac5ed4d..ac646ff91cc18ec325bf42034cd751bf454b1d43 100644 (file)
--- a/doc/snort_manual.txt
+++ b/doc/snort_manual.txt
@@ -10,6 +10,10 @@ include::version.txt[]
 
 toc::[]
 
+== Overview
+
+include::overview.txt[]
+
 == Getting Started
 
 include::tips.txt[]

diff --git a/doc/tips.txt b/doc/tips.txt
index f4a938a77f09aa303009e9e067fbd196f3d59629..bcd5caf6930cf0ecd8f23215ac1c7e8ae12bf9d0 100644 (file)
--- a/doc/tips.txt
+++ b/doc/tips.txt
@@ -1,15 +1,39 @@
 The following pointers will help you get started:
 
-=== Building
+=== Dependencies
+
+Required:
+
+* autotools or cmake to build from source.
+
+* daq from snort.org for packet IO.
+
+* luajit from luajit.org for configuration and scripting.
+
+* pcap from http://www.tcpdump.org for tcpdump logging.
+
+* pcre from http://www.pcre.org for regex pattern matching.
+
+* dnet from http://code.google.com/p/libdnet/ for network utility
+  functions.
 
-* You need luajit from luajit.org; build from source.
+* zlib from http://www.zlib.net for decompression.
+
+Optional:
+
+* asciidoc from http://www.methods.co.nz/asciidoc/ to build the html
+  manual.
+
+* dblatex from http://dblatex.sourceforge.net to build the pdf manual (in
+  addition to asciidoc).
+
+* check from http://check.sourceforge.net to build unit tests.
+
+=== Building
 
 * You should build Snort++ with --prefix $install_dir where install_dir is
   something you can easily delete.
 
-* If you want to build the documentation, you will need to install
-  asciidoc.  You will also need dblatex to build the pdf manual.
-
 * To build with cmake and make, first create a separate directory for the
   build and cd into that directory.  Then:
 

diff --git a/src/helpers/markup.cc b/src/helpers/markup.cc
index be463b365c9632ce6c58b63f88b0581fb097ccf3..30ab8649858bfde8eea7da8924146d941004f017 100644 (file)
--- a/src/helpers/markup.cc
+++ b/src/helpers/markup.cc
@@ -51,6 +51,7 @@ const string& Markup::emphasis(const string& s)
 const string& Markup::sanitize(const char* const c)
 { return sanitize(string(c)); }
 
+// FIXIT-L these escapes are emitted directly by asciidoc 8.6.9.
 const string& Markup::sanitize(const string& s)
 {
     const char* const asciidoc_chars = "~*<>^'";

diff --git a/src/packet_io/active.cc b/src/packet_io/active.cc
index 17a7816856c9751e87262e5382f6ff4c24c97128..2bdbdd9e5098a8c4eeb591d50d7e66c6a2994d4f 100644 (file)
--- a/src/packet_io/active.cc
+++ b/src/packet_io/active.cc
@@ -351,6 +351,8 @@ int Active_ForceDropAction(Packet *p)
     case PktType::UDP:
         Active_DropSession();
         _Active_ForceIgnoreSession(p);
+    default:
+        break;
     }
     return 0;
 }

diff --git a/src/stream/icmp/icmp_session.cc b/src/stream/icmp/icmp_session.cc
index af4f3ca5d6a49da98254c0945d407f816744b160..06cb79877d7021151a002900dc7d9ddbcc3f8e50 100644 (file)
--- a/src/stream/icmp/icmp_session.cc
+++ b/src/stream/icmp/icmp_session.cc
@@ -166,6 +166,8 @@ static int ProcessIcmpUnreach(Packet *p)
         /* Lookup a ICMP session */
         ssn = Stream::get_session(&skey);
         break;
+    default:
+        break;
     }
 
     if (ssn)

diff --git a/src/stream/ip/ip_defrag.cc b/src/stream/ip/ip_defrag.cc
index a71802cb9ed46ffecc0c9487c92f990cbbe10668..245cc53e5e85dbc58db41b60b1945f3d4bb3197a 100644 (file)
--- a/src/stream/ip/ip_defrag.cc
+++ b/src/stream/ip/ip_defrag.cc
@@ -1253,6 +1253,8 @@ int fragGetApplicationProtocolId(Packet *p)
     case PktType::ICMP:
         ft->ipprotocol = protocolReferenceICMP;
         break;
+    default:
+        break;
     }
 
     host_entry = SFAT_LookupHostEntryBySrc(p);

diff --git a/src/stream/stream_api.cc b/src/stream/stream_api.cc
index ac0c0c62432b0dbbeb7f4084b3255b87791c2f6c..ca3f25ac664e09d2c47994afac109ab8edd4e793 100644 (file)
--- a/src/stream/stream_api.cc
+++ b/src/stream/stream_api.cc
@@ -749,6 +749,9 @@ void Stream::set_ip_protocol(Flow* flow)
     case PktType::ICMP:
         flow->s5_state.ipprotocol = protocolReferenceICMP;
         break;
+
+    default:
+        break;
     }
 }