fix copy command examples format #4125
Conversation
olamilekan000
commented
Oct 2, 2025
olamilekan000
commented
olamilekan000
force-pushed
the
fix-copy-cmd-title-docs
branch
2 times, most recently
from
2a1e16b to
a85485f
Compare
Signed-off-by: olalekan odukoya <[email protected]>
olamilekan000
force-pushed
the
fix-copy-cmd-title-docs
branch
from
a85485f to
cac8909
Compare
| limactl copy file1.txt file2.txt default:/tmp/ | ||
| #### Copy multiple files | ||
| limactl copy file1.txt file2.txt default:/tmp/ | ||
There was a problem hiding this comment.
The output of --help isn't expected to be markdown.
The rendering issue should be better resolved in https://github.com/lima-vm/lima/blob/master/cmd/limactl/gendoc.go
There was a problem hiding this comment.
We could wrap the whole help text in a code block, but that would not be so easy to read either?
But escaping the newlines and the # characters would be nice, so that they are not mis-interpreted...
There was a problem hiding this comment.
Something like this: (line breaks with two spaces before newline , escape the comments with \#)
Backends:
auto - Automatically selects the best available backend (rsync preferred, falls back to scp)
rsync - Uses rsync for faster transfers with resume capability (requires rsync on both host and guest)
scp - Uses scp for reliable transfers (always available)
Examples:
# Copy file from guest to host (auto backend)
limactl copy default:/etc/os-release .
Instead of this: https://lima-vm.io/docs/reference/limactl_copy/
There was a problem hiding this comment.
There was a problem hiding this comment.
After fixing the markdown, I found out that the examples were in the wrong place (or it would have been escaped automatically)... But it is still good to fix the output of other commands, to escape the markdown.
There was a problem hiding this comment.
Just seeing that the intension behind this PR has been adressed. Thanks @afbjorklund
I'll be closing this.
