Skip to content
This repository was archived by the owner on Oct 13, 2025. It is now read-only.

Commit ef05afe

Browse files
zeek-botzeek-bot
committed
Generate docs
1 parent 9b19abb commit ef05afe

14 files changed

+218
-291
lines changed

‎script-reference/autogenerated-package-index.rst‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -393,9 +393,6 @@
393393
:doc:`builtin-plugins </scripts/builtin-plugins/index>`
394394

395395

396-
:doc:`builtin-plugins/Zeek_AF_Packet </scripts/builtin-plugins/Zeek_AF_Packet/index>`
397-
398-
399396
:doc:`builtin-plugins/Zeek_JavaScript </scripts/builtin-plugins/Zeek_JavaScript/index>`
400397

401398

‎script-reference/autogenerated-protocol-analyzer-index.rst‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -990,7 +990,7 @@ Options/Constants
990990
+++++++++++++++++
991991

992992
.. zeek:id:: DCE_RPC::max_cmd_reassembly
993-
:source-code: base/init-bare.zeek 5700 5700
993+
:source-code: base/init-bare.zeek 5725 5725
994994

995995
:Type: :zeek:type:`count`
996996
:Attributes: :zeek:attr:`&redef`
@@ -1001,7 +1001,7 @@ Options/Constants
10011001
a weird and skip further input.
10021002

10031003
.. zeek:id:: DCE_RPC::max_frag_data
1004-
:source-code: base/init-bare.zeek 5705 5705
1004+
:source-code: base/init-bare.zeek 5730 5730
10051005

10061006
:Type: :zeek:type:`count`
10071007
:Attributes: :zeek:attr:`&redef`
@@ -8289,7 +8289,7 @@ Types
82898289
+++++
82908290

82918291
.. zeek:type:: MQTT::ConnectMsg
8292-
:source-code: base/init-bare.zeek 5893 5923
8292+
:source-code: base/init-bare.zeek 5918 5948
82938293

82948294
:Type: :zeek:type:`record`
82958295

@@ -8354,7 +8354,7 @@ Types
83548354

83558355

83568356
.. zeek:type:: MQTT::ConnectAckMsg
8357-
:source-code: base/init-bare.zeek 5925 5934
8357+
:source-code: base/init-bare.zeek 5950 5959
83588358

83598359
:Type: :zeek:type:`record`
83608360

@@ -8374,7 +8374,7 @@ Types
83748374

83758375

83768376
.. zeek:type:: MQTT::PublishMsg
8377-
:source-code: base/init-bare.zeek 5936 5958
8377+
:source-code: base/init-bare.zeek 5961 5983
83788378

83798379
:Type: :zeek:type:`record`
83808380

@@ -8882,7 +8882,7 @@ Options/Constants
88828882
+++++++++++++++++
88838883

88848884
.. zeek:id:: NCP::max_frame_size
8885-
:source-code: base/init-bare.zeek 5712 5712
8885+
:source-code: base/init-bare.zeek 5737 5737
88868886

88878887
:Type: :zeek:type:`count`
88888888
:Attributes: :zeek:attr:`&redef`
@@ -9652,7 +9652,7 @@ Types
96529652
+++++
96539653

96549654
.. zeek:type:: NTP::StandardMessage
9655-
:source-code: base/init-bare.zeek 5721 5774
9655+
:source-code: base/init-bare.zeek 5746 5799
96569656

96579657
:Type: :zeek:type:`record`
96589658

@@ -9758,7 +9758,7 @@ Types
97589758
for standard synchronization operations.
97599759

97609760
.. zeek:type:: NTP::ControlMessage
9761-
:source-code: base/init-bare.zeek 5779 5813
9761+
:source-code: base/init-bare.zeek 5804 5838
97629762

97639763
:Type: :zeek:type:`record`
97649764

@@ -9830,7 +9830,7 @@ Types
98309830
for control operations.
98319831

98329832
.. zeek:type:: NTP::Mode7Message
9833-
:source-code: base/init-bare.zeek 5822 5855
9833+
:source-code: base/init-bare.zeek 5847 5880
98349834

98359835
:Type: :zeek:type:`record`
98369836

@@ -9894,7 +9894,7 @@ Types
98949894
project <https://www.ntp.org>`_, code v. ntp-4.2.8p13, in include/ntp_request.h.
98959895

98969896
.. zeek:type:: NTP::Message
9897-
:source-code: base/init-bare.zeek 5860 5887
9897+
:source-code: base/init-bare.zeek 5885 5912
98989898

98999899
:Type: :zeek:type:`record`
99009900

‎script-reference/autogenerated-script-index.rst‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -282,10 +282,10 @@
282282
base/bif/plugins/Zeek_ConfigReader.config.bif.zeek </scripts/base/bif/plugins/Zeek_ConfigReader.config.bif.zeek>
283283
base/bif/plugins/Zeek_RawReader.raw.bif.zeek </scripts/base/bif/plugins/Zeek_RawReader.raw.bif.zeek>
284284
base/bif/plugins/Zeek_SQLiteReader.sqlite.bif.zeek </scripts/base/bif/plugins/Zeek_SQLiteReader.sqlite.bif.zeek>
285+
base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek </scripts/base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek>
285286
base/bif/plugins/Zeek_AsciiWriter.ascii.bif.zeek </scripts/base/bif/plugins/Zeek_AsciiWriter.ascii.bif.zeek>
286287
base/bif/plugins/Zeek_NoneWriter.none.bif.zeek </scripts/base/bif/plugins/Zeek_NoneWriter.none.bif.zeek>
287288
base/bif/plugins/Zeek_SQLiteWriter.sqlite.bif.zeek </scripts/base/bif/plugins/Zeek_SQLiteWriter.sqlite.bif.zeek>
288-
base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek </scripts/base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek>
289289
base/bif/plugins/Zeek_JavaScript.zeekjs.bif.zeek </scripts/base/bif/plugins/Zeek_JavaScript.zeekjs.bif.zeek>
290290
base/frameworks/spicy/init-framework.zeek </scripts/base/frameworks/spicy/init-framework.zeek>
291291
base/init-default.zeek </scripts/base/init-default.zeek>
@@ -509,8 +509,6 @@
509509
base/misc/find-filtered-trace.zeek </scripts/base/misc/find-filtered-trace.zeek>
510510
base/misc/installation.zeek </scripts/base/misc/installation.zeek>
511511
builtin-plugins/__load__.zeek </scripts/builtin-plugins/__load__.zeek>
512-
builtin-plugins/Zeek_AF_Packet/__load__.zeek </scripts/builtin-plugins/Zeek_AF_Packet/__load__.zeek>
513-
builtin-plugins/Zeek_AF_Packet/init.zeek </scripts/builtin-plugins/Zeek_AF_Packet/init.zeek>
514512
builtin-plugins/Zeek_JavaScript/__load__.zeek </scripts/builtin-plugins/Zeek_JavaScript/__load__.zeek>
515513
zeekygen/__load__.zeek </scripts/zeekygen/__load__.zeek>
516514
test-all-policy.zeek </scripts/test-all-policy.zeek>

‎scripts/base/bif/event.bif.zeek.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -827,7 +827,7 @@ Events
827827
.. zeek:see:: new_packet tcp_packet ipv6_ext_headers
828828
829829
.. zeek:id:: net_done
830-
:source-code: base/init-bare.zeek 6428 6431
830+
:source-code: base/init-bare.zeek 6453 6456
831831

832832
:Type: :zeek:type:`event` (t: :zeek:type:`time`)
833833

‎scripts/base/bif/index.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -550,6 +550,9 @@ Package: base/bif
550550
:doc:`/scripts/base/bif/plugins/Zeek_SQLiteReader.sqlite.bif.zeek`
551551

552552

553+
:doc:`/scripts/base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek`
554+
555+
553556
:doc:`/scripts/base/bif/plugins/Zeek_AsciiWriter.ascii.bif.zeek`
554557

555558

@@ -559,9 +562,6 @@ Package: base/bif
559562
:doc:`/scripts/base/bif/plugins/Zeek_SQLiteWriter.sqlite.bif.zeek`
560563

561564

562-
:doc:`/scripts/base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek`
563-
564-
565565
:doc:`/scripts/base/bif/plugins/Zeek_JavaScript.zeekjs.bif.zeek`
566566

567567

‎scripts/base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek.rst‎

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -10,53 +10,7 @@ base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek
1010

