Skip to content

Commit

Permalink
Generate docs for 6.2.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
timwoj committed May 15, 2024
1 parent bdc3f5d commit d631452
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 12 deletions.
31 changes: 24 additions & 7 deletions scripts/base/frameworks/packet-filter/main.zeek.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ Functions
:zeek:id:`PacketFilter::install`: :zeek:type:`function` Call this function to build and install a new dynamically built
packet filter.
:zeek:id:`PacketFilter::register_filter_plugin`: :zeek:type:`function` API function to register a new plugin for dynamic restriction filters.
:zeek:id:`PacketFilter::remove_exclude`: :zeek:type:`function` Remove a previously added exclude filter fragment by name.
====================================================================== ======================================================================


Expand All @@ -101,7 +102,7 @@ Redefinable Options
still be applied to reduce the captured traffic.

.. zeek:id:: PacketFilter::enable_auto_protocol_capture_filters
:source-code: base/frameworks/packet-filter/main.zeek 121 121
:source-code: base/frameworks/packet-filter/main.zeek 131 131

:Type: :zeek:type:`bool`
:Attributes: :zeek:attr:`&redef`
Expand Down Expand Up @@ -148,7 +149,7 @@ Redefinable Options
State Variables
###############
.. zeek:id:: PacketFilter::current_filter
:source-code: base/frameworks/packet-filter/main.zeek 125 125
:source-code: base/frameworks/packet-filter/main.zeek 135 135

:Type: :zeek:type:`string`
:Default: ``"<not set yet>"``
Expand All @@ -159,7 +160,7 @@ State Variables
Types
#####
.. zeek:type:: PacketFilter::FilterPlugin
:source-code: base/frameworks/packet-filter/main.zeek 109 112
:source-code: base/frameworks/packet-filter/main.zeek 119 122

:Type: :zeek:type:`record`

Expand Down Expand Up @@ -208,7 +209,7 @@ Hooks
Functions
#########
.. zeek:id:: PacketFilter::exclude
:source-code: base/frameworks/packet-filter/main.zeek 205 213
:source-code: base/frameworks/packet-filter/main.zeek 222 230

:Type: :zeek:type:`function` (filter_id: :zeek:type:`string`, filter: :zeek:type:`string`) : :zeek:type:`bool`

Expand All @@ -228,7 +229,7 @@ Functions
installed or not.

.. zeek:id:: PacketFilter::exclude_for
:source-code: base/frameworks/packet-filter/main.zeek 215 223
:source-code: base/frameworks/packet-filter/main.zeek 232 240

:Type: :zeek:type:`function` (filter_id: :zeek:type:`string`, filter: :zeek:type:`string`, span: :zeek:type:`interval`) : :zeek:type:`bool`

Expand All @@ -251,18 +252,34 @@ Functions
installed or not.

.. zeek:id:: PacketFilter::install
:source-code: base/frameworks/packet-filter/main.zeek 270 347
:source-code: base/frameworks/packet-filter/main.zeek 287 364

:Type: :zeek:type:`function` () : :zeek:type:`bool`

Call this function to build and install a new dynamically built
packet filter.

.. zeek:id:: PacketFilter::register_filter_plugin
:source-code: base/frameworks/packet-filter/main.zeek 191 194
:source-code: base/frameworks/packet-filter/main.zeek 201 204

:Type: :zeek:type:`function` (fp: :zeek:type:`PacketFilter::FilterPlugin`) : :zeek:type:`void`

API function to register a new plugin for dynamic restriction filters.

.. zeek:id:: PacketFilter::remove_exclude
:source-code: base/frameworks/packet-filter/main.zeek 211 220

:Type: :zeek:type:`function` (filter_id: :zeek:type:`string`) : :zeek:type:`bool`

Remove a previously added exclude filter fragment by name. The
traffic that was being filtered will be allowed through the filter
after calling this function.


:param filter_id: The name given to the filter fragment which you'd like to remove.


:returns: A boolean value to indicate if a filter fragment with the given name
actually installed.


13 changes: 8 additions & 5 deletions scripts/base/misc/version.zeek.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ Detailed Interface
Constants
#########
.. zeek:id:: Version::info
:source-code: base/misc/version.zeek 113 113
:source-code: base/misc/version.zeek 125 125

:Type: :zeek:type:`Version::VersionDescription`

`VersionDescription` record pertaining to the currently running version of Zeek.

.. zeek:id:: Version::number
:source-code: base/misc/version.zeek 119 119
:source-code: base/misc/version.zeek 131 131

:Type: :zeek:type:`count`

Expand All @@ -59,7 +59,7 @@ Constants
Types
#####
.. zeek:type:: Version::VersionDescription
:source-code: base/misc/version.zeek 12 39
:source-code: base/misc/version.zeek 12 41

:Type: :zeek:type:`record`

Expand Down Expand Up @@ -94,6 +94,9 @@ Types
debug: :zeek:type:`bool`
If set to true, the version is a debug build

localversion: :zeek:type:`string`
Local version portion of the version string

version_string: :zeek:type:`string`
String representation of this version

Expand All @@ -102,7 +105,7 @@ Types
Functions
#########
.. zeek:id:: Version::at_least
:source-code: base/misc/version.zeek 122 125
:source-code: base/misc/version.zeek 134 137

:Type: :zeek:type:`function` (version_string: :zeek:type:`string`) : :zeek:type:`bool`

Expand All @@ -116,7 +119,7 @@ Functions
:returns: True if running version greater or equal to the given version.

.. zeek:id:: Version::parse
:source-code: base/misc/version.zeek 57 109
:source-code: base/misc/version.zeek 59 121

:Type: :zeek:type:`function` (version_string: :zeek:type:`string`) : :zeek:type:`Version::VersionDescription`

Expand Down

0 comments on commit d631452

Please sign in to comment.