docs(report): enhance man pages for cargo report *
#16430
Conversation
This file contains hidden or 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
They were missing before
rustbot
added
A-cli-help
Collaborator
weihanglo
force-pushed
the
manpage-for-nested
branch
2 times, most recently
from
e08f161 to
eb13e52
Compare
rustbot
added
A-cli
epage
reviewed
Dec 24, 2025
Contributor
There was a problem hiding this comment.
How are sub-sub command man pages normally named and handled?
Do we need to update --help to call this out?
Member
Author
There was a problem hiding this comment.
docker-container-run
DOCKER(1) Docker User Manuals DOCKER(1)
NAME
docker-container-run - Create and run a new container from an image
SYNOPSIS
docker container run [OPTIONS] IMAGE [COMMAND] [ARG...]
DESCRIPTION
Alias for docker run.
OPTIONS
--add-host= Add a custom host-to-IP mapping (host:ip)
--annotation=map[] Add an annotation to the container (passed through to
the OCI runtime)
-a, --attach= Attach to STDIN, STDOUT or STDERR
podman-machine-start
https://docs.podman.io/en/latest/markdown/podman-machine-start.1.html
Member
Author
There was a problem hiding this comment.
Do we need to update --help to call this out?
Yes, but cargo help hasn't yet supported it, and I am not sure whether cargo help report-timings makes more sense or cargo help report timings (mind the dash).
Member
Author
There was a problem hiding this comment.
Also, adding the support to cargo help for sub-sub commands may need FCP. This PR doesn't I think, at least it still provides the HTML docs
Except in diagnostics, we use `future-incompat` the alias more often, and it is also easier to type correctly. Make it the primary name than an alias
weihanglo
force-pushed
the
manpage-for-nested
branch
from
eb13e52 to
d34d267
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What does this PR try to resolve?
Make space for future report kinds iun
cargo reportdocumentations.cargo reportman page didn't match its--helptext equivalentreport future-incompatthe primary name instead of an alias.cargo report future-incompatdidn't have its own man page.Note that
cargo helphasn't yet supported forfuture-incompat.It will be a separate PR.
How to test and review this PR?