diff mbox series

[v2] dev-manual: update bmap-tools package to refer to bmaptool

Message ID f1851b98-7b99-e132-8ff1-a63a5e457089@crashcourse.ca
State New
Headers show
Series [v2] dev-manual: update bmap-tools package to refer to bmaptool | expand

Commit Message

Robert P. J. Day June 16, 2026, 2:16 p.m. UTC 
Update the bmaptool section to refer to the newer name of the package
"bmaptool", and add a note mentioning that the old name of
"bmap-tools" is a transitional package for this.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

commit e69f21e8a7aa97817d16b8961d68c0cef1c80540
Author: Robert P. J. Day <rpjday@crashcourse.ca>
Date:   Tue Jun 16 10:14:12 2026 -0400

    bmap

Comments

Antonin Godard June 16, 2026, 3:09 p.m. UTC | #1 
Hi,

On Tue Jun 16, 2026 at 4:16 PM CEST, Robert P. J. Day wrote:
[...]
> +   If you have this package installed, you can safely remove it
> +   and install the newer ``bmaptool`` package.

I'm not sure saying this is relevant. I don't think those older distros will
ever deprecate the "bmap-tools" package name.

Antonin
diff mbox series

Patch

diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst
index 87162a49c..0b3a20481 100644
--- a/documentation/dev-manual/bmaptool.rst
+++ b/documentation/dev-manual/bmaptool.rst
@@ -13,13 +13,13 @@  system image files much faster.
 .. note::

    -  If you are using Ubuntu or Debian distributions, you can install
-      the ``bmap-tools`` package using the following command and then
+      the ``bmaptool`` package using the following command and then
       use the tool without specifying ``PATH`` even from the root
       account::

-         $ sudo apt install bmap-tools
+         $ sudo apt install bmaptool

-   -  If you are unable to install the ``bmap-tools`` package, you will
+   -  If you are unable to install the ``bmaptool`` package, you will
       need to build `bmaptool` before using it. Use the following command::

          $ bitbake bmaptool-native -caddto_recipe_sysroot
@@ -56,3 +56,13 @@  For help on the ``bmaptool`` command, use the following command::

    $ bmaptool --help

+.. note::
+
+   Earlier releases of Ubuntu and Debian had a package named
+   ``bmap-tools``; you can still install by this name as this
+   is simply a transitional package which exists solely to
+   ensure backward compatibility and smooth upgrades from
+   older installations.
+
+   If you have this package installed, you can safely remove it
+   and install the newer ``bmaptool`` package.