Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update for "footprint" documentation to reflect equating long strings with multiple objects #260

Merged
merged 1 commit into from
May 3, 2024
Merged

Update for "footprint" documentation to reflect equating long strings with multiple objects #260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions scripts/base/bif/zeek.bif.zeek.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,8 +257,8 @@ Functions
:zeek:id:`unique_id_from`: :zeek:type:`function` Creates an identifier that is unique with high probability.
:zeek:id:`unlink`: :zeek:type:`function` Removes a file from a directory.
:zeek:id:`uuid_to_string`: :zeek:type:`function` Converts a bytes representation of a UUID into its string form.
:zeek:id:`val_footprint`: :zeek:type:`function` Computes a value's "footprint": the number of objects the value contains
either directly or indirectly.
:zeek:id:`val_footprint`: :zeek:type:`function` Computes a value's "footprint": the number of equivalent objects the
value contains either directly or indirectly.
:zeek:id:`write_file`: :zeek:type:`function` Writes data to an open file.
:zeek:id:`zeek_args`: :zeek:type:`function` Returns: list of command-line arguments (``argv``) used to run Zeek.
:zeek:id:`zeek_is_terminating`: :zeek:type:`function` Checks if Zeek is terminating.
Expand Down Expand Up @@ -1580,6 +1580,7 @@ Functions
This is (approximately) the number of objects the global contains either
directly or indirectly. The number is not meant to be precise, but
rather comparable: larger footprint correlates with more memory consumption.
Note that sufficiently long `string` values are treated as multiple objects.
The table index is the variable name and the value is the footprint.


Expand Down Expand Up @@ -3794,6 +3795,7 @@ Functions
Computes a value's "footprint": the number of objects the value contains
either directly or indirectly. The number is not meant to be precise, but
rather comparable: larger footprint correlates with more memory consumption.
Note that sufficiently long `string` values are treated as multiple objects.


:returns: the footprint.
Expand Down
Loading