New branch for documentation, with an initial skeleton.

doc.old/INSTALL.rst

@@ -0,0 +1 @@
+../../INSTALL

doc.old/index.rst

@@ -0,0 +1,90 @@
+.. Bro documentation master file
+
+=================
+Bro Documentation
+=================
+
+Guides
+------
+
+.. toctree::
+   :maxdepth: 1
+
+   INSTALL
+   quickstart
+   upgrade
+   faq
+   reporting-problems
+
+Frameworks
+----------
+
+.. toctree::
+   :maxdepth: 1
+
+   notice
+   logging
+   input
+   cluster
+   signatures
+
+How-Tos
+-------
+
+.. toctree::
+   :maxdepth: 1
+
+   geoip
+
+Script Reference
+----------------
+
+.. toctree::
+   :maxdepth: 1
+
+   scripts/packages
+   scripts/index
+   scripts/builtins
+   scripts/bifs
+
+Other Bro Components
+--------------------
+
+The following are snapshots of documentation for components that come
+with this version of Bro (|version|). Since they can also be used
+independently, see the `download page
+<http://bro-ids.org/download/index.html>`_ for documentation of any
+current, independent component releases.
+
+.. toctree::
+   :maxdepth: 1
+
+   BinPAC - A protocol parser generator <components/binpac/README>
+   Broccoli - The Bro Client Communication Library (README) <components/broccoli/README>
+   Broccoli - User Manual <components/broccoli/broccoli-manual>
+   Broccoli Python Bindings <components/broccoli-python/README>
+   Broccoli Ruby Bindings <components/broccoli-ruby/README>
+   BroControl - Interactive Bro management shell <components/broctl/README>
+   Bro-Aux - Small auxiliary tools for Bro <components/bro-aux/README>
+   BTest - A unit testing framework <components/btest/README>
+   Capstats - Command-line packet statistic tool <components/capstats/README>
+   PySubnetTree - Python module for CIDR lookups<components/pysubnettree/README>
+   trace-summary - Script for generating break-downs of network traffic <components/trace-summary/README>
+
+The `Broccoli API Reference <broccoli-api/index.html>`_ may also be of
+interest.
+
+Other Indices and References
+----------------------------
+
+* :ref:`General Index <genindex>`
+* `Notice Index <bro-noticeindex.html>`_
+* :ref:`search`
+
+Internal References
+-------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   scripts/internal

doc/INSTALL.rst

@@ -1 +0,0 @@
-../INSTALL

doc/LICENSE

@@ -0,0 +1,5 @@
+This work is licensed under the Creative Commons
+Attribution-NonCommercial 3.0 Unported License. To view a copy of this
+license, visit http://creativecommons.org/licenses/by-nc/3.0/ or send
+a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain
+View, California, 94041, USA.

doc/conf.py.in

@@ -12,11 +12,28 @@
 
 import sys, os
 
+extensions = []
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.abspath('sphinx-sources/ext'))
 
+# ----- Begin of BTest configuration. -----
+btest = os.path.abspath("@CMAKE_SOURCE_DIR@/aux/btest")
+brocut = os.path.abspath("@CMAKE_SOURCE_DIR@/aux/bro-aux/bro-cut")
+bro = os.path.abspath("@CMAKE_SOURCE_DIR@/build/src")
+
+os.environ["PATH"] += (":%s:%s/sphinx:%s:%s" % (btest, btest, bro, brocut))
+sys.path.append(os.path.join(btest, "sphinx"))
+
+extensions += ["btest-sphinx"]
+
+btest_base="@CMAKE_SOURCE_DIR@/testing/btest"
+btest_tests="doc/sphinx"
+# ----- End of BTest configuration. -----
+
+
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -24,7 +41,7 @@ sys.path.insert(0, os.path.abspath('sphinx-sources/ext'))
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['bro', 'rst_directive', 'sphinx.ext.todo', 'adapt-toc']
+extensions += ['bro', 'rst_directive', 'sphinx.ext.todo', 'adapt-toc']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['sphinx-sources/_templates', 'sphinx-sources/_static']

doc/index.rst

@@ -1,90 +1,27 @@
+
 .. Bro documentation master file
 
 =================
 Bro Documentation
 =================
 
-Guides
-------
-
 .. toctree::
-   :maxdepth: 1
+    :maxdepth: 2
+    :numbered:
 
-   INSTALL
+    user-manual/index
-   quickstart
+    reference/index
-   upgrade
-   faq
-   reporting-problems
 
-Frameworks
+Just Testing
-----------
+============
 
-.. toctree::
+.. code:: bro
-   :maxdepth: 1
 
-   notice
+    print "Hey Bro!"
-   logging
-   input
-   cluster
-   signatures
 
-How-Tos
+.. btest:: test
--------
 
-.. toctree::
+    @TEST-COPY-FILE: ${TRACES}/wikipedia.trace
-   :maxdepth: 1
+    @TEST-EXEC: btest-rst-cmd bro -r wikipedia.trace 
+    @TEST-EXEC: btest-rst-cmd "cat http.log | bro-cut ts id.orig_h | head -5"
 
