Add a chapter on script optimization #267
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vpax
reviewed
Aug 8, 2024
scripting/optimization.rst
Outdated
| You can tune various features of ZAM via additional options to ``-O``, see the | ||
| output of ``zeek -O help`` for details. For example, you can study the script | ||
| transformations ZAM applies, and use ZAM selectively in certain files (via | ||
| ``-0|--optimize-files``) or functions (via ``-o|--optimize-funcs``). Most users |
There was a problem hiding this comment.
Nit: the -0 and -o are just because the getopt parser needs single-character options to communicate what's seen (at least, that's my understanding). So they could be removed here, as they're not very mnemonic anyway.
There was a problem hiding this comment.
Looks good, could address the above nit.
The goal here is to make regular users aware of the feature at this time, but leave most of the tunables and flags out of the picture for the time being.
ckreibich
force-pushed
the
topic/christian/zam
branch
from
a2a3447 to
b5a94e7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The goal here is to make regular users aware of the feature at this time, but leave most of the tunables and flags out of the picture for the time being.
@vpax fyi — I'm sure you'll want to iterate on this, or at least review. It's heavily based on your in-tree README, as discussed. (No rush, it can wait until you're back.)