Skip to content

Conversation

@weihanglo
Copy link
Member

@weihanglo weihanglo commented Dec 23, 2025

What does this PR try to resolve?

Make space for future report kinds iun cargo report documentations.

  • A new sub-section of "report commands" in the Cargo book.
  • Fixed that cargo report man page didn't match its --help text equivalent
  • ‼️ Make report future-incompat the primary name instead of an alias.
  • cargo report future-incompat didn't have its own man page.

Note that cargo help hasn't yet supported for future-incompat.
It will be a separate PR.

How to test and review this PR?

mdbook serve src/doc
target/debug/cargo help report

@rustbot rustbot added A-cli-help Area: built-in command-line help A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 23, 2025
@rustbot
Copy link
Collaborator

rustbot commented Dec 23, 2025

r? @epage

rustbot has assigned @epage.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@weihanglo weihanglo force-pushed the manpage-for-nested branch 2 times, most recently from e08f161 to eb13e52 Compare December 24, 2025 03:31
@rustbot rustbot added A-cli Area: Command-line interface, option parsing, etc. A-future-incompat Area: future incompatible reporting Command-report labels Dec 24, 2025
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How are sub-sub command man pages normally named and handled?

Do we need to update --help to call this out?

Copy link
Member Author

@weihanglo weihanglo Dec 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-cli Area: Command-line interface, option parsing, etc. A-cli-help Area: built-in command-line help A-documenting-cargo-itself Area: Cargo's documentation A-future-incompat Area: future incompatible reporting Command-report S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants