Generate docs

zeek · Oct 21, 2023 · dfbc2f1 · dfbc2f1
1 parent a16e531
commit dfbc2f1
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 11 deletions.
diff --git a/script-reference/autogenerated-protocol-analyzer-index.rst b/script-reference/autogenerated-protocol-analyzer-index.rst
@@ -9269,7 +9269,7 @@ Events
 ++++++
 
 .. zeek:id:: QUIC::initial_packet
-   :source-code: base/protocols/quic/main.zeek 123 127
+   :source-code: base/protocols/quic/main.zeek 129 133
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`)
 
@@ -9292,7 +9292,7 @@ Events
 
 
 .. zeek:id:: QUIC::retry_packet
-   :source-code: base/protocols/quic/main.zeek 142 152
+   :source-code: base/protocols/quic/main.zeek 148 158
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`, retry_token: :zeek:type:`string`, retry_integrity_tag: :zeek:type:`string`)
 
@@ -9320,7 +9320,7 @@ Events
    :param integrity_tag: The Retry Integrity Tag field.
 
 .. zeek:id:: QUIC::handshake_packet
-   :source-code: base/protocols/quic/main.zeek 129 133
+   :source-code: base/protocols/quic/main.zeek 135 139
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`)
 
@@ -9342,7 +9342,7 @@ Events
    :param scid: The Source Connection ID field.
 
 .. zeek:id:: QUIC::zero_rtt_packet
-   :source-code: base/protocols/quic/main.zeek 135 139
+   :source-code: base/protocols/quic/main.zeek 141 145
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`)
 
@@ -9364,7 +9364,7 @@ Events
    :param scid: The Source Connection ID field.
 
 .. zeek:id:: QUIC::connection_close_frame
-   :source-code: base/protocols/quic/main.zeek 156 166
+   :source-code: base/protocols/quic/main.zeek 162 172
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`, error_code: :zeek:type:`count`, reason_phrase: :zeek:type:`string`)
 

diff --git a/scripts/base/protocols/quic/main.zeek.rst b/scripts/base/protocols/quic/main.zeek.rst
@@ -11,6 +11,12 @@ Initial idea for a quic.log.
 
 Summary
 ~~~~~~~
+Runtime Options
+###############
+=========================================================================== ========================================
+:zeek:id:`QUIC::max_history_length`: :zeek:type:`count` :zeek:attr:`&redef` The maximum length of the history field.
+=========================================================================== ========================================
+
 Types
 #####
 ============================================ =
@@ -46,6 +52,17 @@ Hooks
 
 Detailed Interface
 ~~~~~~~~~~~~~~~~~~
+Runtime Options
+###############
+.. zeek:id:: QUIC::max_history_length
+   :source-code: base/protocols/quic/main.zeek 74 74
+
+   :Type: :zeek:type:`count`
+   :Attributes: :zeek:attr:`&redef`
+   :Default: ``100``
+
+   The maximum length of the history field.
+
 Types
 #####
 .. zeek:type:: QUIC::Info
@@ -117,7 +134,7 @@ Events
 Hooks
 #####
 .. zeek:id:: QUIC::finalize_quic
-   :source-code: base/protocols/quic/main.zeek 203 209
+   :source-code: base/protocols/quic/main.zeek 209 215
 
    :Type: :zeek:type:`Conn::RemovalHook`
 

diff --git a/scripts/base/protocols/quic/spicy-events.zeek.rst b/scripts/base/protocols/quic/spicy-events.zeek.rst
@@ -26,7 +26,7 @@ Detailed Interface
 Events
 ######
 .. zeek:id:: QUIC::connection_close_frame
-   :source-code: base/protocols/quic/main.zeek 156 166
+   :source-code: base/protocols/quic/main.zeek 162 172
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`, error_code: :zeek:type:`count`, reason_phrase: :zeek:type:`string`)
 
@@ -56,7 +56,7 @@ Events
    .. note:: Packets with CONNECTION_CLOSE frames are usually encrypted after connection establishment and not visible to Zeek.
 
 .. zeek:id:: QUIC::handshake_packet
-   :source-code: base/protocols/quic/main.zeek 129 133
+   :source-code: base/protocols/quic/main.zeek 135 139
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`)
 
@@ -78,7 +78,7 @@ Events
    :param scid: The Source Connection ID field.
 
 .. zeek:id:: QUIC::initial_packet
-   :source-code: base/protocols/quic/main.zeek 123 127
+   :source-code: base/protocols/quic/main.zeek 129 133
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`)
 
@@ -101,7 +101,7 @@ Events
 
 
 .. zeek:id:: QUIC::retry_packet
-   :source-code: base/protocols/quic/main.zeek 142 152
+   :source-code: base/protocols/quic/main.zeek 148 158
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`, retry_token: :zeek:type:`string`, retry_integrity_tag: :zeek:type:`string`)
 
@@ -129,7 +129,7 @@ Events
    :param integrity_tag: The Retry Integrity Tag field.
 
 .. zeek:id:: QUIC::zero_rtt_packet
-   :source-code: base/protocols/quic/main.zeek 135 139
+   :source-code: base/protocols/quic/main.zeek 141 145
 
    :Type: :zeek:type:`event` (c: :zeek:type:`connection`, is_orig: :zeek:type:`bool`, version: :zeek:type:`count`, dcid: :zeek:type:`string`, scid: :zeek:type:`string`)