From 0fdbdff3c4af12172e5de7bb1a9c419ae877737f Mon Sep 17 00:00:00 2001 From: Bernhard Amann Date: Fri, 25 Oct 2013 09:57:12 -0700 Subject: [PATCH 1/2] Wrong example file was included - reported by Michael Auger @LM4K --- doc/scripting/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/scripting/index.rst b/doc/scripting/index.rst index 749fae6457..c6b479a7af 100644 --- a/doc/scripting/index.rst +++ b/doc/scripting/index.rst @@ -214,7 +214,7 @@ take a look at a simple script, stored as ``connection_record_01.bro``, that will output the connection record for a single connection. -.. btest-include:: ${DOC_ROOT}/scripting/connection_record_02.bro +.. btest-include:: ${DOC_ROOT}/scripting/connection_record_01.bro Again, we start with ``@load``, this time importing the :doc:`/scripts/base/protocols/conn/index` scripts which supply the tracking From a09d8e94e0a643cc61c8c4cf5ff95771531f1dcb Mon Sep 17 00:00:00 2001 From: Bernhard Amann Date: Fri, 25 Oct 2013 10:21:33 -0700 Subject: [PATCH 2/2] make the documentation of the SQLite reader/writer a bit nicer. --- scripts/base/frameworks/input/readers/sqlite.bro | 10 ++++++++-- scripts/base/frameworks/logging/writers/sqlite.bro | 10 +++++++++- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/scripts/base/frameworks/input/readers/sqlite.bro b/scripts/base/frameworks/input/readers/sqlite.bro index 2cd025e7d4..3ed2a88461 100644 --- a/scripts/base/frameworks/input/readers/sqlite.bro +++ b/scripts/base/frameworks/input/readers/sqlite.bro @@ -1,6 +1,12 @@ -##! Interface for the SQLite input reader. +##! Interface for the SQLite input reader. Redefinable options are available +##! to tweak the input format of the SQLite reader. ##! -##! The defaults are set to match Bro's ASCII output. +##! See :doc:`/frameworks/logging-input-sqlite` for an introduction on how to +##! use the SQLite reader. +##! +##! When using the SQLite reader, you have to specify the SQL query that returns +##! the desired data by setting ``query`` in the ``config`` table. See the +##! introduction mentioned above for an example. module InputSQLite; diff --git a/scripts/base/frameworks/logging/writers/sqlite.bro b/scripts/base/frameworks/logging/writers/sqlite.bro index 5df5e356c8..883c67d760 100644 --- a/scripts/base/frameworks/logging/writers/sqlite.bro +++ b/scripts/base/frameworks/logging/writers/sqlite.bro @@ -1,5 +1,13 @@ -##! Interface for the SQLite log writer. Redefinable options are available +##! Interface for the SQLite log writer. Redefinable options are available ##! to tweak the output format of the SQLite reader. +##! +##! See :doc:`/frameworks/logging-input-sqlite` for an introduction on how to +##! use the SQLite log writer. +##! +##! The SQL writer currently supports one writer-specific filter option via +##! ``config``: setting ``tablename`` sets the name of the table that is used +##! or created in the SQLite database. An example for this is given in the +##! introduction mentioned above. module LogSQLite;