Update docs after addition of running_under_test const

zeek · May 30, 2024 · cecb156 · cecb156
1 parent e36479c
commit cecb156
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 5 deletions.
diff --git a/scripts/base/bif/event.bif.zeek.rst b/scripts/base/bif/event.bif.zeek.rst
@@ -826,7 +826,7 @@ Events
    .. zeek:see:: new_packet tcp_packet ipv6_ext_headers
 
 .. zeek:id:: net_done
-   :source-code: base/init-bare.zeek 5952 5954
+   :source-code: base/init-bare.zeek 5955 5957
 
    :Type: :zeek:type:`event` (t: :zeek:type:`time`)
 

diff --git a/scripts/base/init-bare.zeek.rst b/scripts/base/init-bare.zeek.rst
@@ -208,6 +208,7 @@ Redefinable Options
 :zeek:id:`report_gaps_for_partial`: :zeek:type:`bool` :zeek:attr:`&redef`                                                         Whether we want :zeek:see:`content_gap` for partial
                                                                                                                                   connections.
 :zeek:id:`rpc_timeout`: :zeek:type:`interval` :zeek:attr:`&redef`                                                                 Time to wait before timing out an RPC request.
+:zeek:id:`running_under_test`: :zeek:type:`bool` :zeek:attr:`&redef`                                                              Whether Zeek is being run under test.
 :zeek:id:`sig_max_group_size`: :zeek:type:`count` :zeek:attr:`&redef`                                                             Maximum size of regular expression groups for signature matching.
 :zeek:id:`skip_http_data`: :zeek:type:`bool` :zeek:attr:`&redef`                                                                  Skip HTTP data for performance considerations.
 :zeek:id:`table_expire_delay`: :zeek:type:`interval` :zeek:attr:`&redef`                                                          When expiring table entries, wait this amount of time before checking the
@@ -2188,6 +2189,16 @@ Redefinable Options
 
    Time to wait before timing out an RPC request.
 
+.. zeek:id:: running_under_test
+   :source-code: base/init-bare.zeek 5952 5952
+
+   :Type: :zeek:type:`bool`
+   :Attributes: :zeek:attr:`&redef`
+   :Default: ``F``
+
+   Whether Zeek is being run under test. This can be used to alter functionality
+   while testing, but should be used sparingly.
+
 .. zeek:id:: sig_max_group_size
    :source-code: base/init-bare.zeek 5185 5185
 
@@ -3350,7 +3361,7 @@ State Variables
    .. zeek:see:: dns_skip_all_auth dns_skip_addl
 
 .. zeek:id:: done_with_network
-   :source-code: base/init-bare.zeek 5951 5951
+   :source-code: base/init-bare.zeek 5954 5954
 
    :Type: :zeek:type:`bool`
    :Default: ``F``

diff --git a/scripts/base/utils/conn-ids.zeek.rst b/scripts/base/utils/conn-ids.zeek.rst
@@ -29,15 +29,15 @@ Detailed Interface
 Functions
 #########
 .. zeek:id:: directed_id_string
-   :source-code: base/utils/conn-ids.zeek 35 38
+   :source-code: base/utils/conn-ids.zeek 39 42
 
    :Type: :zeek:type:`function` (id: :zeek:type:`conn_id`, is_orig: :zeek:type:`bool`) : :zeek:type:`string`
 
    Calls :zeek:id:`id_string` or :zeek:id:`reverse_id_string` if the
    second argument is T or F, respectively.
 
 .. zeek:id:: id_string
-   :source-code: base/utils/conn-ids.zeek 21 26
+   :source-code: base/utils/conn-ids.zeek 25 30
 
    :Type: :zeek:type:`function` (id: :zeek:type:`conn_id`) : :zeek:type:`string`
 
@@ -46,7 +46,7 @@ Functions
    on the left to the responder on the right.
 
 .. zeek:id:: reverse_id_string
-   :source-code: base/utils/conn-ids.zeek 28 33
+   :source-code: base/utils/conn-ids.zeek 32 37
 
    :Type: :zeek:type:`function` (id: :zeek:type:`conn_id`) : :zeek:type:`string`