Improve the wording and metadata for RBTools command options.
Review Request #6710 — Created Dec. 31, 2014 and submitted
Many of the older options for the RBTools commands had help text that was less than clear, and inferior to the wording in our documentation. In some cases, we just had too much text in one big paragraph, and in others, the options weren't as clear as they could have been. The wording for some options have been improved, and newlines have been added to break apart paragraphs. This works along with a custom help text formatter, which preserves paragraphs (as the default ones strip them away). Some additional metadata was also added to several options for extended help descriptions (matching extra information currently in the docs) and to provide meta variables and versioning information. This sets us up for the next change, which auto-generates much of the RBTools doc pages based on the information in the code, helping to keep the docs in-sync with the current state of the world.
Checked the command line output for affected commands. Everything looked
as I'd expected.Here are some snippets of the bigger changes:
--repository-url URL The URL for a repository. When generating diffs, this can be used for creating a diff outside of a working copy (currently only supported by Subversion with specific revisions or --diff-filename, and by ClearCase with relative paths outside the view). For Git, this specifies the origin URL of the current repository, overriding the origin URL supplied by the client. --svn-changelist ID Generates the diff for review based on a local changelist. [Deprecated since 0.6]
Description | From | Last Updated |
---|---|---|
I don't think this change is particularly useful. We're a web app, not a set of web pages. |
david |
- Change Summary:
-
Dropped the word "page".
- Commit:
-
42673a89c76f55e6397a115ad9f3eeadf2d77fb06d7197f3f1adc4f4e095222033afb98093fb52b0
-
Tool: Pyflakes Processed Files: rbtools/commands/status.py rbtools/commands/api_get.py rbtools/commands/__init__.py rbtools/commands/close.py rbtools/commands/patch.py rbtools/commands/post.py rbtools/commands/attach.py Tool: PEP8 Style Checker Processed Files: rbtools/commands/status.py rbtools/commands/api_get.py rbtools/commands/__init__.py rbtools/commands/close.py rbtools/commands/patch.py rbtools/commands/post.py rbtools/commands/attach.py