]> git.ipfire.org Git - thirdparty/snort3.git/commitdiff
update lua source license foo, add comments on style
authorRuss Combs <rucombs@cisco.com>
Tue, 6 Jan 2015 13:21:33 +0000 (08:21 -0500)
committerRuss Combs <rucombs@cisco.com>
Tue, 6 Jan 2015 13:21:33 +0000 (08:21 -0500)
doc/style.txt
src/managers/snort_config.lua
src/managers/snort_plugin.lua

index 6ea83409caa9a8eb15e9f3de27e68ba99e431ae7..818fdfc50382bf9311d30c2d48e4e364f7f01e63 100644 (file)
@@ -35,14 +35,22 @@ yet firm so feedback is welcome to get something we can live with.
   med, or low priority.  For now, H, M, or L can indicate alpha 1, 2, or 3.
   Perf changes fall between alpha 1 and 2.
 
+* Put the copyright(s) and license in a comment block at the top of each
+  source file (.h and .cc).  Don't bother with trivial scripts and make
+  foo.  Some interesting Lua code should get a comment block too.  Copy and
+  paste exactly from src/main.h (don't reformat).
+
+* Put author, description, etc. in separate comment(s) following the
+  license.  Do not put such comments in the middle of the license foo.
+
 ==== Logging
 
-* Messages intended for the user should not look like debug messages. In,
-  other words, the function name should not be included.
+* Messages intended for the user should not look like debug messages. Eg,
+  the function name should not be included.
 
 * Most debug messages should just be deleted.
 
-* Don't bang your messages (no !).  The user feels bad enough about the
+* Don't bang your error messages (no !).  The user feels bad enough about the
   problem already w/o you shouting at him.
 
 ==== Types
index 1f27bd9d13d6dfc01c9f4871cd5d4c321b5c02ad..20b99b0717421df07a4d7ad752f47a391ef6ecb3 100644 (file)
@@ -1,20 +1,19 @@
 ---------------------------------------------------------------------------
--- Copyright (C) 2014 Cisco and/or its affiliates. All rights reserved.
+-- Copyright (C) 2014-2015 Cisco and/or its affiliates. All rights reserved.
 --
--- This program is free software; you can redistribute it and/or modify
--- it under the terms of the GNU General Public License Version 2 as
--- published by the Free Software Foundation.  You may not use, modify or
--- distribute this program under any other version of the GNU General
--- Public License.
+-- This program is free software; you can redistribute it and/or modify it
+-- under the terms of the GNU General Public License Version 2 as published
+-- by the Free Software Foundation.  You may not use, modify or distribute
+-- this program under any other version of the GNU General Public License.
 --
--- This program is distributed in the hope that it will be useful,
--- but WITHOUT ANY WARRANTY; without even the implied warranty of
--- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
--- GNU General Public License for more details.
+-- This program is distributed in the hope that it will be useful, but
+-- WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+-- General Public License for more details.
 --
--- You should have received a copy of the GNU General Public License
--- along with this program; if not, write to the Free Software
--- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+-- You should have received a copy of the GNU General Public License along
+-- with this program; if not, write to the Free Software Foundation, Inc.,
+-- 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 ---------------------------------------------------------------------------
 -- snort_config.lua author Russ Combs <rucombs@cisco.com>
 
index c99908b63ac2b90fbb832c5cef0179c4bc726657..f701d89ba8769a3eb6e12ec14d7d88105bd5d445 100644 (file)
@@ -1,21 +1,21 @@
 ---------------------------------------------------------------------------
--- Copyright (C) 2014 Cisco and/or its affiliates. All rights reserved.
+-- Copyright (C) 2014-2015 Cisco and/or its affiliates. All rights reserved.
 --
--- This program is free software; you can redistribute it and/or modify
--- it under the terms of the GNU General Public License Version 2 as
--- published by the Free Software Foundation.  You may not use, modify or
--- distribute this program under any other version of the GNU General
--- Public License.
+-- This program is free software; you can redistribute it and/or modify it
+-- under the terms of the GNU General Public License Version 2 as published
+-- by the Free Software Foundation.  You may not use, modify or distribute
+-- this program under any other version of the GNU General Public License.
 --
--- This program is distributed in the hope that it will be useful,
--- but WITHOUT ANY WARRANTY; without even the implied warranty of
--- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
--- GNU General Public License for more details.
+-- This program is distributed in the hope that it will be useful, but
+-- WITHOUT ANY WARRANTY; without even the implied warranty of
+-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+-- General Public License for more details.
 --
--- You should have received a copy of the GNU General Public License
--- along with this program; if not, write to the Free Software
--- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+-- You should have received a copy of the GNU General Public License along
+-- with this program; if not, write to the Free Software Foundation, Inc.,
+-- 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 ---------------------------------------------------------------------------
+-- snort_plugin.lua author Russ Combs <rucombs@cisco.com>
 
 ffi = require("ffi")