Add a note to the README about the name change#1717
Add a note to the README about the name change#1717debarshiray merged 1 commit intocontainers:mainfrom
Conversation
7d60ca7 to
fed1184
Compare
|
Build succeeded. ✔️ unit-test SUCCESS in 2m 12s |
debarshiray
left a comment
There was a problem hiding this comment.
Thanks for working on the note, @ernstki ! Some minor nit-picky comments:
README.md
Outdated
| > update the old name to the new in various places, thus the name of the | ||
| > package and the binary may still be `toolbox` on various systems. | ||
| > | ||
| > If you'd like to help, see the commit log for [45a9b40][] for a to-do list. |
There was a problem hiding this comment.
The commit is c3403dae8cb0544e. I wonder where the 45a9b40 hash comes from.
There was a problem hiding this comment.
An old, merged commit which I noted from the activity stream in #1399, that's all. There is an angry yellow banner that the commit is not part of any branch, but sadly, banner blindness is a thing.
README.md
Outdated
| > | ||
| > The namespace change was undertaken for better discoverability, and "Toolbx" | ||
| > with a capital "T" is now considered canonical; see [issue #1399][iss1399] | ||
| > for a discussion. |
There was a problem hiding this comment.
I would drop the second part about the discussion, because:
-
It might encourage people to continue discussing this topic, and doing that will take away time that can be devoted to finishing the rename or reviewing the pending PRs or addressing the open issues, etc..
-
The longer the note about the name, the more it pushes down the paragraphs about what Toolbx containers have access to and the security expectations around them, and some folks are really sensitive about that. :/
There was a problem hiding this comment.
Seems fine. This was just a shot in the dark, and I was counting on feedback. I myself, being somewhat constitutionally anxious about spelling and pronouncing things correctly, actually like those FAQ entries on project homepages which clarify spellings, pronunciations, and the origins of names. Hence, this blurb.
README.md
Outdated
| > [!NOTE] | ||
| > **Toolbx's original name was "toolbox".** Work is still in progress to | ||
| > update the old name to the new in various places, thus the name of the | ||
| > package and the binary may still be `toolbox` on various systems. |
There was a problem hiding this comment.
The binary is still called toolbox, not may still be. It is one of the most visible obstacles. :)
There was a problem hiding this comment.
More so the package name, which is "still" podman-toolbox for Debian/Ubuntu, and that might change some day. I defer to your judgement.
There was a problem hiding this comment.
Yes, you are right. The package names are probably all still toolbox with an o in some form. I say probably only because it's not something that this upstream project can enforce, so in theory some distribution might have renamed it to toolbx.
91b84ae to
0ad4b55
Compare
containers/containertoolbx.org#1 containers#1399 Signed-off-by: Kevin Ernst <ernstki@mail.uc.edu>
0ad4b55 to
9b38e21
Compare
|
I took the liberty to tweak the text of the note a bit. I'll merge once the CI turns green. |
|
Build succeeded. ✔️ unit-test SUCCESS in 2m 16s |
|
@debarshiray This appears at one of the main focal points for the project — your baby — so being selective about the wording makes perfect sense. Thanks for the feedback, and for making the necessary changes. I think the moral of the story is naming things is hard. |
|
Merged.
You're welcome and thanks for stopping by! |
Closes #1399.
See also containers/containertoolbx.org#1.