Skip to content

Conversation

jyn514
Copy link

@jyn514 jyn514 commented Aug 19, 2025

Fixes #2658

@digit-google
Copy link
Contributor

I'd prefer not to document all tool options in the manual, just add a line that says that each tool may have custom options that change its behavior, and to call it with --help to see details.

Technically, this PR is missing a lot of other tool options anyway. Plus since some options are added over time, this makes phrases like "Available since Ninja 1.12" incomplete / misleading anyway in general, unless one wants to document it for every tool option. This would be a needless maintenance burden.

@jyn514
Copy link
Author

jyn514 commented Aug 19, 2025

I'd prefer not to document all tool options in the manual, just add a line that says that each tool may have custom options that change its behavior, and to call it with --help to see details.

unfortunately --help doesn't work for all tools:

$ ninja -t cleandead --help
Cleaning... 1 files.

so we'd have to document which tools support --help, which doesn't seem like any less of a burden.

since some options are added over time, this makes phrases like "Available since Ninja 1.12" incomplete / misleading anyway in general, unless one wants to document it for every tool option.

maybe we can put a note at the top of the section that "Available since" is only about the tool itself, not its options? i agree that documenting when options were introduced would be a maintenance burden.

@digit-google
Copy link
Contributor

Good point. I'd be in favor of adding --help support to all tools instead, except maybe the urtle one ;-)

@jyn514
Copy link
Author

jyn514 commented Aug 19, 2025

OMG that's a good tool

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ninja -t helpers are inconsistent about whether filenames are quoted
2 participants