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

Revise the way "port analysis" and "packet filter" documentation is generated.

Browse source 
They now appear at the bottom of generated docs.

Also, a "more info" link is added which can point to an arbitrary location
in any reST document processed by Sphinx.
This commit is contained in:
Jon Siwek 2011-03-29 14:19:33 -05:00
parent a9810d21a9
commit 94ac3f3c23
1 changed files with 5 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/BroDoc.cc
View file

@ -131,24 +131,23 @@ void BroDoc::WriteDocFile() const
if ( ! notices.empty() ) if ( ! notices.empty() )
WriteBroDocObjList(notices, "Notices", '-'); WriteBroDocObjList(notices, "Notices", '-');
WriteInterface("Public Interface", '-', '~', true);
WriteInterface("Private Interface", '-', '~', false);
if ( ! port_analysis.empty() ) if ( ! port_analysis.empty() )
{ {
WriteSectionHeading("Port Analysis", '-'); WriteSectionHeading("Port Analysis", '-');
WriteToDoc(":ref:`More Information <common_port_analysis_doc>`\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(".. note:: Filters are only relevant when dynamic protocol " WriteToDoc(":ref:`More Information <common_packet_filter_doc>`\n\n");
"detection (DPD) is explicitly turned off (Bro release 1.6 "
"enabled DPD by default).\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());
} }
WriteInterface("Public Interface", '-', '~', true);
WriteInterface("Private Interface", '-', '~', false);
} }
void BroDoc::WriteInterface(const char* heading, char underline, void BroDoc::WriteInterface(const char* heading, char underline,