fix codec_module link; update style guide

diff --git a/doc/style.txt b/doc/style.txt
index 3fc7cc7c88ed36e6c4229085d46d204ba3a292d0..bea1d2cbfab9213dfba53d67a93d2c9bfc83ed4e 100644 (file)
--- a/doc/style.txt
+++ b/doc/style.txt
@@ -11,6 +11,19 @@ yet firm so feedback is welcome to get something we can live with.
   key points for the code in that directory.  These are built into the
   developers guide.
 
+* Do not use exceptions.  Exception-safe code is non-trivial and we have
+  ported legacy code that makes use of exceptions unwise.  There are a few
+  exceptions to this rule for the memory manager, shell, etc.  Other code
+  should handle errors as errors.
+
+* Do not use dynamic_cast or RTTI.  Although compilers are getting better
+  all the time, there is a time and space cost to this that is easily
+  avoided.
+
+* Use smart pointers judiciously as they aren't free.  If you would have to
+  roll your own, then use a smart pointer.  If you just need a dtor to
+  delete something, write the dtor.
+
 === Naming
 
 * Use camel case for namespaces, classes, and types like WhizBangPdfChecker.
@@ -26,6 +39,14 @@ yet firm so feedback is welcome to get something we can live with.
   comments can be obviated with better code.  Clear code is better than a
   comment.
 
+* Heed Tim Ottinger's Rule on Comments (https://disqus.com/by/tim_ottinger/):
+
+    1. Comments should only say what the code is incapable of saying.
+    2. Comments that repeat (or pre-state) what the code is doing must be
+       removed.
+    3. If the code CAN say what the comment is saying, it must be changed at
+       least until rule #2 is in force.
+
 * Function comment blocks are generally just noise that quickly becomes
   obsolete.  If you absolutely must comment on parameters, put each on a
   separate line along with the comment.  That way changing the signature
@@ -47,7 +68,11 @@ yet firm so feedback is welcome to get something we can live with.
 * Put author, description, etc. in separate comment(s) following the
   license.  Do not put such comments in the middle of the license foo.
   Be sure to put the author line ahead of the header guard to exclude them
-  from the developers guide.
+  from the developers guide.  Use the following format, and include a
+  mention to the original author if this is derived work:
+
+    // ips_dnp3_obj.cc author Maya Dagon <mdagon@cisco.com>
+    // based on work by Ryan Jordan
 
 * Each header should have a comment immediately after the header guard to
   give an overview of the file so the user knows what's going on.
@@ -177,7 +202,6 @@ yet firm so feedback is welcome to get something we can live with.
   shouldn't have to sift through implementation details to see what is
   available to the client.
 
-
 === Headers
 
 * Don't hesitate to create a new header if it is needed.  Don't lump
@@ -220,7 +244,7 @@ yet firm so feedback is welcome to get something we can live with.
 * Include required headers, all required headers, and nothing but required
   headers.  Don't just clone a bunch of headers because it is convenient.
 
-* Any file depending of #ifdefs should include config.h as shown below.  A
+* Any file depending on #ifdefs should include config.h as shown below.  A
   .h should include it before any other includes, and a .cc should include
   it immediately after the include of its own .h.
 
@@ -228,7 +252,7 @@ yet firm so feedback is welcome to get something we can live with.
     #include "config.h"
     #endif
 
-* Do not put using statements in headers.
+* Do not put using statements in headers unless they are tightly scoped.
 
 === Warnings
 
@@ -236,13 +260,15 @@ yet firm so feedback is welcome to get something we can live with.
 
     -Wall -Wextra -pedantic -Wformat -Wformat-security
     -Wunused-but-set-variable -Wno-deprecated-declarations
+    -fsanitize=address -fno-omit-frame-pointer
 
 * With clang, use at least these compiler flags:
 
     -Wall -Wextra -pedantic -Wformat -Wformat-security
     -Wno-deprecated-declarations
+    -fsanitize=address -fno-omit-frame-pointer
 
-* Then Fix All Warnings.  None Allowed.
+* Then Fix All Warnings and Aborts.  None Allowed.
 
 === Other
 

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 8d71caa285d3be4636bb1cc091151e3672a28fef..32e02dbf63a21d6c14c90912a384f7182df2d691 100644 (file)
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -117,6 +117,7 @@ target_link_libraries( snort
     search_engines
     target_based
     main
+    codec_module
     memory
     host_tracker
     parser

diff --git a/src/Makefile.am b/src/Makefile.am
index 83e7e68aa4b09230d5572ddc24c2b370af031468..952d2a166d07194cb02cc66211e821ad6c11915e 100644 (file)
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -50,7 +50,6 @@ codecs/libcodecs.a \
 codecs/ip/libip_codecs.a \
 codecs/misc/libmisc_codecs.a \
 $(codec_list) \
-codecs/libcodec_module.a \
 network_inspectors/libnetwork_inspectors.a \
 network_inspectors/binder/libbinder.a \
 network_inspectors/normalize/libnormalize.a \
@@ -81,6 +80,7 @@ ips_options/libips_options.a \
 search_engines/libsearch_engines.a \
 target_based/libtarget_based.a \
 main/libmain.a \
+codecs/libcodec_module.a \
 memory/libmemory.a \
 host_tracker/libhost_tracker.a \
 parser/libparser.a \