Ticket #1992 (closed enhancement: Fixed)
Daemons should generate Docbook output of command switches
| Reported by: | kpg123 | Owned by: | ecn |
|---|---|---|---|
| Priority: | 1 - Blocker | Milestone: | zenoss-2.1 |
| Component: | Documentation | Version: | 2.0.4 |
| Keywords: | contribute | Cc: | |
| Community Patch Attached: | Deployed @ Customer: | ||
| Installer: | Maintenance Target: | ||
| Specific ZenPack: | Maintenance Status: | ||
| Documentation Note?: | Not required | Regression: |
Description
The attached svn diff output updates the work on the 'genconf' feature to automatically produce a Docbook table with the command-line switches of the daemon. It also updates the bin/zenfunctions file to include a new 'genxmltable' option so that, for example, someone can type:
zenwin --genxmltable > options_zenwin.xml
Features of the XML output:
- Creates an indexterm for ease of automatic indexing
- Creates an xml:id of <daemon>.options
- For non-boolean options, shows the 'dest' of the optionParser option
As a total aside, the command-line switches for zenwin appear to be missing from the Admin Guide. :)
To Do:
- Doesn't process the optionParser 'choices' type or either the template file or for Docbook output. Since none of the Daemons currently use 'choice' types, this is mentioned only for completeness.
- Need to go through all of the daemons and clean up the option help text to be more descriptive, and possibly remove 'default' information. The default information may need more clever handling to preserve command-line friendliness, perhaps by enforcing a convention that option help, if reporting default values, must have the syntax "Default: " in the string.
Attachments
Change History
Note: See
TracTickets for help on using
tickets.