Cleaned up formatting/typesetting.#3163
Cleaned up formatting/typesetting.#3163thaJeztah merged 3 commits intodocker:masterfrom KGB33:923_cleanup_docker_container_attach_man
Conversation
Changed backticks to bold/italics, removed angle brackets. Signed-off-by: Kelton Bassingthwaite <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #3163 +/- ##
=======================================
Coverage 57.09% 57.09%
=======================================
Files 299 299
Lines 18731 18731
=======================================
Hits 10695 10695
Misses 7166 7166
Partials 870 870 |
SIGKILL is a literal and bolded in other documentation, such as https://man7.org/linux/man-pages/man7/signal.7.html. Signed-off-by: Kelton Bassingthwaite <[email protected]>
The previous example was out of date. I changed the distro & pined the tag to help prevent the new example from becoming out of date too. Signed-off-by: Kelton Bassingthwaite <[email protected]>
|
I tested out the example and ran into an error: ID=$(sudo docker run -d fedora /usr/bin/top -b)
docker: Error response from daemon: failed to create shim: OCI runtime create failed: container_linux.go:380: starting container process caused: exec: "/usr/bin/top": stat /usr/bin/top: no such file or directory: unknown.Changing fedora to ubuntu solved the issue without changing it too much. I also pinned the ubuntu tag to help prevent another issue from happening in the future. |
StefanScherer
left a comment
StefanScherer
left a comment
There was a problem hiding this comment.
Thanks @KGB33 for the contribution.
Could you explain why the formatting change is needed?
I can see that we have many similar man pages and they look good to me as they are. 🤔
Indeed, the fedora image does not contain top command, but eg. alpine does or as you mentioned the ubuntu image as well.
StefanScherer
left a comment
StefanScherer
left a comment
There was a problem hiding this comment.
Thank you @KGB33 for your contribution.
Thanks for the explanation, yes making small PR's make sense.
LGTM
4 participants
Changed backticks to bold/italics, removed angle brackets.
Updated
cli/man/src/container/attach.mdto match formatting specified in #923By changing in-line code i.e. backticks, to bold (for literals) and italics (for variables).