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

Merge remote branch 'origin/topic/jsiwek/misc-doc-fixes'

Browse source 
* origin/topic/jsiwek/misc-doc-fixes:
  More tweaks to generated script docs.
  Various changes to documentation framework.

Closes #598.
This commit is contained in:
Robin Sommer 2011-09-08 08:41:12 -07:00
commit db8ab89c3a
21 changed files with 169 additions and 119 deletions
Download patch file Download diff file Expand all files Collapse all files

2
scripts/base/frameworks/logging/main.bro
View file

@ -52,7 +52,7 @@ export {
## If not given, all entries are recorded.
##
## rec: An instance of the streams's ``columns`` type with its
## fields set to the values to logged.
## fields set to the values to logged.
##
## Returns: True if the entry is to be recorded.
pred: function(rec: any): bool &optional;

9
scripts/base/init-bare.bro
View file

@ -1382,8 +1382,9 @@ const enable_syslog = F &redef;
const peer_description = "bro" &redef;
## If true, broadcast events/state received from one peer to other peers.
## NOTE: These options are only temporary. They will disappear when we get a
## more sophisticated script-level communication framework.
##
## .. note:: These options are only temporary. They will disappear when we get
## a more sophisticated script-level communication framework.
const forward_remote_events = F &redef;
## See :bro:id:`forward_remote_events`
const forward_remote_state_changes = F &redef;
@ -1513,6 +1514,6 @@ const skip_http_data = F &redef;
## UDP tunnels. See also: udp_tunnel_port, policy/udp-tunnel.bro.
const parse_udp_tunnels = F &redef;
## Load the logging framework here because it uses fairly deep integration with
## BiFs and script-land defined types.
# Load the logging framework here because it uses fairly deep integration with
# BiFs and script-land defined types.
@load base/frameworks/logging

4
scripts/base/protocols/conn/main.bro
View file

@ -74,11 +74,11 @@ export {
## This history is not meant to encode how much data that happened to be.
history: string &log &optional;
## Number of packets the originator sent.
## Only set if :bro:id:`use_conn_size_analyzer`=T
## Only set if :bro:id:`use_conn_size_analyzer` = T
orig_pkts: count &log &optional;
## Number IP level bytes the originator sent (as seen on the wire,
## taken from IP total_length header field).
## Only set if :bro:id:`use_conn_size_analyzer`=T
## Only set if :bro:id:`use_conn_size_analyzer` = T
orig_ip_bytes: count &log &optional;
## Number of packets the responder sent. See ``orig_pkts``.
resp_pkts: count &log &optional;