doc: Match man pages with Go Toolbox and extend them #512
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Build failed.
|
HarryMichal
force-pushed
the
extend-manual-pages
branch
from
0cb1015 to
dca19b3
Compare
|
Build failed.
|
debarshiray
reviewed
Jan 7, 2021
debarshiray
reviewed
Jan 22, 2021
doc/toolbox-create.1.md
Outdated
| locally customized for the current user to create a second image, from which | ||
| the container is finally created. | ||
| A toolbox container is an OCI container created from an OCI image. Therefore, | ||
| `toolbox create` is analogous to `podman build` executed with specific options. |
There was a problem hiding this comment.
Did you really mean podman build? Or was it meant to be podman create?
doc/toolbox-create.1.md
Outdated
| Toolbox containers are primarily created in a way to be tightly integrated with | ||
| the host system. They are not meant to be secure. | ||
|
|
||
| ### Options passed to podman build |
There was a problem hiding this comment.
This should definitely be podman create. :)
debarshiray
reviewed
Jan 22, 2021
debarshiray
reviewed
Jan 22, 2021
doc/toolbox-list.1.md
Outdated
|
|
||
| ## DESCRIPTION | ||
|
|
||
| Lists existing toolbox containers and images. These are OCI containers and | ||
| images, which can be managed directly with tools like `buildah` and `podman`. | ||
|
|
||
| Listed information about images: |
There was a problem hiding this comment.
Let's wait a bit before we go too much into this part, because it will be influenced by #579
debarshiray
reviewed
Jan 25, 2021
debarshiray
reviewed
Jan 25, 2021
HarryMichal
force-pushed
the
extend-manual-pages
branch
from
dca19b3 to
1119e7f
Compare
|
Build succeeded.
|
HarryMichal
added
the
2. Documentation
HarryMichal
added a commit
to HarryMichal/toolbox
that referenced
this pull request
May 24, 2021
- Update "See also" sections Toolbox does not use Buildah for a considerable time now[0]. We can stop referencing it in the "See also" sections of the documentation. In some places mention podman command man pages where they are relevant. - Add section about toolbox images/containers Toolbox only supports certain OCI images. These should be documented. Also, document the change of fedora-toolbox image name. - Add a section about toolbox container setup Toolbox containers are specifically configured OCI containers. This should be documented so that users know what they're using. - Remove redundant part documentation The description of what `toolbox init-container` does is already in toolbox-init-container(1). There's no need to have it in toolbox-create(1). Instead, replace the text with a hint to visit the other part of documentation. - Clarify behaviour of --image option The fact that Toolbox by default tries to pull from the Fedora registry[1] should be noted. - Update synopsis & description of commands Mention options passed to `podman exec`. Remove redundant paragraph about container names (is already dealt with in toolbox-create(1)). There's no need to mention the name of the default container on Fedora since Toolbox now also supports RHEL. Mention the default used image on unrecognised systems. Emphasize the fact that toolboxes are not a fully sandboxed environment. Update the wording of the description and splits it into a few subsections. The description of the --monitor-host was inaccurate and while the option will go away in the future[2], it is currently in and should be more documented. [0] containers#160 [1] https://registry.fedoraproject.org [2] containers#617 containers#512
HarryMichal
force-pushed
the
extend-manual-pages
branch
from
1119e7f to
f349ba0
Compare
- Update "See also" sections Toolbox does not use Buildah for a considerable time now[0]. We can stop referencing it in the "See also" sections of the documentation. In some places mention podman command man pages where they are relevant. - Add section about toolbox images/containers Toolbox only supports certain OCI images. These should be documented. Also, document the change of fedora-toolbox image name. - Add a section about toolbox container setup Toolbox containers are specifically configured OCI containers. This should be documented so that users know what they're using. - Remove redundant part documentation The description of what `toolbox init-container` does is already in toolbox-init-container(1). There's no need to have it in toolbox-create(1). Instead, replace the text with a hint to visit the other part of documentation. - Clarify behaviour of --image option The fact that Toolbox by default tries to pull from the Fedora registry[1] should be noted. - Update synopsis & description of commands Mention options passed to `podman exec`. Remove redundant paragraph about container names (is already dealt with in toolbox-create(1)). There's no need to mention the name of the default container on Fedora since Toolbox now also supports RHEL. Mention the default used image on unrecognised systems. Emphasize the fact that toolboxes are not a fully sandboxed environment. Update the wording of the description and splits it into a few subsections. The description of the --monitor-host was inaccurate and while the option will go away in the future[2], it is currently in and should be more documented. [0] containers#160 [1] https://registry.fedoraproject.org [2] containers#617 containers#512
HarryMichal
force-pushed
the
extend-manual-pages
branch
from
f349ba0 to
79e7876
Compare
debarshiray
reviewed
Jun 26, 2021
|
Fix-ups in #814 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The manual pages were not updated for quite some time already. Several parts are not relevant anymore (e.g., mentions of 'candidate registry') and some could be more accurate/more elaborate.
I mainly expanded toolbox(1), toolbox-create(1) and toolbox-init-container(1) where I tried to explain more of the philosophy of toolbox containers/images, what defines them, what makes them different than common OCI containers/images.