mirror of
https://github.com/zeek/zeek.git
synced 2025-10-09 01:58:20 +00:00
6f882af7cc
So far we had trouble documenting Spicy analyzers through Zeekygen because they would show up as components belonging to the `Zeek::Spicy` plugin; whereas traditional analyzers would be their own plugins and hence documented individually on their own. This commit teaches Zeekygen to track Spicy analyzers separately inside their own `Info` instances. This information isn't further used in this commit yet, but will be merged with the plugin output in a subsequent change to get the expected joint output. To pass additional information to Zeekygen, EVT files now also support two new tags for Zeekygen purposes: - `%doc-id = ID;` defines the global ID under which everything inside the EVT file will be documented by Zeekygen, conceptually comparable to plugin names (e.g., `Zeek::Syslog`). - `%doc-description = "text" provides additional text to go into the documentation (comparable to plugin descriptions). This information is carried through into the HLTO runtime initialization code, from where it's registered with Zeekygen. This commit also removes a couple of previous hacks of how Spicy integrated with Zeekygen which (1) ended up generating broken doc output for Spicy components, and (2) don't seem to be necessary anymore anyways. |
||
|---|---|---|
| .. | ||
| benchmark/broker | ||
| btest | ||
| builtin-plugins | ||
| coverage | ||
| external | ||
| scripts | ||
| .gitignore | ||
| CMakeLists.txt | ||
| Makefile | ||
| README | ||
This directory contains suites for testing for Zeek's correct
operation:
btest/
An ever-growing set of small unit tests testing Zeek's
functionality.
external/
A framework for downloading additional test sets that run more
complex Zeek configuration on larger traces files. Due to their
size, these are not included directly. See the README for more
information.
scripts/
Helpers scripts used by some tests.