You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug-report.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
name: Bug report
3
-
about: Toolbox's bug report template
3
+
about: Toolbx's bug report template
4
4
title: ''
5
5
labels: 1. Bug
6
6
assignees: ''
@@ -28,7 +28,7 @@ If applicable, add screenshots to help explain your problem.
28
28
**Output of `toolbox --version` (v0.0.90+)**
29
29
e.g., `toolbox version 0.0.90`
30
30
31
-
**Toolbox package info (`rpm -q toolbox`)**
31
+
**Toolbx package info (`rpm -q toolbox`)**
32
32
e.g., `toolbox-0.0.18-2.fc32.noarch`
33
33
34
34
**Output of `podman version`**
@@ -49,6 +49,6 @@ e.g., Fedora Silverblue 32
49
49
**Additional context**
50
50
Add any other context about the problem here.
51
51
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).
53
53
54
54
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>`.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1

2
2
3
-
# Contributing to Toolbox
3
+
# Contributing to Toolbx
4
4
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
6
6
interest!
7
7
8
8
# Reporting Bugs
@@ -13,7 +13,7 @@ interest!
13
13
- If the issue is already reported and is marked as **OPEN**, comment on it
14
14
and if possible and needed, share info about the issue just as if you were
15
15
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
17
17
up-to-date or if there are some steps, described in the closed issue, that
18
18
you should follow. If you are still experiencing the issue, please file a
19
19
new issue
@@ -37,14 +37,14 @@ When writing a bug report:
37
37
reproduce it.
38
38
-**Describe the behavior you received and what you expected** - Sometimes it
39
39
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
41
41
and Podman do you use?
42
42
-**Provide info about your system** - What distribution do you use? Which
43
43
desktop environment? Is it a VM or a real machine?
44
44
45
45
# Making Suggestions
46
46
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.
48
48
We are thankful for all suggestions and ideas but be ready that your suggestion
49
49
may be rejected.
50
50
@@ -63,7 +63,7 @@ may be rejected.
63
63
When writing a suggestion:
64
64
65
65
-**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
67
67
functionality or a minor tweak?
68
68
-**Provide step-by-step description of the suggested behavior** so that we
69
69
will understand.
@@ -72,13 +72,13 @@ When writing a suggestion:
72
72
73
73
# First Contribution
74
74
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)
76
76
as it's buildsystem.
77
77
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).
79
79
80
80
> 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
82
82
> config, playing with image definitions,...).
83
83
84
84
Here are some ideas of what you could contribute with:
@@ -88,18 +88,18 @@ Here are some ideas of what you could contribute with:
88
88
- Write tests - Go has [tools](https://golang.org/pkg/testing/) for writing tests.
89
89
There are also [some](https://github.com/stretchr/testify)[libraries](https://github.com/onsi/ginkgo)
90
90
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
92
92
images. Ultimately there should be a wide variety of supported distro images.
93
93
You can help with testing other people's image definitions or creating your
94
94
own. **Beware**, maintainers still don't have a clear idea of how the image
95
95
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/)
98
98
hosted by Fedora. It's not very large and could use some attention.
99
99
- Hack on the code and share the result - Seriously! Sometimes random ideas are
100
100
the best.
101
101
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
103
103
us to set it up!
104
104
105
105
# Pull Requests
@@ -115,7 +115,7 @@ documentation, code comments and much more.
115
115
code you're contributing to, consider opening another PR if you want to
116
116
implement it yourself or file an issue so that somebody else can pick it up.
117
117
- 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/),
119
119
consider creating a PR there (but to save yourself time, you can do it
120
120
after your changes are accepted), too.
121
121
- 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
131
131
try to @ping us at our communication channels (see section #Communication).
132
132
133
133
##
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
136
136
mail fail with a false-positive. If you are not sure about the outcome of the
137
137
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!
138
138
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).
140
140
141
141
# Little Style Guide
142
142
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
144
144
including `gofmt` and `golint`.
145
145
146
146
Here are some good materials to learn from about the way how to write nice and
0 commit comments