Remove references to legacy bro naming

This intentionally leaves behind references to bro-pkg.meta and __bro_plugin__
but removes all of the other references to scripts and files that have been
deprecated and/or removed since Zeek 3.0.

Author: timwoj

doc/man/zkg.1

@@ -36,7 +36,7 @@ last component of its git URL. E.g. a package at ``https://github.com/zeek/foo``
 may be referred to as **foo** when using :program:`zkg` and a Zeek
 script that wants to load all the scripts within that package can use:
 
-.. code-block:: bro
+.. code-block:: zeek
 
   @load foo
 
@@ -229,11 +229,6 @@ though the following step are the essentials needed to create a package.
      script_dir = scripts/Demo/Rot13
      build_command = ./configure && make
 
-   .. note::
-
-      See :ref:`legacy-bro-support` for notes on configuring packages to
-      support Bro 2.5 or earlier.
-
 #. Add example script code:
 
    .. code-block:: console
@@ -257,9 +252,7 @@ though the following step are the essentials needed to create a package.
               *p  = (*p - b + 13) % 26 + b;
               }
 
-          BroString* bs = new BroString(1, reinterpret_cast<byte_vec>(rot13),
-                                        strlen(rot13));
-          return new StringVal(bs);
+          return make_intrusive<StringVal>(strlen(rot13), rot13);
           %}
 
 #. Commit everything to git:
@@ -576,11 +569,6 @@ An example :file:`zkg.meta`::
   script_dir = scripts/Demo/Rot13
   build_command = ./configure && make
 
-.. note::
-
-   See :ref:`legacy-bro-support` for notes on configuring packages to
-   support Bro 2.5 or earlier.
-
 The default CMake skeleton for Zeek plugins will use :file:`build/` as the
 directory for the final/built version of the plugin, which matches the defaulted
 value of the omitted `plugin_dir` metadata field.
@@ -591,31 +579,6 @@ script components, the "plugin" part is always unconditionally loaded by Zeek,
 but the "script" components must either be explicitly loaded (e.g. :samp:`@load
 {<package_name>}`) or the package marked as :ref:`loaded <load-command>`.
 
-.. _legacy-bro-support:
-
-Supporting Older Bro Versions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Plugin skeletons generated before Bro v2.6 and also any packages
-that generally want to support such Bro versions need to pass
-an additional configuration option such as::
-
-    build_command = ./configure --bro-dist=%(bro_dist)s && make
-
-See the :ref:`Value Interpolation <metadata-interpolation>`
-section for more information on what the ``%(bro_dist)s``
-string does, but a brief explanation is that it will expand to
-a path containing the Bro source-code on the user's system.
-For newer versions of Bro, packages are able to work entirely
-with the installation path and don't require original source code.
-
-Also note that other various Zeek scripting and CMake infrastructure may
-have changed between Bro v2.6 and Zeek v3.0.  So if you plan to support
-older version of Bro (before the Zeek rename), then you should keep an eye
-out for various things that got renamed.  For example, the `zeek_init` event
-won't exist in any version before Zeek v3.0, nor will any CMake macros
-that start with `zeek_plugin`.
-
 .. _metadata-interpolation:
 
 Value Interpolation
@@ -624,18 +587,14 @@ Value Interpolation
 The `build_command field`_ may reference the settings any given user has in
 their customized :ref:`package manager config file <zkg-config-file>`.
 
-For example, if a metadata field's value contains the ``%(bro_dist)s`` string,
+For example, if a metadata field's value contains the ``%(zeek_dist)s`` string,
 then :program:`zkg` operations that use that field will automatically
-substitute the actual value of `bro_dist` that the user has in their local
+substitute the actual value of `zeek_dist` that the user has in their local
 config file.  Note the trailing 's' character at the end of the interpolation
-string, ``%(bro_dist)s``, is intended/necessary for all such interpolation
-usages.  Note that :program:`since zkg v2.0`, `zeek_dist` is the canonical name
-for `bro_dist` within the :ref:`zkg config file <zkg-config-file>`,
-but either one means the same thing and should work.  To support older
-versions of :program:`bro-pkg`, you'd want to use `bro_dist` in package
-metadata files.
-
-Besides the `bro_dist`/`zeek_dist` config keys, any key inside the
+string, ``%(zeek_dist)s``, is intended/necessary for all such interpolation
+usages.
+
+Besides the `zeek_dist` config key, any key inside the
 `user_vars` sections of their :ref:`package manager config file
 <zkg-config-file>` that matches the key of an entry in the package's
 `user_vars field`_ will be interpolated.
@@ -777,38 +736,24 @@ An example :file:`zkg.meta`::
 The field is a list of dependency names and their version requirement
 specifications.
 
-A dependency name may be either `zeek`, `zkg`, `bro`, `bro-pkg`,
+A dependency name may be either `zeek`, `zkg`,
 a full git URL of the package, or a :ref:`package shorthand name
 <package-shorthand-name>`.
 
