Regenerate docs for rst linting fixes from scripts and bifs

Author: timwoj

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

@@ -662,8 +662,8 @@ Events
    of the file.  The analysis can be augmented at this time via
    :zeek:see:`Files::add_analyzer`.  The amount of data fed into the file
    sniffing can be increased or decreased by changing either
-   :zeek:see:`default_file_bof_buffer_size` or the `bof_buffer_size` field
-   in an `fa_file` record. The event will be raised even if content inspection
+   :zeek:see:`default_file_bof_buffer_size` or the ``bof_buffer_size`` field
+   in an :zeek:type:`fa_file` record. The event will be raised even if content inspection
    has been unable to infer any metadata, in which case the fields in *meta*
    will be left all unset.
 

scripts/base/bif/packet_analysis.bif.zeek.rst

@@ -12,16 +12,16 @@ Summary
 ~~~~~~~
 Functions
 #########
-====================================================================================== ==============================================================================================================
+====================================================================================== ================================================================================================================
 :zeek:id:`PacketAnalyzer::__disable_analyzer`: :zeek:type:`function`                   Internal function to disable a packet analyzer.
 :zeek:id:`PacketAnalyzer::__enable_analyzer`: :zeek:type:`function`                    Internal function to enable a packet analyzer.
-:zeek:id:`PacketAnalyzer::__set_ignore_checksums_nets`: :zeek:type:`function`          Internal function that is used to update the core-mirror of the script-level `ignore_checksums_nets` variable.
+:zeek:id:`PacketAnalyzer::__set_ignore_checksums_nets`: :zeek:type:`function`          Internal function that is used to update the core-mirror of the script-level ``ignore_checksums_nets`` variable.
 :zeek:id:`PacketAnalyzer::register_packet_analyzer`: :zeek:type:`function`             Add an entry to parent's dispatcher that maps a protocol/index to a next-stage child analyzer.
 :zeek:id:`PacketAnalyzer::register_protocol_detection`: :zeek:type:`function`          Registers a child analyzer with a parent analyzer to perform packet detection when determining whether
                                                                                        to forward from parent to child.
-:zeek:id:`PacketAnalyzer::try_register_packet_analyzer_by_name`: :zeek:type:`function` Attempts to add an entry to `parent`'s dispatcher that maps a protocol/index to a next-stage `child`
+:zeek:id:`PacketAnalyzer::try_register_packet_analyzer_by_name`: :zeek:type:`function` Attempts to add an entry to ``parent``'s dispatcher that maps a protocol/index to a next-stage ``child``
                                                                                        analyzer.
-====================================================================================== ==============================================================================================================
+====================================================================================== ================================================================================================================
 
 
 Detailed Interface
@@ -47,7 +47,7 @@ Functions
 
    :Type: :zeek:type:`function` (v: :zeek:type:`subnet_set`) : :zeek:type:`bool`
 
-   Internal function that is used to update the core-mirror of the script-level `ignore_checksums_nets` variable.
+   Internal function that is used to update the core-mirror of the script-level ``ignore_checksums_nets`` variable.
 
 .. zeek:id:: PacketAnalyzer::register_packet_analyzer
    :source-code: base/bif/packet_analysis.bif.zeek 15 15
@@ -82,7 +82,7 @@ Functions
 
    :Type: :zeek:type:`function` (parent: :zeek:type:`string`, identifier: :zeek:type:`count`, child: :zeek:type:`string`) : :zeek:type:`bool`
 
-   Attempts to add an entry to `parent`'s dispatcher that maps a protocol/index to a next-stage `child`
+   Attempts to add an entry to ``parent``'s dispatcher that maps a protocol/index to a next-stage ``child``
    analyzer. This may fail if either of the two names does not respond to a known analyzer.
 
 

scripts/base/frameworks/broker/main.zeek.rst

@@ -21,7 +21,7 @@ Runtime Options
 
 Redefinable Options
 ###################
-============================================================================================ =======================================================================
+============================================================================================ ===========================================================================
 :zeek:id:`Broker::aggressive_interval`: :zeek:type:`count` :zeek:attr:`&redef`               Frequency of work-stealing polling attempts for Broker/CAF threads
                                                                                              in "aggressive" mode.
 :zeek:id:`Broker::aggressive_polls`: :zeek:type:`count` :zeek:attr:`&redef`                  Number of work-stealing polling attempts for Broker/CAF threads
@@ -67,9 +67,9 @@ Redefinable Options
                                                                                              certificate.
 :zeek:id:`Broker::ssl_passphrase`: :zeek:type:`string` :zeek:attr:`&redef`                   Passphrase to decrypt the private key specified by
                                                                                              :zeek:see:`Broker::ssl_keyfile`.