-   geoip
-
-Script Reference
-----------------
-
-.. toctree::
-   :maxdepth: 1
-
-   scripts/packages
-   scripts/index
-   scripts/builtins
-   scripts/bifs
-
-Other Bro Components
---------------------
-
-The following are snapshots of documentation for components that come
-with this version of Bro (|version|). Since they can also be used
-independently, see the `download page
-<http://bro-ids.org/download/index.html>`_ for documentation of any
-current, independent component releases.
-
-.. toctree::
-   :maxdepth: 1
-
-   BinPAC - A protocol parser generator <components/binpac/README>
-   Broccoli - The Bro Client Communication Library (README) <components/broccoli/README>
-   Broccoli - User Manual <components/broccoli/broccoli-manual>
-   Broccoli Python Bindings <components/broccoli-python/README>
-   Broccoli Ruby Bindings <components/broccoli-ruby/README>
-   BroControl - Interactive Bro management shell <components/broctl/README>
-   Bro-Aux - Small auxiliary tools for Bro <components/bro-aux/README>
-   BTest - A unit testing framework <components/btest/README>
-   Capstats - Command-line packet statistic tool <components/capstats/README>
-   PySubnetTree - Python module for CIDR lookups<components/pysubnettree/README>
-   trace-summary - Script for generating break-downs of network traffic <components/trace-summary/README>
-
-The `Broccoli API Reference <broccoli-api/index.html>`_ may also be of
-interest.
-
-Other Indices and References
-----------------------------
-
-* :ref:`General Index <genindex>`
-* `Notice Index <bro-noticeindex.html>`_
-* :ref:`search`
-
-Internal References
--------------------
-
-.. toctree::
-   :maxdepth: 1
-
-   scripts/internal

doc/reference/events.rst

@@ -0,0 +1,5 @@
+
+================
+Events (Missing)
+================
+

doc/reference/frameworks.rst

@@ -0,0 +1,5 @@
+
+====================
+Frameworks (Missing)
+====================
+

doc/reference/index.rst

@@ -0,0 +1,13 @@
+
+=========
+Reference
+=========
+
+.. toctree::
+    :maxdepth: 2
+    :numbered:
+
+    frameworks.rst
+    events.rst
+    language.rst
+    subsystems.rst

doc/reference/language.rst

@@ -0,0 +1,7 @@
+
+==================
+Language (Missing)
+==================
+
+
+

doc/reference/subsystems.rst

@@ -0,0 +1,4 @@
+
+====================
+Subsystems (Missing)
+====================

doc/user-manual/index.rst

@@ -0,0 +1,12 @@
+
+===========
+User Manual
+===========
+
+.. toctree::
+    :maxdepth: 2
+    :numbered:
+
+    intro.rst
+    starting.rst
+

doc/user-manual/intro.rst

@@ -0,0 +1,4 @@
+
+======================
+Introduction (Missing)
+======================

doc/user-manual/starting.rst

@@ -0,0 +1,4 @@
+
+=========================
+Getting Started (Missing)
+=========================

testing/btest/Baseline/doc.sphinx.test/btest-doc.sphinx.test.rst

@@ -0,0 +1,13 @@
+.. code-block:: none
+
+  # bro -r wikipedia.trace
+
+.. code-block:: none
+
+  # cat http.log | bro-cut ts id.orig_h | head -5
+  1300475168.843894	141.142.220.118
+  1300475168.975800	141.142.220.118
+  1300475168.976327	141.142.220.118
+  1300475168.979160	141.142.220.118
+  1300475169.012666	141.142.220.118
+

testing/btest/btest.cfg

@@ -4,6 +4,7 @@ TmpDir      = %(testbase)s/.tmp
 BaselineDir = %(testbase)s/Baseline
 IgnoreDirs  = .svn CVS .tmp
 IgnoreFiles = *.tmp *.swp #* *.trace .DS_Store
+Finalizer   = btest-diff-rst
 
 [environment]
 BROPATH=`bash -c %(testbase)s/../../build/bro-path-dev`
@@ -11,7 +12,7 @@ BRO_SEED_FILE=%(testbase)s/random.seed
 TZ=UTC
 LC_ALL=C
 BTEST_PATH=%(testbase)s/../../aux/btest
-PATH=%(testbase)s/../../build/src:%(testbase)s/../scripts:%(testbase)s/../../aux/btest:%(default_path)s
+PATH=%(testbase)s/../../build/src:%(testbase)s/../scripts:%(testbase)s/../../aux/btest:%(testbase)s/../../aux/btest/sphinx:%(default_path)s
 TRACES=%(testbase)s/Traces
 SCRIPTS=%(testbase)s/../scripts
 DIST=%(testbase)s/../..

testing/btest/doc/sphinx/test.btest

@@ -0,0 +1,3 @@
+@TEST-COPY-FILE: ${TRACES}/wikipedia.trace
+@TEST-EXEC: btest-rst-cmd bro -r wikipedia.trace
+@TEST-EXEC: btest-rst-cmd "cat http.log | bro-cut ts id.orig_h | head -5"