Starting to put a new structure in place.

I'll go through the various parts next and clean things up for the new
structure.
This commit is contained in:
Robin Sommer 2013-08-13 17:18:28 -07:00
parent 3780cab38b
commit 534d4934b7
13 changed files with 19 additions and 89 deletions

View file

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

View file

@ -1,7 +1,7 @@
===================== =============
Additional Components Subcomponents
===================== =============
The following are snapshots of documentation for components that come The following are snapshots of documentation for components that come
with this version of Bro (|version|). Since they can also be used with this version of Bro (|version|). Since they can also be used

View file

@ -6,11 +6,11 @@ Frameworks
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
notice file-analysis
logging geoip
input input
intel intel
cluster logging
notice
signatures signatures
geoip

View file

@ -5,34 +5,6 @@
Bro Documentation Bro Documentation
================= =================
Guides
------
.. toctree::
:maxdepth: 1
INSTALL
upgrade
quickstart
faq
reporting-problems
Frameworks
----------
.. toctree::
:maxdepth: 1
notice
logging
input
file-analysis
cluster
signatures
How-Tos
-------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@ -42,36 +14,9 @@ How-Tos
frameworks/index.rst frameworks/index.rst
cluster/index.rst cluster/index.rst
scripts/index.rst scripts/index.rst
misc/index.rst
components/index.rst components/index.rst
indices/index.rst
Just Testing
============
.. code:: bro
scripts/packages
scripts/index
scripts/builtins
scripts/proto-analyzers
scripts/file-analyzers
.. btest:: test
@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"
Test part 1 coming up.
.. btest:: test-parts
@TEST-EXEC: echo It works! >output
Something else here.
.. btest:: test-parts
@TEST-EXEC: btest-rst-include output
* `Notice Index <bro-noticeindex.html>`_ (TODO: Move to reference
section, but can't figure out how to include it into toctree)
* :ref:`General Index <genindex>`
* :ref:`search`

View file

@ -1,7 +0,0 @@
=======
Indices
=======
* :ref:`General Index <genindex>`
* :ref:`search`

View file

@ -8,6 +8,8 @@ Introduction
overview overview
quickstart quickstart
install
upgrade upgrade
changes
reporting-problems reporting-problems

1
doc/intro/install.rst Symbolic link
View file

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

View file

@ -1,9 +0,0 @@
====================
Miscellaneous Topics
====================
.. toctree::
:maxdepth: 2
geoip

View file

@ -268,4 +268,3 @@ rest_target(${psd} site/local-manager.bro)
rest_target(${psd} site/local-proxy.bro) rest_target(${psd} site/local-proxy.bro)
rest_target(${psd} site/local-worker.bro) rest_target(${psd} site/local-worker.bro)
rest_target(${psd} site/local.bro) rest_target(${psd} site/local.bro)
rest_target(${psd} test-all-policy.bro)

View file

@ -7,15 +7,15 @@ Script Reference
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
packages
builtins builtins
bifs bifs
scripts scripts
packages packages
internal internal
site/proto-analyzers
Indices site/file-analyzers
=======
* `Notice Index <bro-noticeindex.html>`_

View file

@ -1,7 +1,7 @@
.. This is a stub doc to which broxygen appends during the build process .. This is a stub doc to which broxygen appends during the build process
Index of All Bro Script Packages Bro Script Packages
================================ ===================
Bro has the following script packages (e.g. collections of related scripts in Bro has the following script packages (e.g. collections of related scripts in
a common directory). If the package directory contains a ``__load__.bro`` a common directory). If the package directory contains a ``__load__.bro``