-:zeek:id:`Broker::web_socket_buffer_size`: :zeek:type:`count` :zeek:attr:`&redef`            Same as `peer_buffer_size` but for WebSocket clients.
-:zeek:id:`Broker::web_socket_overflow_policy`: :zeek:type:`string` :zeek:attr:`&redef`       Same as `peer_overflow_policy` but for WebSocket clients.
-============================================================================================ =======================================================================
+:zeek:id:`Broker::web_socket_buffer_size`: :zeek:type:`count` :zeek:attr:`&redef`            Same as :zeek:see:`Broker::peer_buffer_size` but for WebSocket clients.
+:zeek:id:`Broker::web_socket_overflow_policy`: :zeek:type:`string` :zeek:attr:`&redef`       Same as :zeek:see:`Broker::peer_overflow_policy` but for WebSocket clients.
+============================================================================================ ===========================================================================
 
 Types
 #####
@@ -299,7 +299,7 @@ Redefinable Options
    :Default: ``1``
 
    Max number of threads to use for Broker/CAF functionality.  The
-   ZEEK_BROKER_MAX_THREADS environment variable overrides this setting.
+   ``ZEEK_BROKER_MAX_THREADS`` environment variable overrides this setting.
 
 .. zeek:id:: Broker::moderate_interval
    :source-code: base/frameworks/broker/main.zeek 140 140
@@ -340,7 +340,7 @@ Redefinable Options
 
    Max number of items we buffer at most per peer. What action to take when
    the buffer reaches its maximum size is determined by
-   `peer_overflow_policy`.
+   :zeek:see:`Broker::peer_overflow_policy`.
 
 .. zeek:id:: Broker::peer_overflow_policy
    :source-code: base/frameworks/broker/main.zeek 99 99
@@ -454,7 +454,7 @@ Redefinable Options
    :Attributes: :zeek:attr:`&redef`
    :Default: ``512``
 
-   Same as `peer_buffer_size` but for WebSocket clients.
+   Same as :zeek:see:`Broker::peer_buffer_size` but for WebSocket clients.
 
 .. zeek:id:: Broker::web_socket_overflow_policy
    :source-code: base/frameworks/broker/main.zeek 105 105
@@ -463,7 +463,7 @@ Redefinable Options
    :Attributes: :zeek:attr:`&redef`
    :Default: ``"disconnect"``
 
-   Same as `peer_overflow_policy` but for WebSocket clients.
+   Same as :zeek:see:`Broker::peer_overflow_policy` but for WebSocket clients.
 
 Types
 #####

scripts/base/frameworks/input/main.zeek.rst

@@ -72,7 +72,7 @@ Runtime Options
    :Attributes: :zeek:attr:`&redef`
    :Default: ``Input::MANUAL``
 
-   The default reader mode used. Defaults to `MANUAL`.
+   The default reader mode used. Defaults to ``MANUAL``.
 
 .. zeek:id:: Input::default_reader
    :source-code: base/frameworks/input/main.zeek 28 28
@@ -81,7 +81,7 @@ Runtime Options
    :Attributes: :zeek:attr:`&redef`
    :Default: ``Input::READER_ASCII``
 
-   The default input reader used. Defaults to `READER_ASCII`.
+   The default input reader used. Defaults to ``READER_ASCII``.
 
 Redefinable Options
 ###################
@@ -223,8 +223,8 @@ Types
 
       ev: :zeek:type:`any`
          The event that is raised each time a new line is received from the
-         reader. The event will receive an Input::EventDescription record
-         as the first argument, an Input::Event enum as the second
+         reader. The event will receive an :zeek:see:`Input::EventDescription` record
+         as the first argument, an :zeek:see:`Input::Event` enum as the second
          argument, and the fields (as specified in *fields*) as the following
          arguments (this will either be a single record value containing
          all fields, or each field value as a separate argument).
@@ -233,8 +233,8 @@ Types
          Error event that is raised when an information, warning or error
          is raised by the input stream. If the level is error, the stream will automatically
          be closed.
-         The event receives the Input::EventDescription as the first argument, the
-         message as the second argument and the Reporter::Level as the third argument.
+         The event receives the :zeek:see:`Input::EventDescription` as the first argument, the
+         message as the second argument and the :zeek:see:`Reporter::Level` as the third argument.
 
          The event is raised like it had been declared as follows:
          error_ev: function(desc: EventDescription, message: string, level: Reporter::Level) &optional;
