From 534d4934b7fa5d49ba9aae9a0c961b0d24fc2cfe Mon Sep 17 00:00:00 2001 From: Robin Sommer Date: Tue, 13 Aug 2013 17:18:28 -0700 Subject: [PATCH] Starting to put a new structure in place. I'll go through the various parts next and clean things up for the new structure. --- doc/CHANGES | 1 - doc/components/index.rst | 6 +-- doc/{ => frameworks}/file-analysis.rst | 0 doc/{misc => frameworks}/geoip.rst | 0 doc/frameworks/index.rst | 8 ++-- doc/index.rst | 63 ++------------------------ doc/indices/index.rst | 7 --- doc/intro/index.rst | 2 + doc/intro/install.rst | 1 + doc/misc/index.rst | 9 ---- doc/scripts/DocSourcesList.cmake | 1 - doc/scripts/index.rst | 6 +-- doc/scripts/packages.rst | 4 +- 13 files changed, 19 insertions(+), 89 deletions(-) delete mode 120000 doc/CHANGES rename doc/{ => frameworks}/file-analysis.rst (100%) rename doc/{misc => frameworks}/geoip.rst (100%) delete mode 100644 doc/indices/index.rst create mode 120000 doc/intro/install.rst delete mode 100644 doc/misc/index.rst diff --git a/doc/CHANGES b/doc/CHANGES deleted file mode 120000 index 3e8bc8c0c8..0000000000 --- a/doc/CHANGES +++ /dev/null @@ -1 +0,0 @@ -../CHANGES \ No newline at end of file diff --git a/doc/components/index.rst b/doc/components/index.rst index 8ffbdea1f7..206d34430d 100644 --- a/doc/components/index.rst +++ b/doc/components/index.rst @@ -1,7 +1,7 @@ -===================== -Additional Components -===================== +============= +Subcomponents +============= The following are snapshots of documentation for components that come with this version of Bro (|version|). Since they can also be used diff --git a/doc/file-analysis.rst b/doc/frameworks/file-analysis.rst similarity index 100% rename from doc/file-analysis.rst rename to doc/frameworks/file-analysis.rst diff --git a/doc/misc/geoip.rst b/doc/frameworks/geoip.rst similarity index 100% rename from doc/misc/geoip.rst rename to doc/frameworks/geoip.rst diff --git a/doc/frameworks/index.rst b/doc/frameworks/index.rst index 63e87a6732..d5b771b15e 100644 --- a/doc/frameworks/index.rst +++ b/doc/frameworks/index.rst @@ -6,11 +6,11 @@ Frameworks .. toctree:: :maxdepth: 1 - notice - logging + file-analysis + geoip input intel - cluster + logging + notice signatures - geoip diff --git a/doc/index.rst b/doc/index.rst index 778c4d5a8a..c423e98211 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -5,34 +5,6 @@ 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:: :maxdepth: 2 @@ -42,36 +14,9 @@ How-Tos frameworks/index.rst cluster/index.rst scripts/index.rst - misc/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 `_ (TODO: Move to reference + section, but can't figure out how to include it into toctree) +* :ref:`General Index ` +* :ref:`search` diff --git a/doc/indices/index.rst b/doc/indices/index.rst deleted file mode 100644 index 1d0411c7c0..0000000000 --- a/doc/indices/index.rst +++ /dev/null @@ -1,7 +0,0 @@ - -======= -Indices -======= - -* :ref:`General Index ` -* :ref:`search` diff --git a/doc/intro/index.rst b/doc/intro/index.rst index 58a5a03bd0..e4c46d7f92 100644 --- a/doc/intro/index.rst +++ b/doc/intro/index.rst @@ -8,6 +8,8 @@ Introduction overview quickstart + install upgrade + changes reporting-problems diff --git a/doc/intro/install.rst b/doc/intro/install.rst new file mode 120000 index 0000000000..37675c714b --- /dev/null +++ b/doc/intro/install.rst @@ -0,0 +1 @@ +../../INSTALL \ No newline at end of file diff --git a/doc/misc/index.rst b/doc/misc/index.rst deleted file mode 100644 index edf82e8fd2..0000000000 --- a/doc/misc/index.rst +++ /dev/null @@ -1,9 +0,0 @@ - -==================== -Miscellaneous Topics -==================== - -.. toctree:: - :maxdepth: 2 - - geoip diff --git a/doc/scripts/DocSourcesList.cmake b/doc/scripts/DocSourcesList.cmake index 63d2f35562..0300c5bb4d 100644 --- a/doc/scripts/DocSourcesList.cmake +++ b/doc/scripts/DocSourcesList.cmake @@ -268,4 +268,3 @@ rest_target(${psd} site/local-manager.bro) rest_target(${psd} site/local-proxy.bro) rest_target(${psd} site/local-worker.bro) rest_target(${psd} site/local.bro) -rest_target(${psd} test-all-policy.bro) diff --git a/doc/scripts/index.rst b/doc/scripts/index.rst index d8fe2e57b1..e6d9bd6d65 100644 --- a/doc/scripts/index.rst +++ b/doc/scripts/index.rst @@ -7,15 +7,15 @@ Script Reference .. toctree:: :maxdepth: 1 + packages builtins bifs scripts packages internal + site/proto-analyzers + site/file-analyzers -Indices -======= - * `Notice Index `_ diff --git a/doc/scripts/packages.rst b/doc/scripts/packages.rst index 56909ffbc6..d968e2ba41 100644 --- a/doc/scripts/packages.rst +++ b/doc/scripts/packages.rst @@ -1,7 +1,7 @@ .. 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 a common directory). If the package directory contains a ``__load__.bro``