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

Polishing the reference section of the manual.

Browse source 
Mostly resorting and renaming a few things.
This commit is contained in:
Robin Sommer 2013-10-07 15:53:46 -07:00
parent 6734260136
commit 0fe474e232
10 changed files with 26 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/index.rst
View file

@ -18,8 +18,6 @@ Bro Documentation
scripts/index.rst
components/index.rst
* `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`

4
doc/scripts/builtins.rst
View file

@ -1,5 +1,5 @@
Built-in Types and Attributes
=============================
Types and Attributes
====================
Types
-----

9
doc/scripts/index.rst
View file

@ -7,13 +7,14 @@ Script Reference
.. toctree::
:maxdepth: 1
builtins
Built-In Functions (BIFs) <base/bif/index>
scripts
packages
internal
proto-analyzers
file-analyzers
notices
builtins
Built-in Functions (BIFs) <base/bif/index>
internal
scripts

6
doc/scripts/scripts.rst
View file

@ -1,8 +1,8 @@
.. This is a stub doc to which broxygen appends during the build process
========================
Index of All Bro Scripts
========================
===============
All Bro Scripts
===============
.. toctree::
:maxdepth: 1

12
src/BroDoc.cc
View file

@ -610,8 +610,10 @@ void CreateProtoAnalyzerDoc(const char* filename)
{
FILE* f = fopen(filename, "w");
fprintf(f, "Protocol Analyzer Reference\n");
fprintf(f, "===========================\n\n");
fprintf(f, "Protocol Analyzers\n");
fprintf(f, "==================\n\n\n");
fprintf(f, ".. contents::\n");
fprintf(f, " :depth: 1\n\n");
WriteAnalyzerTagDefn(f, analyzer_mgr->GetTagEnumType(), "Analyzer");
@ -640,8 +642,10 @@ void CreateFileAnalyzerDoc(const char* filename)
{
FILE* f = fopen(filename, "w");
fprintf(f, "File Analyzer Reference\n");
fprintf(f, "=======================\n\n");
fprintf(f, "File Analyzers\n");
fprintf(f, "==============\n\n");
fprintf(f, ".. contents::\n");
fprintf(f, " :depth: 1\n\n");
WriteAnalyzerTagDefn(f, file_mgr->GetTagEnumType(), "Files");

3
src/bro.bif
View file

@ -2,6 +2,9 @@
##! such as general programming algorithms, string processing, math functions,
##! introspection, type conversion, file/directory manipulation, packet filtering,
##! inter-process communication and controlling protocol analyzer behavior.
##!
##! You'll find most of Bro's built-in functions that aren't protocol-specific in
##! this file.
%%{ // C segment
#include <math.h>

2
src/input.bif
View file

@ -1,4 +1,4 @@
# functions and types for the input framework
##! Internal functions and types used by the input framework.
module Input;

6
src/probabilistic/bloom-filter.bif
View file

@ -1,8 +1,4 @@
# ===========================================================================
#
# Bloom Filter Functions
#
# ===========================================================================
##! Functions to create and manipulate Bloom filters.
%%{

7
src/probabilistic/cardinality-counter.bif
View file

@ -1,9 +1,4 @@
# ===========================================================================
#
# HyperLogLog Functions
#
# ===========================================================================
##! Functions to create and manipulate probabilistic cardinality counters.
%%{
#include "probabilistic/CardinalityCounter.h"

7
src/probabilistic/top-k.bif
View file

@ -1,9 +1,4 @@
# ===========================================================================
#
# Top-K Functions
#
# ===========================================================================
##! Functions to probabilistically determine top-k elements.
%%{
#include "probabilistic/Topk.h"