-- The special `zeek` and `bro` dependencies refers not to a package,
-  but the version of Zeek that the package requires in order to function.  If
-  the user has :program:`zeek-config` or :program:`bro-config` in their
-  :envvar:`PATH` when installing/upgrading a package that specifies a `zeek` or
-  `bro` dependency, then :program:`zkg` will enforce that the requirement is
-  satisfied.
+- The special `zeek` dependency refers not to a package, but the version of Zeek
+  that the package requires in order to function.  If the user has
+  :program:`zeek-config` in their :envvar:`PATH` when installing/upgrading a
+  package that specifies a `zeek` dependency, then :program:`zkg` will enforce
+  that the requirement is satisfied.
 
-  .. note::
-
-     In this context, `zeek` and `bro` mean the same thing -- the
-     later is maintained for backwards compatibility while the former
-     became available :program:`since zkg v2.0`.
-
-- The special `zkg` and `bro-pkg` dependencies refers to the version of the
+- The special `zkg` dependency refers to the version of the
   package manager that is required by the package.  E.g. if a package takes
   advantage of new features that are not present in older versions of the
   package manager, then it should indicate that so users of those old version
   will see an error message an know to upgrade instead of seeing a cryptic
   error/exception, or worse, seeing no errors, but without the desired
   functionality being performed.
 
-  .. note::
-
-     This feature itself, via use of a `bro-pkg` dependency, is only
-     available :program:`since bro-pkg v1.2` while a `zkg` dependency is only
-     recognized :program:`since zkg v2.0`.  Otherwise, `zkg` and `bro-pkg` mean
-     the same thing in this context.
-
 - The full git URL may be directly specified in the `depends` metadata if you
   want to force the dependency to always resolve to a single, canonical git
   repository.  Typically this is the safe approach to take when listing

doc/package.rst

@@ -141,7 +141,7 @@ have Zeek automatically load the scripts from all
 :ref:`installed <install-command>` packages that are also marked as
 ":ref:`loaded <load-command>`" add:
 
-.. code-block:: bro
+.. code-block:: zeek
 
   @load packages
 

doc/quickstart.rst

@@ -1,5 +1,3 @@
-.. _bro-pkg:
-
 .. _zkg:
 
 zkg Command-Line Tool
@@ -217,8 +215,6 @@ template info
     :prog: zkg
     :path: template info
 
-.. _bro-pkg-config-file:
-
 .. _zkg-config-file:
 
 Config File

doc/zkg.rst

@@ -360,9 +360,6 @@ def read_zeek_config_line(stdout):
 def get_zeek_version():
     zeek_config = find_program("zeek-config")
 
-    if not zeek_config:
-        zeek_config = find_program("bro-config")
-
     if not zeek_config:
         return ""
 

zeekpkg/_util.py

@@ -119,22 +119,15 @@ def populate(self):
                     make_symlink(entry.path, os.path.join(self.clone_dir, entry.name))
 
     def get_subprocess_env(self):
-        zeekpath = os.environ.get("ZEEKPATH") or os.environ.get("BROPATH")
-        pluginpath = os.environ.get("ZEEK_PLUGIN_PATH") or os.environ.get(
-            "BRO_PLUGIN_PATH"
-        )
+        zeekpath = os.environ.get("ZEEKPATH")
+        pluginpath = os.environ.get("ZEEK_PLUGIN_PATH")
 
         if not (zeekpath and pluginpath):
             zeek_config = find_program("zeek-config")
