[BUG] --help text does not contain what values --out accepts
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
salt --help output documents the --out option. However, it does not list what values are acceptable to --out.
Also affects salt-call, salt-cloud, salt-cp, salt-key, salt-run
Setup
Any setup. We are on:
salt --version
salt 3005
Steps to Reproduce the behavior
salt --help
[.... text elided ... ]
--out=OUTPUT, --output=OUTPUT
Print the output from the 'salt' command using the
specified outputter.
[.... text elided ... ]
Expected behavior
--out=OUTPUT, --output=OUTPUT
Print the output from the 'salt' command using the
specified outputter.
Accepted outputters are 'txt', 'json', 'raw', 'foo', 'bar', 'mumble' (I don't know the exact list from memory)
My apologies if I've misfiled this against code instead of DOC - to me DOC is the website stuff.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running salt --help and the corresponding help commands for salt-call, salt-cloud, salt-cp, salt-key, and salt-run, then trace where their --out/--output help text is defined. Done means each command documents the accepted outputter values consistently in its help output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100