diff --git a/CHANGES b/CHANGES index 3b5b46c659..55c77db5b4 100644 --- a/CHANGES +++ b/CHANGES @@ -1,4 +1,21 @@ +1.6-dev-1038 | 2011-08-05 18:25:44 -0700 + + * Smaller updates to script docs and their generation. (Jon Siwek) + + * When using a `print` statement to write to a file that has raw output + enabled, NUL characters in string are no longer interpreted into "\0", + no newline is appended afterwards, and each argument to `print` is + written to the file without any additional separation. (Jon Siwek) + + * Test portatibility tweaks. (Jon Siwek) + + * Fixing PktSrc::Statistics() which retured bogus information + offline mode. Closes #500. (Jon Siwek) + + * --with-perftools configure option now assumes --enable-perftools. + Closes #527. (Jon Siwek) + 1.6-dev-1018 | 2011-07-31 21:30:31 -0700 * Updating CHANGES. (Robin Sommer) diff --git a/VERSION b/VERSION index b8218c5f8e..ec987c49eb 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.6-dev-1018 +1.6-dev-1038 diff --git a/doc/scripts/DocSourcesList.cmake b/doc/scripts/DocSourcesList.cmake index a26b9dcedd..c5c3851f67 100644 --- a/doc/scripts/DocSourcesList.cmake +++ b/doc/scripts/DocSourcesList.cmake @@ -13,6 +13,7 @@ set(psd ${PROJECT_SOURCE_DIR}/policy) rest_target(${CMAKE_CURRENT_SOURCE_DIR} example.bro internal) +rest_target(${psd} bro.init internal) rest_target(${CMAKE_BINARY_DIR}/src bro.bif.bro) rest_target(${CMAKE_BINARY_DIR}/src const.bif.bro) diff --git a/doc/scripts/README b/doc/scripts/README index 93700ab012..bd7ec5c065 100644 --- a/doc/scripts/README +++ b/doc/scripts/README @@ -38,20 +38,26 @@ by CMake: This target removes Sphinx inputs and outputs from the CMake ``build/`` dir. -To schedule a script to be documented, edit ``DocSourcesList.cmake`` inside -this directory add a call to the ``rest_target()`` macro. Calling that macro -with a group name for the script is optional. If the group is omitted, the -only links to the script will be in the master TOC tree for all policy scripts -as well as the master TOC tree for script packages (derived from the path -component of the second argument to ``rest_target()``), with the exception -of ``.bif`` files which are grouped automatically. +The ``genDocSourcesList.sh`` script can be run to automatically generate +``DocSourcesList.cmake``, which is the file CMake uses to define the list +of documentation targets. This script should be run after adding new +Bro script source files, and the changes commited to git. -When adding a new logical grouping e.g. "my/group" (groups are allowed -to contain slashes specifying a path) for generated scripts, -create a new reST document in ``source/my/group.rst`` and add some default -documentation for the group. References to (and summaries of) documents -associated with the group get appended to this pre-created file during the -``make doc`` process. +If a script shouldn't have documentation generated for it, there's also a +blacklist variable that can be maintained in the ``genDocSourcesList.sh`` +script. + +The blacklist can also be used if you want to define a certain grouping for +the script's generated docs to belong to (as opposed to the automatic grouping +the happens for script packages/directories). To do that, add the +script's name to the blacklist, then append a ``rest_target()`` to the +``statictext`` variable where the first argument is the source directory +containing the policy script to document, the second argument is the file +name of the policy script, and the third argument is the path/name of a +pre-created reST document in the ``source/`` directory to which the +``make doc`` process can append script documentation references. This +pre-created reST document should also then be linked to from the TOC tree +in ``source/index.rst``. The Sphinx source tree template in ``source/`` can be modified to add more common/general documentation, style sheets, JavaScript, etc. The Sphinx diff --git a/doc/scripts/genDocSourcesList.sh b/doc/scripts/genDocSourcesList.sh index 9cbf8a11db..23d2355c91 100755 --- a/doc/scripts/genDocSourcesList.sh +++ b/doc/scripts/genDocSourcesList.sh @@ -30,6 +30,7 @@ statictext="\ set(psd \${PROJECT_SOURCE_DIR}/policy) rest_target(\${CMAKE_CURRENT_SOURCE_DIR} example.bro internal) +rest_target(\${psd} bro.init internal) " if [[ $# -ge 1 ]]; then diff --git a/doc/scripts/source/index.rst b/doc/scripts/source/index.rst index 29e2fa396a..83bceebb0c 100644 --- a/doc/scripts/source/index.rst +++ b/doc/scripts/source/index.rst @@ -14,7 +14,6 @@ Contents: internal bifs packages - collections policy/index Indices and tables diff --git a/policy/frameworks/control/base/main.bro b/policy/frameworks/control/base/main.bro index 9bcd4bcbe5..320715103a 100644 --- a/policy/frameworks/control/base/main.bro +++ b/policy/frameworks/control/base/main.bro @@ -2,12 +2,14 @@ ##! consts to a remote Bro then sends the :bro:id:`configuration_update` event ##! and terminates processing. ##! -##! Intended to be used from the command line like this when starting a controller: +##! Intended to be used from the command line like this when starting a controller:: +##! ##! bro frameworks/control/controller Control::host= Control::port= Control::cmd= [Control::arg=] ##! ##! A controllee only needs to load the controllee script in addition ##! to the specific analysis scripts desired. It may also need a noded -##! configured as a controller node in the communications nodes configuration. +##! configured as a controller node in the communications nodes configuration:: +##! ##! bro frameworks/control/controllee ##! ##! To use the framework as a controllee, it only needs to be loaded and diff --git a/policy/frameworks/notice/base/main.bro b/policy/frameworks/notice/base/main.bro index cbab9a26bc..f3949f81e8 100644 --- a/policy/frameworks/notice/base/main.bro +++ b/policy/frameworks/notice/base/main.bro @@ -103,7 +103,7 @@ export { ## This is the record that defines the items that make up the notice policy. type PolicyItem: record { - ## This is the exact positional order in which the :id:type:`PolicyItem` + ## This is the exact positional order in which the :bro:type:`PolicyItem` ## records are checked. This is set internally by the notice framework. position: count &log &optional; ## Define the priority for this check. Items are checked in ordered diff --git a/policy/protocols/smtp/base/software.bro b/policy/protocols/smtp/base/software.bro index 1773a87201..31db7bdaab 100644 --- a/policy/protocols/smtp/base/software.bro +++ b/policy/protocols/smtp/base/software.bro @@ -3,6 +3,7 @@ ##! currently detected. ##! ##! TODO: +##! ##! * Find some heuristic to determine if email was sent through ##! a MS Exhange webmail interface as opposed to a desktop client.