@@ -390,7 +390,7 @@ Functions
    Create a new event input stream from a given source.
 
 
-   :param description: `EventDescription` record describing the source.
+   :param description: :zeek:see:`Input:EventDescription` record describing the source.
 
 
    :returns: true on success.
@@ -403,7 +403,7 @@ Functions
    Create a new table input stream from a given source.
 
 
-   :param description: `TableDescription` record describing the source.
+   :param description: :zeek:see:`TableDescription` record describing the source.
 
 
    :returns: true on success.

scripts/base/frameworks/logging/main.zeek.rst

@@ -29,7 +29,7 @@ Redefinable Options
 ###################
 =========================================================================================== =====================================================================
 :zeek:id:`Log::default_ext_prefix`: :zeek:type:`string` :zeek:attr:`&redef`                 A prefix for extension fields which can be optionally prefixed
-                                                                                            on all log lines by setting the `ext_func` field in the
+                                                                                            on all log lines by setting the ``ext_func`` field in the
                                                                                             log filter.
 :zeek:id:`Log::default_field_name_map`: :zeek:type:`table` :zeek:attr:`&redef`              Default field name mapping for renaming fields in a logging framework
                                                                                             filter.
@@ -199,7 +199,7 @@ Redefinable Options
    :Default: ``"_"``
 
    A prefix for extension fields which can be optionally prefixed
-   on all log lines by setting the `ext_func` field in the
+   on all log lines by setting the ``ext_func`` field in the
    log filter.
 
 .. zeek:id:: Log::default_field_name_map
@@ -326,8 +326,8 @@ Redefinable Options
 
    Default separator for log field scopes when logs are unrolled and
    flattened.  This will be the string between field name components.
-   For example, setting this to "_" will cause the typical field
-   "id.orig_h" to turn into "id_orig_h".
+   For example, setting this to ``_`` will cause the typical field
+   ``id.orig_h`` to turn into ``id_orig_h``.
 
 .. zeek:id:: Log::default_writer
    :source-code: base/frameworks/logging/main.zeek 27 27

scripts/base/frameworks/notice/main.zeek.rst

@@ -213,7 +213,7 @@ Redefinable Options
    on rotation with :zeek:enum:`Notice::ACTION_ALARM`.
 
    Note that this is overridden by the ZeekControl MailTo option or by
-   the `email_dest` field in the :zeek:see:`Notice::Info` record.
+   the ``email_dest`` field in the :zeek:see:`Notice::Info` record.
 
 .. zeek:id:: Notice::max_email_delay
    :source-code: base/frameworks/notice/main.zeek 221 221
@@ -607,7 +607,7 @@ Types
 
 
          Limitations in BPF make shunting some connections with BPF
-         impossible.  This notice encompasses those various cases.
+         impossible. This notice encompasses those various cases.
 
       .. zeek:enum:: Software::Software_Version_Change Notice::Type
 

scripts/base/frameworks/spicy/init-bare.zeek.rst

@@ -27,9 +27,9 @@ Constants
 
 Types
 #####
-====================================================== ==========================================
-:zeek:type:`Spicy::ResourceUsage`: :zeek:type:`record` Result type for `Spicy::resource_usage()`.
-====================================================== ==========================================
+====================================================== ============================================
+:zeek:type:`Spicy::ResourceUsage`: :zeek:type:`record` Result type for ``Spicy::resource_usage()``.
+====================================================== ============================================
 
 
 Detailed Interface
@@ -118,7 +118,7 @@ Types
       cached_fibers: :zeek:type:`count`
          number of fibers currently cached
 
-   Result type for `Spicy::resource_usage()`. The values reflect resource
+   Result type for ``Spicy::resource_usage()``. The values reflect resource
    usage as reported by the Spicy runtime system.
 
 

scripts/base/frameworks/supervisor/api.zeek.rst

@@ -206,7 +206,7 @@ Hooks
    :Type: :zeek:type:`hook` (node: :zeek:type:`string`, msg: :zeek:type:`string`) : :zeek:type:`bool`
 
    Hooks into the stderr stream for all supervisor's child processes.
-   If a hook terminates with `break`, that will suppress output to the
+   If a hook terminates with ``break``, that will suppress output to the
    associated stream.
 
 
@@ -226,7 +226,7 @@ Hooks
    :Type: :zeek:type:`hook` (node: :zeek:type:`string`, msg: :zeek:type:`string`) : :zeek:type:`bool`
 
    Hooks into the stdout stream for all supervisor's child processes.
-   If a hook terminates with `break`, that will suppress output to the
+   If a hook terminates with ``break``, that will suppress output to the
    associated stream.