Snort mailing list archives

Re: Errors in the Snort manual


From: Russ Combs <rcombs () sourcefire com>
Date: Fri, 19 Mar 2010 14:22:01 -0400

FYI - I've opened a bug on this to hopefully give it a little impetus.

On Fri, Mar 19, 2010 at 1:56 PM, Joel Esler <joel.esler () me com> wrote:

Evilghost,

Please remember, we *are* being thankful.  Snort *is* an open-source
program, and this is how we get updates to software and/or the manual.
 While we invest millions of dollars worth of company time, resources, and
money improving a resource that we give away for free, we rely on you guys,
the Snort Community, to take a look as well.

J

On Mar 19, 2010, at 1:41 PM, evilghost () packetmail net wrote:

Thanks Russ, it truly was meant as constructive, there are times where
it's difficult to empathize with your community based on limitations of
perception.  This may be the case here; perhaps Sourcefire does not see
the vital importance of this manual.  I'm not subtle but neither is
reality.

Sadly, I will decline the invitation but sincerely appreciate the
offer.  Time is scarce and what little I have free I tend to allocate
towards community efforts.

-evilghost

Russ Combs wrote:

Thanks for the constructive criticism.  Hopefully we will get more

time to update the open source manual.  In the meantime, evilghost,

you have demonstrated a flair for writing so please feel free to

contribute updates to the manual.


Russ


On Fri, Mar 19, 2010 at 1:00 PM, evilghost () packetmail net

<mailto:evilghost () packetmail net <evilghost () packetmail net>> <
evilghost () packetmail net

<mailto:evilghost () packetmail net <evilghost () packetmail net>>> wrote:


   Hey Mike, it looks like this should go to

   snort-team () sourcefire com <mailto:snort-team () sourcefire com<snort-team () sourcefire com>>
so

   I'm CCing them to this E-Mail.  This should be more than embarrassing.

   If I can soap-box for a minute I would think the accuracy of the

   manual

   should be paramount; it should be the definitive authoritative source

   for Snort, not a loose association of blogs, web posts, mailing-list

   content, etc where it ends up being a sadistic chose your own

   adventure

   style learning process.


   Take a step back and imagine the perception someone would have being

   introduced to Snort for the first time and pulling down the current

   manual, complete with incorrect syntax, gross spelling errors,

   grammatical errors, and syntax inconsistency.  Might make it hard

   to get

   adoption in the enterprise since one wouldn't associate enterprise

   quality software with mistakes of this magnitude.


   I may not be subtle but this is the reality behind mistakes like

   these.


   -evilghost


   Mike Cox wrote:

Again, not trying to be pedantic but I was playing around with a

popular spell checking tool and found the following errors in the

Snort 2.8.5.1 manual:


Page 13, the word "substitue" should be "substitute".


Page 16, the word "specifiy" should be "specify".


Page 16, the word "specifiy" should be "specify".


Page 26, the word "occurr" should be "occur".


Page 32, the word "compatibilty" should be "compatibility".


Page 32, the word "occurances" should be "occurrences".


Page 34, the word "occurance" should be "occurrence".


Page 35, the word "occurance" should be "occurrence".


Page 37, the word "orginal" should be "original".


Page 38, the word 'postives" should be "positives".


Page 41, the word "legimite" should be "legitimate".


Page 44, the word "delimiated" should be "delimited".


Page 49, the word "perfomance" should be "performance".


Page 53, the word "argumnet" should be "argument".


Page 56, the word "Telent" should be "Telnet".


Page 56, the words "the the" should just be "the".


Page 57, the word "normailzed" should be "normalized".


Page 57, the word "cooresponding' should be "corresponding".


Page 63, the word "Respone" should be "Response".


Page 64, the word "proprocessor" should be "preprocessor".


Page 68, the word "preprosessor" should be "preprocessor".



It is interesting that these errors are fairly evenly

   distributed.  I

stopped on page 68.  Given the distribution of errors, there are

guaranteed to be more but that can be left as an exercise for the

SourceFire intern.


-Mike Cox


   ------------------------------------------------------------------------




   ------------------------------------------------------------------------------

Download Intel&#174; Parallel Studio Eval

Try the new software tools for yourself. Speed compiling, find bugs

proactively, and fine-tune applications for parallel performance.

See why Intel Parallel Studio got high marks during beta.

http://p.sf.net/sfu/intel-sw-dev


   ------------------------------------------------------------------------


_______________________________________________

Snort-sigs mailing list

Snort-sigs () lists sourceforge net

   <mailto:Snort-sigs () lists sourceforge net<Snort-sigs () lists sourceforge net>


https://lists.sourceforge.net/lists/listinfo/snort-sigs






------------------------------------------------------------------------------
Download Intel&#174; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Snort-sigs mailing list
Snort-sigs () lists sourceforge net
https://lists.sourceforge.net/lists/listinfo/snort-sigs


--
Joel Esler
http://blog.joelesler.net



------------------------------------------------------------------------------
Download Intel&#174; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Snort-sigs mailing list
Snort-sigs () lists sourceforge net
https://lists.sourceforge.net/lists/listinfo/snort-sigs

Current thread: