Skip to content

Drop one "o" and rename the project as "Toolbx"#1446

Merged
debarshiray merged 2 commits intocontainers:mainfrom
debarshiray:wip/rishi/change-project-name-to-Toolbx
Feb 6, 2024
Merged

Drop one "o" and rename the project as "Toolbx"#1446
debarshiray merged 2 commits intocontainers:mainfrom
debarshiray:wip/rishi/change-project-name-to-Toolbx

Conversation

@debarshiray
Copy link
Copy Markdown
Member

@debarshiray debarshiray commented Feb 3, 2024

This is meant to make the project more searchable on the Internet. More and more people have been pointing out that "toolbox" is terribly difficult to search for, and it's impossible to find any decent Internet real estate by that name.

Some exceptions:

  • The code repository is still https://github.com/containers/toolbox. It will be renamed after giving a heads-up to other contributors.

  • The name of the binary is still toolbox. The name is embedded into existing Toolbx containers as their entry point, which is bind mounted from the host operating system when the containers are started. Trivially renaming the binary will prevent these containers from starting.

  • For similar reasons, the TOOLBOX_PATH environment variable is still the same.

  • For similar reasons, the profile.d file to be read by the shell on start-up is still called toolbox.sh.

  • The label used to identify Toolbx containers and images is still called com.github.containers.toolbox. There are many existing Toolbx containers, and many Toolbx images beyond the control of the Toolbx project that use this label to identity themselves. Simply renaming the label will prevent these containers and images from being recognized.

  • The names of the built-in Toolbx images still retain the word toolbox. Images under the new name need to be published on the OCI registries and the toolbox(1) binary needs to be taught to handle both old and new names, wherever necessary, for backwards compatibility.

  • The stamp file used to identify Toolbx containers is still called /run/.toolboxenv because it's used by various external programs and users to identify Toolbx containers.

  • The OSC 777 escape sequence to track and preserve the user's current Toolbx container [1] still emits toolbox as the name of the container runtime. Changing the escape sequence can break terminal emulation applications, like Prompt [2], that consume it. Hence, it needs to be done carefully.

  • The runtime directories at /run/toolbox, when used as root, and $XDG_RUNTIME_DIR/toolbox, when used rootless, weren't renamed.

    When used as root, /run/toolbox is embedded into existing Toolbx containers as a bind mount from the host. Trivially renaming the path will prevent these containers from starting.

    Secondly, both these paths are used to synchronize container start-up. If the paths are trivially renamed, and the toolbox(1) binary is updated and used without stopping all existing containers, then it won't be able to enter containers that were already started. Strictly speaking, this scenario isn't supported, since updates are always expected to be offline [3]. However, it's worth noting because solving the previous problem might also address this.

  • The configuration file for RPM is still called /usr/lib/rpm/macros.d/macros.toolbox.

[1] https://gitlab.freedesktop.org/terminal-wg/specifications/-/issues/17

[2] https://gitlab.gnome.org/chergert/prompt

[3] https://www.freedesktop.org/software/systemd/man/latest/systemd.offline-updates.html

#1399

@softwarefactory-project-zuul
Copy link
Copy Markdown

Build failed.
https://softwarefactory-project.io/zuul/t/local/buildset/2f138d5bb11b44728ee5993a6aa52a18

✔️ unit-test SUCCESS in 5m 09s
✔️ unit-test-migration-path-for-coreos-toolbox SUCCESS in 3m 24s
✔️ unit-test-restricted SUCCESS in 4m 08s
system-test-fedora-rawhide FAILURE in 33m 12s
system-test-fedora-39 FAILURE in 32m 10s
system-test-fedora-38 FAILURE in 28m 34s

@debarshiray debarshiray force-pushed the wip/rishi/change-project-name-to-Toolbx branch from 526d104 to 5b5568c Compare February 5, 2024 16:17
@softwarefactory-project-zuul
Copy link
Copy Markdown

Build failed.
https://softwarefactory-project.io/zuul/t/local/buildset/7a618284c1314653b7d503fe7c6e08a7

✔️ unit-test SUCCESS in 4m 56s
✔️ unit-test-migration-path-for-coreos-toolbox SUCCESS in 3m 17s
✔️ unit-test-restricted SUCCESS in 3m 59s
system-test-fedora-rawhide FAILURE in 32m 27s
system-test-fedora-39 FAILURE in 30m 16s
system-test-fedora-38 FAILURE in 29m 58s

@debarshiray debarshiray force-pushed the wip/rishi/change-project-name-to-Toolbx branch from 5b5568c to 45a9b40 Compare February 5, 2024 18:15
@softwarefactory-project-zuul
Copy link
Copy Markdown

Build failed.
https://softwarefactory-project.io/zuul/t/local/buildset/60f8e815483b4de2b610bb9465d87db8

unit-test RETRY_LIMIT in 12m 18s
✔️ unit-test-migration-path-for-coreos-toolbox SUCCESS in 3m 33s
unit-test-restricted RETRY_LIMIT in 6m 36s
system-test-fedora-rawhide RETRY_LIMIT in 17m 20s
system-test-fedora-39 RETRY_LIMIT in 23m 04s
system-test-fedora-38 RETRY_LIMIT in 17m 23s

@debarshiray debarshiray force-pushed the wip/rishi/change-project-name-to-Toolbx branch from 45a9b40 to da23002 Compare February 5, 2024 19:40
@softwarefactory-project-zuul
Copy link
Copy Markdown

Build failed.
https://softwarefactory-project.io/zuul/t/local/buildset/8a0b59f873314c38a2310d2f1bbc45f0