1111
Summary
1212
~~~~~~~
13-
Types
14-
#####
15-
======================================================= ====================================
16-
:zeek:type:`AF_Packet::ChecksumMode`: :zeek:type:`enum` Available checksum validation modes.
17-
:zeek:type:`AF_Packet::FanoutMode`: :zeek:type:`enum` Available fanout modes.
18-
======================================================= ====================================
19-
2013

2114
Detailed Interface
2215
~~~~~~~~~~~~~~~~~~
23-
Types
24-
#####
25-
.. zeek:type:: AF_Packet::ChecksumMode
26-
:source-code: base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek 21 21
27-
28-
:Type: :zeek:type:`enum`
29-
30-
.. zeek:enum:: AF_Packet::CHECKSUM_OFF AF_Packet::ChecksumMode
31-
32-
Ignore checksums, i.e. always assume they are correct.
33-
34-
.. zeek:enum:: AF_Packet::CHECKSUM_ON AF_Packet::ChecksumMode
35-
36-
Let Zeek compute and verify checksums.
37-
38-
.. zeek:enum:: AF_Packet::CHECKSUM_KERNEL AF_Packet::ChecksumMode
39-
40-
Let the kernel handle checksum offloading.
41-
Note: Semantics may depend on the kernel and driver version.
42-
43-
Available checksum validation modes.
44-
45-
.. zeek:type:: AF_Packet::FanoutMode
46-
:source-code: base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek 11 11
47-
48-
:Type: :zeek:type:`enum`
49-
50-
.. zeek:enum:: AF_Packet::FANOUT_HASH AF_Packet::FanoutMode
51-
52-
.. zeek:enum:: AF_Packet::FANOUT_CPU AF_Packet::FanoutMode
53-
54-
.. zeek:enum:: AF_Packet::FANOUT_QM AF_Packet::FanoutMode
55-
56-
.. zeek:enum:: AF_Packet::FANOUT_CBPF AF_Packet::FanoutMode
57-
58-
.. zeek:enum:: AF_Packet::FANOUT_EBPF AF_Packet::FanoutMode
59-
60-
Available fanout modes.
61-
6216

‎scripts/base/bif/plugins/index.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,9 @@ Package: base/bif/plugins
392392
:doc:`/scripts/base/bif/plugins/Zeek_SQLiteReader.sqlite.bif.zeek`
393393

394394

395+
:doc:`/scripts/base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek`
396+
397+
395398
:doc:`/scripts/base/bif/plugins/Zeek_AsciiWriter.ascii.bif.zeek`
396399

397400

@@ -401,9 +404,6 @@ Package: base/bif/plugins
401404
:doc:`/scripts/base/bif/plugins/Zeek_SQLiteWriter.sqlite.bif.zeek`
402405

403406

404-
:doc:`/scripts/base/bif/plugins/Zeek_AF_Packet.af_packet.bif.zeek`
405-
406-
407407
:doc:`/scripts/base/bif/plugins/Zeek_JavaScript.zeekjs.bif.zeek`
408408

409409

‎scripts/base/bif/types.bif.zeek.rst‎

Lines changed: 58 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
base/bif/types.bif.zeek
44
=======================
5+
.. zeek:namespace:: AF_Packet
56
.. zeek:namespace:: GLOBAL
67
.. zeek:namespace:: MOUNT3
78
.. zeek:namespace:: NFS3
@@ -10,35 +11,74 @@ base/bif/types.bif.zeek
1011
1112
Declaration of various types that the Zeek core uses internally.
1213

13-
:Namespaces: GLOBAL, MOUNT3, NFS3, Reporter, Tunnel
14+
:Namespaces: AF_Packet, GLOBAL, MOUNT3, NFS3, Reporter, Tunnel
1415

