Skip to content

Commit c3403da

Browse files
committed
Drop one "o" and rename the project as "Toolbx"
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
1 parent da23002 commit c3403da

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+646
-646
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug report
3-
about: Toolbox's bug report template
3+
about: Toolbx's bug report template
44
title: ''
55
labels: 1. Bug
66
assignees: ''
@@ -28,7 +28,7 @@ If applicable, add screenshots to help explain your problem.
2828
**Output of `toolbox --version` (v0.0.90+)**
2929
e.g., `toolbox version 0.0.90`
3030

31-
**Toolbox package info (`rpm -q toolbox`)**
31+
**Toolbx package info (`rpm -q toolbox`)**
3232
e.g., `toolbox-0.0.18-2.fc32.noarch`
3333

3434
**Output of `podman version`**
@@ -49,6 +49,6 @@ e.g., Fedora Silverblue 32
4949
**Additional context**
5050
Add any other context about the problem here.
5151
When did the issue start occurring? After an update (what packages were updated)?
52-
If the issue is about operating with containers/images (creating, using, deleting,..), share here what image you used. If you're unsure, share here the output of `toolbox list -i` (shows all toolbox images on your system).
52+
If the issue is about operating with containers/images (creating, using, deleting,..), share here what image you used. If you're unsure, share here the output of `toolbox list -i` (shows all Toolbx images on your system).
5353

5454
If you see an error message saying: `Error: invalid entry point PID of container <name-of-container>`, add to the ticket output of command `podman start --attach <name-of-container>`.

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Feature request
3-
about: Toolbox's feature request template
3+
about: Toolbx's feature request template
44
title: ''
55
labels: 1. Feature request
66
assignees: ''

.zuul.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#
2-
# Copyright © 2020 – 2023 Red Hat, Inc.
2+
# Copyright © 2020 – 2024 Red Hat, Inc.
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.
@@ -17,7 +17,7 @@
1717
---
1818
- job:
1919
name: unit-test
20-
description: Run Toolbox's unit tests declared in Meson
20+
description: Run Toolbx's unit tests declared in Meson
2121
timeout: 1800
2222
nodeset:
2323
nodes:
@@ -28,7 +28,7 @@
2828

2929
- job:
3030
name: unit-test-migration-path-for-coreos-toolbox
31-
description: Run Toolbox's unit tests declared in Meson when built with -Dmigration_path_for_coreos_toolbox
31+
description: Run Toolbx's unit tests declared in Meson when built with -Dmigration_path_for_coreos_toolbox
3232
timeout: 600
3333
nodeset:
3434
nodes:
@@ -39,7 +39,7 @@
3939

4040
- job:
4141
name: unit-test-restricted
42-
description: Run Toolbox's unit tests declared in Meson in a restricted build environment
42+
description: Run Toolbx's unit tests declared in Meson in a restricted build environment
4343
timeout: 1800
4444
nodeset:
4545
nodes:
@@ -50,7 +50,7 @@
5050

5151
- job:
5252
name: system-test-fedora-rawhide
53-
description: Run Toolbox's system tests in Fedora Rawhide
53+
description: Run Toolbx's system tests in Fedora Rawhide
5454
timeout: 4800
5555
nodeset:
5656
nodes:

CODE-OF-CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
## The Toolbox Project Community Code of Conduct
1+
## The Toolbx Project Community Code of Conduct
22

