From: Josh Date: Fri, 24 Oct 2014 19:44:31 +0000 (-0500) Subject: updating documentation errors X-Git-Tag: 3.0.0-233~1268^2~29 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4bc0d60bdae110864d9ef1bde672ba1408742e7e;p=thirdparty%2Fsnort3.git updating documentation errors --- diff --git a/doc/differences.txt b/doc/differences.txt index 1ed0bdd09..f49db5ff6 100644 --- a/doc/differences.txt +++ b/doc/differences.txt @@ -3,9 +3,9 @@ Snort++ differs from Snort in the following ways: * command line and conf file syntax made more uniform * removed unused and deprecated features * remove as many barriers to successful run as possible - (eg: no upper bounds on memcaps) + (e.g.: no upper bounds on memcaps) * assume the simplest mode of operation - (eg: never assume input from or output to some hardcoded filename) + (e.g.: never assume input from or output to some hardcoded filename) * all Snort config options are grouped into Snort++ modules === Build Options @@ -41,7 +41,7 @@ Snort++ differs from Snort in the following ways: * Snort++ has a default unicode.map * Snort++ will not enforce an upper bound on memcaps and the like within 64 bits * Snort++ will supply a default *_global config if not specified - (Snort would fatal; eg http_inspect_server w/o http_inspect_global) + (Snort would fatal; e.g. http_inspect_server w/o http_inspect_global) * address list syntax changes: [[ and ]] must be [ [ and ] ] to avoid Lua string parsing errors (unless in quoted string) * because the Lua conf is live code, we lose file:line locations in app error messages @@ -87,7 +87,7 @@ Snort++ differs from Snort in the following ways: * fastpattern_offset, fast_pattern_length * no ; separated content suboptions * offset, depth, distance, and within must use a space separator not colon - (eg. offset:5; becomes offset 5;) + (e.g. offset:5; becomes offset 5;) * rule option sequence: soid * sid == 0 not allowed * soid is now a non-metadata option @@ -100,7 +100,7 @@ Snort++ differs from Snort in the following ways: * deleted unused http_encode option * urilen replaced with generic bufferlen which applies to current sticky buffer -* added optional selector to http_header, eg http_header:User-Agent; +* added optional selector to http_header, e.g. http_header:User-Agent; * multiline rules w/o \n * #begin ... #end comments diff --git a/doc/errors.txt b/doc/errors.txt index 956a56fa9..60a8abdca 100644 --- a/doc/errors.txt +++ b/doc/errors.txt @@ -13,7 +13,7 @@ snort_defaults.lua: No such file or directory)_ _ERROR can't find xyz_ * if xyz is the name of a module, make sure you are not assigning a scalar - where a table is required (eg xyz = 2 should be xyz = { }). + where a table is required (e.g. xyz = 2 should be xyz = { }). _ERROR can't find x.y_ diff --git a/doc/overview.txt b/doc/overview.txt index 9374a3635..c1bdfe0c3 100644 --- a/doc/overview.txt +++ b/doc/overview.txt @@ -119,7 +119,7 @@ settings, etc., you can also script Loggers and IpsOptions. === New Http Inspector -*TBD* + TBD === Binder diff --git a/doc/params.txt b/doc/params.txt index 2c4f58439..d043af866 100644 --- a/doc/params.txt +++ b/doc/params.txt @@ -36,7 +36,7 @@ Some additional details to note: * String values are case sensitive too; use lower case only. * Numeric ranges may be of the form low:high where low and high are bounds included in the range. If either is omitted, there is no hard - bound. Eg 0: means any x where x >= 0. + bound. E.g. 0: means any x where x >= 0. * Strings may have a numeric range indicating a length limit; otherwise there is no hard limit. * bit_list is typically used to store a set of byte, port, or VLAN ID diff --git a/doc/start.txt b/doc/start.txt index 4d90613e0..246c3625d 100644 --- a/doc/start.txt +++ b/doc/start.txt @@ -15,13 +15,13 @@ Required: * pcap from http://www.tcpdump.org for tcpdump logging. -* pcre from http://www.pcre.org for regex pattern matching. +* pcre from http://www.pcre.org for regular expression pattern matching. * zlib from http://www.zlib.net for decompression. Optional: -* asciidoc from http://www.methods.co.nz/asciidoc/ to build the html +* 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 diff --git a/doc/style.txt b/doc/style.txt index ce9ec5e11..29a9c7a8b 100644 --- a/doc/style.txt +++ b/doc/style.txt @@ -11,7 +11,7 @@ yet firm so feedback is welcome to get something we can live with. * Use camel case for namespaces, classes, and types like WhizBangPdfChecker. -* Use lower case identifiers with underscore separators, eg some_function() +* Use lower case identifiers with underscore separators, e.g. some_function() and my_var. * Use lower case filenames with underscores. @@ -37,8 +37,8 @@ yet firm so feedback is welcome to get something we can live with. ==== Logging -* Messages intended for the user should not look like debug messages. Eg, - the function name should not be included. +* Messages intended for the user should not look like debug messages. In, + other words, the function name should not be included. * Most debug messages should just be deleted. @@ -51,7 +51,7 @@ yet firm so feedback is welcome to get something we can live with. problems. typedef uint16_t Port; bool foo(Port) is way better than int foo(int port). -* Use forward declarations (eg struct SnortConfig;) instead of void*. +* Use forward declarations (e.g. struct SnortConfig;) instead of void*. * Try not to use extern data unless absolutely necessary and then put the extern in an appropriate header. @@ -92,7 +92,7 @@ yet firm so feedback is welcome to get something we can live with. #define SEQ_LT(a,b) ((int)((a) - (b)) < 0) -* Multiline macros should be blocked (ie inside { }) to avoid if-else type +* Multiline macros should be blocked (i.e. inside { }) to avoid if-else type surprises. ==== Formatting