Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-11 11:08:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Rearrange packet filter and dpd documentation.

Browse source
This commit is contained in:
Jon Siwek 2011-11-30 10:13:20 -06:00
parent 4fc5dea3d7
commit 9be652f8ff
5 changed files with 8 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/index.rst
View file

@ -39,7 +39,6 @@ Script Reference
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
scripts/common
scripts/builtins scripts/builtins
scripts/bifs scripts/bifs
scripts/packages scripts/packages

19
doc/scripts/common.rst
View file

@ -1,19 +0,0 @@
Common Documentation
====================
.. _common_port_analysis_doc:
Port Analysis
-------------
TODO: add some stuff here
.. _common_packet_filter_doc:
Packet Filter
-------------
TODO: add some stuff here
.. note:: Filters are only relevant when dynamic protocol detection (DPD)
is explicitly turned off (Bro release 1.6 enabled DPD by default).

4
doc/scripts/index.rst
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 Scripts Index of All Individual Bro Scripts
======================== ===================================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

6
src/BroDoc.cc
View file

@ -215,14 +215,16 @@ void BroDoc::WriteDocFile() const
if ( ! port_analysis.empty() ) if ( ! port_analysis.empty() )
{ {
WriteSectionHeading("Port Analysis", '-'); WriteSectionHeading("Port Analysis", '-');
WriteToDoc(":ref:`More Information <common_port_analysis_doc>`\n\n"); WriteToDoc("Loading this script makes the following changes to "
":bro:see:`dpd_config`.\n\n");
WriteStringList("%s", port_analysis); WriteStringList("%s", port_analysis);
} }
if ( ! packet_filter.empty() ) if ( ! packet_filter.empty() )
{ {
WriteSectionHeading("Packet Filter", '-'); WriteSectionHeading("Packet Filter", '-');
WriteToDoc(":ref:`More Information <common_packet_filter_doc>`\n\n"); WriteToDoc("Loading this script makes the following changes to "
":bro:see:`capture_filters`.\n\n");
WriteToDoc("Filters added::\n\n"); WriteToDoc("Filters added::\n\n");
WriteToDoc("%s\n", packet_filter.c_str()); WriteToDoc("%s\n", packet_filter.c_str());
} }

4
testing/btest/Baseline/doc.autogen-reST-example/example.rst
View file

@ -281,7 +281,7 @@ Redefinitions
Port Analysis Port Analysis
------------- -------------
:ref:`More Information <common_port_analysis_doc>` Loading this script makes the following changes to :bro:see:`dpd_config`.
SSL:: SSL::
@ -292,7 +292,7 @@ SSL::
Packet Filter Packet Filter
------------- -------------
:ref:`More Information <common_packet_filter_doc>` Loading this script makes the following changes to :bro:see:`capture_filters`.
Filters added:: Filters added::