Skip to content

Commit 7d70731

Browse files
committed
Merge remote-tracking branch 'origin/topic/etyp/minor-docs-fixes'
* origin/topic/etyp/minor-docs-fixes: Remove `bro-pkg.meta` reference Touchup quickstart and packages doc sections
2 parents 0d1f7e2 + 9433ac9 commit 7d70731

File tree

6 files changed

+70
-63
lines changed

6 files changed

+70
-63
lines changed

CHANGES

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
3.1.0-13 | 2025-09-16 15:56:14 -0400
2+
3+
* Remove `bro-pkg.meta` reference (Evan Typanski, Corelight)
4+
5+
* Touchup quickstart and packages doc sections (Evan Typanski, Corelight)
6+
7+
Mainly removing some `bro` references that will be considered outdated
8+
because versioning is different and fixing minor typos.
9+
110
3.1.0-10 | 2025-08-17 21:32:00 +0200
211

312
* Bump pre-commit hooks (Benjamin Bannier, Corelight)

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.1.0-10
1+
3.1.0-13

doc/man/zkg.1

Lines changed: 55 additions & 40 deletions
Large diffs are not rendered by default.

doc/package.rst

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,6 @@ This is the package's metadata file in INI file format and may contain
2222
:ref:`additional fields <metadata-fields>` that describe the package as well
2323
as how it inter-operates with Zeek, the package manager, or other packages.
2424

25-
.. note::
26-
27-
:file:`zkg.meta` is the canonical metadata file name used :program:`since
28-
zkg v2.0`. The previous metadata file name of :file:`bro-pkg.meta` is also
29-
accepted when no :file:`zkg.meta` exists.
30-
3125
.. _package-shorthand-name:
3226

3327
Note that the shorthand name for your package that may be used by :ref:`zkg
@@ -47,7 +41,7 @@ The easiest way to start a new Zeek package is via :program:`zkg`
4741
itself: its ``zkg create`` command lets you generate new Zeek packages
4842
from the command line.
4943

50-
This functionality is available since :program:`since zkg v2.9`. See the
44+
This functionality is available since :program:`zkg` v2.9. See the
5145
:ref:`Walkthroughs <manual-package-creation>` section for step-by-step
5246
processes that show how to manually create packages (e.g. perhaps when using
5347
older :program:`zkg` versions).
@@ -399,8 +393,6 @@ The low-level details of the way this field operates is that, for each alias,
399393
it simply creates a symlink of the same name within the directory associated
400394
with the ``script_dir`` path in the :ref:`config file <zkg-config-file>`.
401395

402-
Available :program:`since bro-pkg v1.5`.
403-
404396
`credits` field
405397
~~~~~~~~~~~~~~~
406398

@@ -484,7 +476,7 @@ added to :file:`{<user_script_dir>}/packages/packages.zeek`.
484476
You may place any valid Zeek script code within :file:`__load__.zeek`, but a
485477
package that contains many Zeek scripts will typically have :file:`__load__.zeek`
486478
just contain a list of ``@load`` directives to load other Zeek scripts within the
487-
package. E.g. if you have a package named **foo** installed, then it's
479+
package. E.g. if you have a package named **foo** installed, then its
488480
:file:`__load__.zeek` will be what Zeek loads when doing ``@load foo`` or running
489481
``zeek foo`` on the command-line.
490482

@@ -551,8 +543,6 @@ were also building an executable ``a.out``::
551543
The package manager makes executables available by maintaining symbolic
552544
links referring from :file:`bin_dir` to the actual files.
553545

554-
Available :program:`since bro-pkg v2.8`.
555-
556546
`build_command` field
557547
~~~~~~~~~~~~~~~~~~~~~
558548

@@ -603,7 +593,7 @@ Another pre-defined config key is `package_base`, which points to the top-level
603593
directory where :program:`zkg` stores all installed packages (i.e. clones of
604594
each package's git repository). This can be used to gain access to the content
605595
of another package that was installed as a dependency. Note that
606-
`package_base` is only available :program:`since zkg v2.3`
596+
`package_base` is only available since :program:`zkg` v2.3.
607597

608598
Internally, the value substitution and metadata parsing is handled by Python's
609599
`configparser interpolation`_. See its documentation if you're interested in
@@ -667,8 +657,6 @@ located in the environment. The user may also provide `user_vars` via
667657
priority over environment variables, which in turn take precedence over any
668658
values in the user's :ref:`package manager config file <zkg-config-file>`.
669659

670-
Available :program:`since bro-pkg v1.1`.
671-
672660
`test_command` field
673661
~~~~~~~~~~~~~~~~~~~~
674662

@@ -803,8 +791,6 @@ name and version specification for an external dependency are only used
803791
for display purposes -- to help users understand extra pre-requisites
804792
that are needed for proceeding with package installation/upgrades.
805793

806-
Available :program:`since bro-pkg v1.1`.
807-
808794
`suggests` field
809795
~~~~~~~~~~~~~~~~
810796

@@ -820,8 +806,6 @@ except in the way it's presented to users in various prompts during
820806
suggestions by supplying an additional ``--nosuggestions`` flag to
821807
:program:`zkg` commands.
822808

823-
Available :program:`since bro-pkg v1.3`.
824-
825809
.. _package-versioning:
826810

827811
Package Versioning

doc/quickstart.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,7 @@ also automatically distribute installed package scripts/plugins to all nodes.
132132

133133
.. code-block:: console
134134
135-
$ sudo chgrp $USER $(zeek-config --site_dir) $(zeek-config
136-
--plugin_dir) $(zeek-config --prefix)/bin
135+
$ sudo chgrp $USER $(zeek-config --site_dir) $(zeek-config --plugin_dir) $(zeek-config --prefix)/bin
137136
$ sudo chmod g+rwX $(zeek-config --site_dir) $(zeek-config --plugin_dir) $(zeek-config --prefix)/bin
138137
139138
The final step is to edit your :file:`site/local.zeek`. If you want to

zeekpkg/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
import logging
1111

12-
__version__ = "3.1.0-10"
12+
__version__ = "3.1.0-13"
1313
__all__ = ["manager", "package", "source", "template", "uservar"] # noqa: F405
1414

1515
LOG: logging.Logger = logging.getLogger(__name__)

0 commit comments

Comments
 (0)