Skip to content

docs: point the changeme error at cvs man, add browse-config-parameters guide - #345

Open
speriaswamy-amd wants to merge 1 commit into
speriaswamy/cvsman-11-man-pluginfrom
speriaswamy/cvsman-12-docs-wiring
Open

docs: point the changeme error at cvs man, add browse-config-parameters guide#345
speriaswamy-amd wants to merge 1 commit into
speriaswamy/cvsman-11-man-pluginfrom
speriaswamy/cvsman-12-docs-wiring

Conversation

@speriaswamy-amd

Copy link
Copy Markdown
Contributor

Part 12 of 14 in a stack for AIMVT-276.
Base: #344.

Why

cvs man now exists, but nothing yet points users at it: the runtime error
for unresolved <changeme> placeholders is silent about it, there's no
how-to guide, and README.md's --help paste and test_cli.sh's smoke
tests predate the command entirely.

What changed

  • cvs/lib/utils_lib.py: the <changeme> error message now suggests
    cvs man <test>.
  • Added docs/how-to/browse-config-parameters.rst and registered it in
    docs/index.rst / docs/sphinx/_toc.yml.in.
  • Refreshed README.md's stale --help paste.
  • Added cvs man smoke tests to test_cli.sh.

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.

1 participant