1516
Summary
1617
~~~~~~~
1718
Types
1819
#####
19-
===================================================== =
20-
:zeek:type:`MOUNT3::auth_flavor_t`: :zeek:type:`enum`
21-
:zeek:type:`MOUNT3::proc_t`: :zeek:type:`enum`
22-
:zeek:type:`MOUNT3::status_t`: :zeek:type:`enum`
23-
:zeek:type:`NFS3::createmode_t`: :zeek:type:`enum`
24-
:zeek:type:`NFS3::file_type_t`: :zeek:type:`enum`
25-
:zeek:type:`NFS3::proc_t`: :zeek:type:`enum`
26-
:zeek:type:`NFS3::stable_how_t`: :zeek:type:`enum`
27-
:zeek:type:`NFS3::status_t`: :zeek:type:`enum`
28-
:zeek:type:`NFS3::time_how_t`: :zeek:type:`enum`
29-
:zeek:type:`Reporter::Level`: :zeek:type:`enum`
30-
:zeek:type:`TableChange`: :zeek:type:`enum`
31-
:zeek:type:`Tunnel::Type`: :zeek:type:`enum`
32-
:zeek:type:`layer3_proto`: :zeek:type:`enum`
33-
:zeek:type:`link_encap`: :zeek:type:`enum`
34-
:zeek:type:`rpc_status`: :zeek:type:`enum`
35-
===================================================== =
20+
======================================================= ====================================
21+
:zeek:type:`AF_Packet::ChecksumMode`: :zeek:type:`enum` Available checksum validation modes.
22+
:zeek:type:`AF_Packet::FanoutMode`: :zeek:type:`enum` Available fanout modes.
23+
:zeek:type:`MOUNT3::auth_flavor_t`: :zeek:type:`enum`
24+
:zeek:type:`MOUNT3::proc_t`: :zeek:type:`enum`
25+
:zeek:type:`MOUNT3::status_t`: :zeek:type:`enum`
26+
:zeek:type:`NFS3::createmode_t`: :zeek:type:`enum`
27+
:zeek:type:`NFS3::file_type_t`: :zeek:type:`enum`
28+
:zeek:type:`NFS3::proc_t`: :zeek:type:`enum`
29+
:zeek:type:`NFS3::stable_how_t`: :zeek:type:`enum`
30+
:zeek:type:`NFS3::status_t`: :zeek:type:`enum`
31+
:zeek:type:`NFS3::time_how_t`: :zeek:type:`enum`
32+
:zeek:type:`Reporter::Level`: :zeek:type:`enum`
33+
:zeek:type:`TableChange`: :zeek:type:`enum`
34+
:zeek:type:`Tunnel::Type`: :zeek:type:`enum`
35+
:zeek:type:`layer3_proto`: :zeek:type:`enum`
36+
:zeek:type:`link_encap`: :zeek:type:`enum`
37+
:zeek:type:`rpc_status`: :zeek:type:`enum`
38+
======================================================= ====================================
3639

3740

3841
Detailed Interface
3942
~~~~~~~~~~~~~~~~~~
4043
Types
4144
#####
45+
.. zeek:type:: AF_Packet::ChecksumMode
46+
:source-code: base/bif/types.bif.zeek 288 288
47+
48+
:Type: :zeek:type:`enum`
49+
50+
.. zeek:enum:: AF_Packet::CHECKSUM_OFF AF_Packet::ChecksumMode
51+
52+
Ignore checksums, i.e. always assume they are correct.
53+
54+
.. zeek:enum:: AF_Packet::CHECKSUM_ON AF_Packet::ChecksumMode
55+
56+
Let Zeek compute and verify checksums.
57+
58+
.. zeek:enum:: AF_Packet::CHECKSUM_KERNEL AF_Packet::ChecksumMode
59+
60+
Let the kernel handle checksum offloading.
61+
Note: Semantics may depend on the kernel and driver version.
62+
63+
Available checksum validation modes.
64+
65+
.. zeek:type:: AF_Packet::FanoutMode
66+
:source-code: base/bif/types.bif.zeek 278 278
67+
68+
:Type: :zeek:type:`enum`
69+
70+
.. zeek:enum:: AF_Packet::FANOUT_HASH AF_Packet::FanoutMode
71+
72+
.. zeek:enum:: AF_Packet::FANOUT_CPU AF_Packet::FanoutMode
73+
74+
.. zeek:enum:: AF_Packet::FANOUT_QM AF_Packet::FanoutMode
75+
76+
.. zeek:enum:: AF_Packet::FANOUT_CBPF AF_Packet::FanoutMode
77+
78+
.. zeek:enum:: AF_Packet::FANOUT_EBPF AF_Packet::FanoutMode
79+
80+
Available fanout modes.
81+
4282
.. zeek:type:: MOUNT3::auth_flavor_t
4383
:source-code: base/bif/types.bif.zeek 49 49
4484

0 commit comments

Comments
 (0)