← Back to issue list

[doc] Clarify the difference between `-v` and `--verbosity` in help messages

View original Github issue

Metadata

Project
snapcraft
Number
#5097
Type
issue
State
open
Author
sed-i
Labels
Status: Triaged Type: Enhancement
Created
Updated
Closed
—

Current evaluation

Help-text clarity request: -v/--verbose vs --verbosity overlap confusingly. Triaged and acknowledged by mr-cal; fix lives upstream in craft-cli, where PR #424 was closed unmerged, so blocked on internal Canonical UX guidance.

Suggested action: keep open

Reason: The report is valid and already triaged: mr-cal confirmed "--debug and --verbosity=debug are different but --verbose and --verbosity=verbose are the same and do the same thing" and agreed the help should be clearer, and explicitly said "I'm leaving this issue open to acknowledge that it could be improved, but this isn't ready for a contribution." The help strings are not in this repo (snapcraft/cli.py only registers `-V/--version` and the hidden `-t/--trace`; the verbose/verbosity text comes from craft-cli/craft-application), so the attempted fix in canonical/craft-cli#424 was closed unmerged, leaving this blocked on internal UX guidance (SNAP-1034/1035) rather than resolved or stale.

Evaluated by: mr-cal-bot

Impact: 25 Quick Win: 5 Complexity: 40 Confidence: 87 Actionability: 35

Issue body

### What needs to get done From the output of `snapcraft <command> --help`, I can't tell the difference between: ``` -v, --verbose: Show debug information and be more verbose ``` and ``` --verbosity: Set the verbosity level to 'quiet', 'brief', 'verbose', 'debug' or 'trace' ``` I'm guessing: - `-verbose` prints debug logs to the local stdout - `--verbosity` prints various levels of logs to the remote build log file It would be handy if the use cases were clearly differentiated in the help message. ### Why it needs to get done Avoid unnecessary confusion.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 25
Quick Win: 5
Complexity: 40
Confidence: 87
Actionability: 35
keep open Help-text clarity request: -v/--verbose vs --verbosity overlap confusingly. Triaged and acknowledged by mr-cal; fix lives upstream in craft-cli, where PR #424 was closed unmerged, so blocked on internal Canonical UX guidance.
qwen/qwen3.6-35b-a3b
Impact: 30
Quick Win: 7
Complexity: 10
Confidence: 70
Actionability: 25
keep open Clarify help text difference between -v/--verbose and --verbosity flags. Upstream PR craft-cli#424 was abandoned; issue remains blocked on internal Canonical documentation guidelines.
qwen/qwen3.8-27b
Impact: 25
Quick Win: 16
Staleness: 45
Complexity: 35
Confidence: 80
Support Request: 10
keep open Clarify the confusing overlap between -v/--verbose and --verbosity in snapcraft help messages. Triaged as an enhancement; maintainer acknowledged it's valid but the help text is driven internally by Canonical and not ready for external contribution. An upstream craft-cli PR (#424) was submitted.
qwen/qwen3.6-35b-a3b
Staleness: 70
Complexity: 15
Confidence: 85
Support Request: 0
keep open Enhancement to clarify help text differences between -v/--verbose and --verbosity in snapcraft. Triaged and acknowledged by maintainers as a valid improvement, but currently internally driven and not open for external contributions.
qwen3.6-35b-a3b-mtp-q6
Staleness: 60
Complexity: 15
Confidence: 85
Support Request: 0
keep open Issue requests clarifying help text for -v/--verbose vs --verbosity flags. Triaged and acknowledged by maintainers as valid, but marked as not ready for external contribution while tracked internally.

Update history

No update history recorded yet.

Related work

  • Blocked By: canonical/craft-cli#424 (confidence 90%)

    Upstream PR 'docs(cli): clarify relationship between --verbose and --verbosity' by the would-be contributor was closed unmerged; the strings are defined in craft-cli, so no snapcraft-side change can land first.

Related issues

Issue Project State Summary Similarity
#424 docs(cli): clarify relationship between --verbose and --verbosity craft-cli closed PR #424 clarified --verbose as equivalent to --verbosity=verbose but was closed unmerged; mr-cal said internal DE028 guidance requires different wording and the effort was paused pending better internal UX guidance.
81%