-            path_option = "--zeekpath"
-
-            if not zeek_config:
-                zeek_config = find_program("bro-config")
-                path_option = "--bropath"
 
             if zeek_config:
                 cmd = subprocess.Popen(
-                    [zeek_config, path_option, "--plugin_dir"],
+                    [zeek_config, "--zeekpath", "--plugin_dir"],
                     stdout=subprocess.PIPE,
                     stderr=subprocess.STDOUT,
                     bufsize=1,
@@ -149,7 +142,7 @@ def get_subprocess_env(self):
                 if not pluginpath:
                     pluginpath = line2
             else:
-                return None, 'no "zeek-config" or "bro-config" found in PATH'
+                return None, 'no "zeek-config" found in PATH'
 
         zeekpath = os.path.dirname(self.script_dir) + os.pathsep + zeekpath
         pluginpath = os.path.dirname(self.plugin_dir) + os.pathsep + pluginpath
@@ -158,8 +151,6 @@ def get_subprocess_env(self):
         env["PATH"] = self.bin_dir + os.pathsep + os.environ.get("PATH", "")
         env["ZEEKPATH"] = zeekpath
         env["ZEEK_PLUGIN_PATH"] = pluginpath
-        env["BROPATH"] = zeekpath
-        env["BRO_PLUGIN_PATH"] = pluginpath
 
         return env, ""
 
@@ -277,8 +268,6 @@ def __init__(
         self.installed_pkgs = {}
         self._builtin_packages = None  # Cached Zeek built-in packages.
         self._builtin_packages_discovered = False  # Flag if discovery even worked.
-        # The bro_dist attribute exists just for backward compatibility
-        self.bro_dist = zeek_dist
         self.zeek_dist = zeek_dist
         self.state_dir = state_dir
         self.user_vars = {} if user_vars is None else user_vars
@@ -380,14 +369,6 @@ def __init__(
         self._write_autoloader()
         make_symlink("packages.zeek", self.autoload_package)
 
-        # Backward compatibility (Pre-Zeek 3.0 does not handle .zeek files)
-        autoload_script_fallback = os.path.join(self.script_dir, "packages.bro")
-        autoload_package_fallback = os.path.join(self.script_dir, "__load__.bro")
-        delete_path(autoload_script_fallback)
-        delete_path(autoload_package_fallback)
-        make_symlink("packages.zeek", autoload_script_fallback)
-        make_symlink("packages.zeek", autoload_package_fallback)
-
     def _write_autoloader(self):
         """Write the :file:`packages.zeek` loader script.
 
@@ -516,13 +497,6 @@ def zeekpath(self):
         """
         return os.path.dirname(self.script_dir)
 
-    def bropath(self):
-        """Same as :meth:`zeekpath`.
-
-        Using :meth:`zeekpath` is preferred since this may later be deprecated.
-        """
-        return self.zeekpath()
-
     def zeek_plugin_path(self):
         """Return the path where installed package plugins are located.
 
@@ -531,14 +505,6 @@ def zeek_plugin_path(self):
         """
         return os.path.dirname(self.plugin_dir)
 
-    def bro_plugin_path(self):
-        """Same as :meth:`zeek_plugin_path`.
-
-        Using :meth:`zeek_plugin_path` is preferred since this may later be
-        deprecated.
-        """
-        return self.zeek_plugin_path()
-
     def add_source(self, name, git_url):
         """Add a git repository that acts as a source of packages.
 
@@ -1493,16 +1459,8 @@ def load(self, pkg_path):
         pkg_load_script = os.path.join(
             self.script_dir, ipkg.package.name, "__load__.zeek"
         )
-        # Check if __load__.bro exists for compatibility with older packages
-        pkg_load_fallback = os.path.join(
-            self.script_dir, ipkg.package.name, "__load__.bro"
-        )
 
-        if (
-            not os.path.exists(pkg_load_script)
-            and not os.path.exists(pkg_load_fallback)
-            and not self.has_plugin(ipkg)
-        ):
+        if not os.path.exists(pkg_load_script) and not self.has_plugin(ipkg):
             LOG.debug(
                 'loading "%s": %s not found and package has no plugin',
                 pkg_path,
@@ -2067,11 +2025,11 @@ def __str__(self):
                 all_deps.update(ds)
 
             for dep_name, _ in all_deps.items():
-                if dep_name == "bro" or dep_name == "zeek":
+                if dep_name == "zeek":
                     # A zeek node will get added later.
                     continue
 
-                if dep_name == "bro-pkg" or dep_name == "zkg":
+                if dep_name == "zkg":
                     # A zkg node will get added later.
                     continue
 
@@ -2140,9 +2098,7 @@ def __str__(self):
                 )
                 graph["zeek"] = node
             else:
-                LOG.warning(
-                    'could not get zeek version: no "zeek-config" or "bro-config" in PATH ?'
-                )
+                LOG.warning('could not get zeek version: no "zeek-config" in PATH ?')
 
             node = Node("zkg")
             node.installed_version = PackageVersion(
@@ -2196,11 +2152,11 @@ def __str__(self):
                 all_deps.update(ds)
 
             for dep_name, dep_version in all_deps.items():
-                if dep_name == "bro" or dep_name == "zeek":
+                if dep_name == "zeek":
                     if "zeek" in graph:
                         graph["zeek"].dependers[name] = dep_version
                         node.dependees["zeek"] = dep_version
-                elif dep_name == "bro-pkg" or dep_name == "zkg":
+                elif dep_name == "zkg":
                     if "zkg" in graph:
                         graph["zkg"].dependers[name] = dep_version
                         node.dependees["zkg"] = dep_version
@@ -2838,10 +2794,9 @@ def _stage(self, package, version, clone, stage, env=None):
                 "package's 'script_dir' does not exist: {}", pkg_script_dir
             )
 
-        pkgload = os.path.join(script_dir_src, "__load__.")
+        pkgload = os.path.join(script_dir_src, "__load__.zeek")
 
-        # Check if __load__.bro exists for compatibility with older packages
-        if os.path.isfile(pkgload + "zeek") or os.path.isfile(pkgload + "bro"):
+        if os.path.isfile(pkgload):
             try:
                 symlink_path = os.path.join(
                     os.path.dirname(stage.script_dir), package.name
@@ -3095,7 +3050,6 @@ def _interpolate_package_metadata(self, metadata, stage):
             return None, "package has malformed 'user_vars' metadata field"
 
         substitutions = {
-            "bro_dist": self.zeek_dist,
             "zeek_dist": self.zeek_dist,
             "package_base": stage.clone_dir,
         }
@@ -3368,4 +3322,4 @@ def _info_from_clone(clone, package, status, version):
 
 
 def _is_reserved_pkg_name(name):
-    return name == "bro" or name == "zeek" or name == "zkg"
+    return name == "zeek" or name == "zkg"