3-
The Toolbox project follows the [Containers Community Code of Conduct](https://github.com/containers/common/blob/main/CODE-OF-CONDUCT.md).
3+
The Toolbx project follows the [Containers Community Code of Conduct](https://github.com/containers/common/blob/main/CODE-OF-CONDUCT.md).

CONTRIBUTING.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
![Contributing](data/gfx/CONTRIBUTING.gif)
22

3-
# Contributing to Toolbox
3+
# Contributing to Toolbx
44

5-
Thank you for wanting to contribute to Toolbox! We greatly appreciate your
5+
Thank you for wanting to contribute to Toolbx! We greatly appreciate your
66
interest!
77

88
# Reporting Bugs
@@ -13,7 +13,7 @@ interest!
1313
- If the issue is already reported and is marked as **OPEN**, comment on it
1414
and if possible and needed, share info about the issue just as if you were
1515
submitting a new issue
16-
- If the issue is marked as **CLOSED**, check if your version of Toolbox is
16+
- If the issue is marked as **CLOSED**, check if your version of Toolbx is
1717
up-to-date or if there are some steps, described in the closed issue, that
1818
you should follow. If you are still experiencing the issue, please file a
1919
new issue
@@ -37,14 +37,14 @@ When writing a bug report:
3737
reproduce it.
3838
- **Describe the behavior you received and what you expected** - Sometimes it
3939
may not be clear what the *right* behavior should look like.
40-
- **Provide info about the version of used software** - What version of Toolbox
40+
- **Provide info about the version of used software** - What version of Toolbx
4141
and Podman do you use?
4242
- **Provide info about your system** - What distribution do you use? Which
4343
desktop environment? Is it a VM or a real machine?
4444

4545
# Making Suggestions
4646

47-
Toolbox is not feature-complete and some of it's functionality is not-there-yet.
47+
Toolbx is not feature-complete and some of it's functionality is not-there-yet.
4848
We are thankful for all suggestions and ideas but be ready that your suggestion
4949
may be rejected.
5050

@@ -63,7 +63,7 @@ may be rejected.
6363
When writing a suggestion:
6464

6565
- **Use a clear and descriptive title**
66-
- **Describe the idea** - What parts of Toolbox does it affect? Is it a major
66+
- **Describe the idea** - What parts of Toolbx does it affect? Is it a major
6767
functionality or a minor tweak?
6868
- **Provide step-by-step description of the suggested behavior** so that we
6969
will understand.
@@ -72,13 +72,13 @@ When writing a suggestion:
7272

7373
# First Contribution
7474

75-
Toolbox is written in [Go](https://golang.org) and uses [Meson](https://mesonbuild.com)
75+
Toolbx is written in [Go](https://golang.org) and uses [Meson](https://mesonbuild.com)
7676
as it's buildsystem.
7777

78-
Instructions for building Toolbox from source are in our [README](https://github.com/containers/toolbox/blob/main/README.md).
78+
Instructions for building Toolbx from source are in our [README](https://github.com/containers/toolbox/blob/main/README.md).
7979

8080
> You may not need to build the project from source if your contribution is not
81-
> related to the code of Toolbox itself (e.g., documentation, updating CI
81+
> related to the code of Toolbx itself (e.g., documentation, updating CI
8282
> config, playing with image definitions,...).
8383
8484
Here are some ideas of what you could contribute with:
@@ -88,18 +88,18 @@ Here are some ideas of what you could contribute with:
8888
- Write tests - Go has [tools](https://golang.org/pkg/testing/) for writing tests.
8989
There are also [some](https://github.com/stretchr/testify) [libraries](https://github.com/onsi/ginkgo)
9090
used for creating even more sophisticated tests.
91-
- Play with custom images - Toolbox currently officially works with Fedora-based
91+
- Play with custom images - Toolbx currently officially works with Fedora-based
9292
images. Ultimately there should be a wide variety of supported distro images.
9393
You can help with testing other people's image definitions or creating your
9494
own. **Beware**, maintainers still don't have a clear idea of how the image
9595
infrastructure should look like.
96-
- Write documentation - Some functions in Toolbox's code don't have comments and
97-
it's not very clear what they do. Toolbox has it's [documentation](https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/)
96+
- Write documentation - Some functions in Toolbx's code don't have comments and
97+
it's not very clear what they do. Toolbx has it's [documentation](https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/)
9898
hosted by Fedora. It's not very large and could use some attention.
9999
- Hack on the code and share the result - Seriously! Sometimes random ideas are
100100
the best.
101101

102-
Toolbox currently does not have an infrastructure for translations. You can help
102+
Toolbx currently does not have an infrastructure for translations. You can help
103103
us to set it up!
104104

105105
# Pull Requests
@@ -115,7 +115,7 @@ documentation, code comments and much more.
115115
code you're contributing to, consider opening another PR if you want to
116116
implement it yourself or file an issue so that somebody else can pick it up.
117117
- Update documentation to reflect your changes - Manual pages can be found in
118-
directory `doc`. If your changes affect Toolbox's [documentation](https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/),
118+
directory `doc`. If your changes affect Toolbx's [documentation](https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/),
119119
consider creating a PR there (but to save yourself time, you can do it
120120
after your changes are accepted), too.
121121
- After creating a PR add to the bottom of all your commits a link to the PR. This helps the future maintainers find discussions around the changes.
@@ -131,16 +131,16 @@ If it takes us a very long time to even respond to your Pull Request, you can
131131
try to @ping us at our communication channels (see section #Communication).
132132

133133
##
134-
Toolbox has a CI (Continuous Integration) setup for running tests. Their goal is to check if your
135-
changes don't affect adversely Toolbox's functionality. Sometimes these tests
134+
Toolbx has a CI (Continuous Integration) setup for running tests. Their goal is to check if your
135+
changes don't affect adversely Toolbx's functionality. Sometimes these tests
136136
mail fail with a false-positive. If you are not sure about the outcome of the
137137
tests, you can try to trigger a new test run by writing a comment with text `recheck` (really just that). If the issue persists, reach out to the maintainers!
138138

139-
Toolbox's CI system is [Zuul](https://zuul-ci.org/) hosted at [softwarefactory](https://softwarefactory-project.io/). The CI is defined using [Ansible](https://www.ansible.com) playbooks. For more information on writing Zuul jobs see their [documentation](https://zuul-ci.org/docs/zuul/reference/user.html).
139+
Toolbx's CI system is [Zuul](https://zuul-ci.org/) hosted at [softwarefactory](https://softwarefactory-project.io/). The CI is defined using [Ansible](https://www.ansible.com) playbooks. For more information on writing Zuul jobs see their [documentation](https://zuul-ci.org/docs/zuul/reference/user.html).
140140

141141
# Little Style Guide
142142

143-
Toolbox is written in [Go](https://golang.org) and uses its default set of tools
143+
Toolbx is written in [Go](https://golang.org) and uses its default set of tools
144144
including `gofmt` and `golint`.
145145

146146
Here are some good materials to learn from about the way how to write nice and

GOALS.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
### Non-goals
1515

16-
- Supporting multiple container runtimes. Toolbox will use Podman exclusively
16+
- Supporting multiple container runtimes. Toolbx will use Podman exclusively
1717
- Adding significant features on top of Podman
1818
- Significant feature requests should be driven into Podman upstream
1919
- To run containers that aren't tightly integrated with the host
@@ -26,9 +26,9 @@
2626
- Some cases: user needs root for testing
2727
- Desktop Development:
2828
- Developers need things like D-Bus, display, etc. to be forwarded into the
29-
toolbox container
29+
Toolbx container
3030
- Headless Development:
31-
- Toolbox works properly in headless environments (no display, etc)
31+
- Toolbx works properly in headless environments (no display, etc)
3232
- Need development tools like GDB, strace, etc. to work
3333

3434
### Debugging and System Management Use Cases
@@ -50,17 +50,17 @@
5050
- Fedora Silverblue
5151
- Silverblue comes with a subset of packages and discourages host software
5252
changes
53-
- Users need a toolbox container as a working environment
54-
- Future: use toolbox container by default when a user opens a shell
53+
- Users need a Toolbx container as a working environment
54+
- Future: use Toolbx container by default when a user opens a shell
5555
- Fedora CoreOS
5656
- Similar to Silverblue, but non-graphical and smaller package set
5757
- RHEL CoreOS
5858
- Similar to Fedora CoreOS. Based on RHEL content and the underlying
5959
operating system for OpenShift
6060
- Need to [use default authfile on pull](https://github.com/coreos/toolbox/pull/58/commits/413f83f7240d3c31121b557bfd55e489fad24489)
6161
- Need to ensure compatibility with the rhel7/support-tools container
62-
- Currently not a toolbox image, opportunity for collaboration
62+
- Currently not a Toolbx image, opportunity for collaboration
6363
- Alignment with `oc debug node/` (OpenShift)
6464
- `oc debug node` opens a shell on a kubernetes node
65-
- Value in having a consistent environment for both Toolbox's debugging
65+
- Value in having a consistent environment for both Toolbx's debugging
6666
mode and `oc debug node`

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
[![Arch Linux package](https://img.shields.io/archlinux/v/extra/x86_64/toolbox)](https://www.archlinux.org/packages/extra/x86_64/toolbox/)
77
[![Fedora package](https://img.shields.io/fedora/v/toolbox/rawhide)](https://src.fedoraproject.org/rpms/toolbox/)
88

9-
[Toolbox](https://containertoolbx.org/) is a tool for Linux, which allows the
9+
[Toolbx](https://containertoolbx.org/) is a tool for Linux, which allows the
1010
use of interactive command line environments for development and
1111
troubleshooting the host operating system, without having to install software
1212
on the host. It is built on top of [Podman](https://podman.io/) and other
1313
standard container technologies from [OCI](https://opencontainers.org/).
1414

15-
Toolbox environments have seamless access to the user's home directory,
15+
Toolbx environments have seamless access to the user's home directory,
1616
the Wayland and X11 sockets, networking (including Avahi), removable devices
1717
(like USB sticks), systemd journal, SSH agent, D-Bus, ulimits, /dev and the
1818
udev database, etc..
@@ -26,7 +26,7 @@ install software as (or in) containers — they mostly don't even have package
2626
managers like DNF or YUM. This makes it difficult to set up a development
2727
environment or troubleshoot the operating system in the usual way.
2828

29-
Toolbox solves this problem by providing a fully mutable container within
29+
Toolbx solves this problem by providing a fully mutable container within
3030
which one can install their favourite development and troubleshooting tools,
3131
editors and SDKs. For example, it's possible to do `yum install ansible`
3232
without affecting the base operating system.
@@ -35,12 +35,12 @@ However, this tool doesn't *require* using an OSTree based system. It works
3535
equally well on Fedora Workstation and Server, and that's a useful way to
3636
incrementally adopt containerization.
3737

38-
The toolbox environment is based on an [OCI](https://www.opencontainers.org/)
38+
The Toolbx environment is based on an [OCI](https://www.opencontainers.org/)
3939
image. On Fedora this is the `fedora-toolbox` image. This image is used to
40-
create a toolbox container that offers the interactive command line
40+
create a Toolbx container that offers the interactive command line
4141
environment.
4242

43-
Note that Toolbox makes no promise about security beyond what's already
43+
Note that Toolbx makes no promise about security beyond what's already
4444
available in the usual command line environment on the host that everybody is
4545
familiar with.
4646

@@ -49,4 +49,4 @@ familiar with.
4949

5050
See our guides on
5151
[installing & getting started](https://containertoolbx.org/install/) with
52-
Toolbox and [Linux distro support](https://containertoolbx.org/distros/).
52+
Toolbx and [Linux distro support](https://containertoolbx.org/distros/).

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
## Security and Disclosure Information Policy for the Toolbox Project
1+
## Security and Disclosure Information Policy for the Toolbx Project
22

3-
The Toolbox Project follows the
3+
The Toolbx Project follows the
44
[Security and Disclosure Information Policy](https://github.com/containers/common/blob/main/SECURITY.md)
55
for the Containers Projects.

0 commit comments

Comments
 (0)