unit-test RETRY_LIMIT in 12m 30s
✔️ unit-test-migration-path-for-coreos-toolbox SUCCESS in 4m 58s
unit-test-restricted RETRY_LIMIT in 16m 31s
system-test-fedora-rawhide RETRY_LIMIT in 12m 30s
system-test-fedora-39 RETRY_LIMIT in 8m 46s
system-test-fedora-38 RETRY_LIMIT in 18m 17s

@debarshiray
Copy link
Copy Markdown
Member Author

recheck

@softwarefactory-project-zuul
Copy link
Copy Markdown

Build succeeded.
https://softwarefactory-project.io/zuul/t/local/buildset/f4697663e7204d378058f5d6b775e328

✔️ unit-test SUCCESS in 4m 46s
✔️ unit-test-migration-path-for-coreos-toolbox SUCCESS in 3m 21s
✔️ unit-test-restricted SUCCESS in 3m 44s
✔️ system-test-fedora-rawhide SUCCESS in 28m 56s
✔️ system-test-fedora-39 SUCCESS in 32m 35s
✔️ system-test-fedora-38 SUCCESS in 34m 32s

This is meant to make the project more searchable on the Internet.  More
and more people have been pointing out that "toolbox" is terribly
difficult to search for, and it's impossible to find any decent
Internet real estate by that name.

Some exceptions:

  * The code repository is still https://github.com/containers/toolbox.
    It will be renamed after giving a heads-up to other contributors.

  * The name of the binary is still 'toolbox'.  The name is embedded
    into existing Toolbx containers as their entry point, which is bind
    mounted from the host operating system when the containers are
    started.  Trivially renaming the binary will prevent these
    containers from starting.

  * For similar reasons, the TOOLBOX_PATH environment variable is still
    the same.

  * For similar reasons, the profile.d file to be read by the shell on
    start-up is still called toolbox.sh.

  * The label used to identify Toolbx containers and images is still
    called com.github.containers.toolbox.  There are many existing
    Toolbx containers, and many Toolbx images beyond the control of the
    Toolbx project that use this label to identity themselves.  Simply
    renaming the label will prevent these containers and images from
    being recognized.

  * The names of the built-in Toolbx images still retain the word
    'toolbox'.  Images under the new name need to be published on the
    OCI registries and the toolbox(1) binary needs to be taught to
    handle both old and new names, wherever necessary, for backwards
    compatibility.

  * The stamp file used to identify Toolbx containers is still called
    /run/.toolboxenv because it's used by various external programs and
    users to identify Toolbx containers.

  * The OSC 777 escape sequence to track and preserve the user's current
    Toolbx container [1] still emits 'toolbox' as the name of the
    container runtime.  Changing the escape sequence can break terminal
    emulation applications, like Prompt [2], that consume it.  Hence, it
    needs to be done carefully.

  * The runtime directories at /run/toolbox, when used as root, and
    $XDG_RUNTIME_DIR/toolbox, when used rootless, weren't renamed.

    When used as root, /run/toolbox is embedded into existing Toolbx
    containers as a bind mount from the host.  Trivially renaming the
    path will prevent these containers from starting.

    Secondly, both these paths are used to synchronize container
    start-up.  If the paths are trivially renamed, and the toolbox(1)
    binary is updated and used without stopping all existing containers,
    then it won't be able to enter containers that were already started.
    Strictly speaking, this scenario isn't supported, since updates are
    always expected to be "offline" [3].  However, it's worth noting
    because solving the previous problem might also address this.

  * The configuration file for RPM is still called
    /usr/lib/rpm/macros.d/macros.toolbox.

[1] https://gitlab.freedesktop.org/terminal-wg/specifications/-/issues/17

[2] https://gitlab.gnome.org/chergert/prompt

[3] https://www.freedesktop.org/software/systemd/man/latest/systemd.offline-updates.html

containers#1399
@softwarefactory-project-zuul
Copy link
Copy Markdown

Build succeeded.
https://softwarefactory-project.io/zuul/t/local/buildset/9a16dd1be4eb4d5d9896b6cbbb3d38dc

✔️ unit-test SUCCESS in 5m 08s
✔️ unit-test-migration-path-for-coreos-toolbox SUCCESS in 3m 42s
✔️ unit-test-restricted SUCCESS in 3m 57s
✔️ system-test-fedora-rawhide SUCCESS in 39m 04s
✔️ system-test-fedora-39 SUCCESS in 38m 49s
✔️ system-test-fedora-38 SUCCESS in 38m 57s

@debarshiray debarshiray merged commit c3403da into containers:main Feb 6, 2024
@debarshiray debarshiray deleted the wip/rishi/change-project-name-to-Toolbx branch February 6, 2024 19:11
waldyrious added a commit to tldr-pages/tldr that referenced this pull request Dec 6, 2025
The project was renamed to "Toolbx" to improve searchability back in 2021:
<containers/containertoolbx.org#1>

The command name and a few other places (environment variables, runtime paths, etc.)
kept the previous name for backward compatibility, but otherwise the new name is to be used:
<containers/toolbox#1446>
Managor pushed a commit to tldr-pages/tldr that referenced this pull request Dec 10, 2025
The project was renamed to "Toolbx" to improve searchability back in 2021:
<containers/containertoolbx.org#1>

The command name and a few other places (environment variables, runtime paths, etc.)
kept the previous name for backward compatibility, but otherwise the new name is to be used:
<containers/toolbox#1446>

---------

Co-authored-by: Darío Hereñú <magallania@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant