Ticket #1992 (closed enhancement: Fixed)

Opened 15 months ago

Last modified 8 weeks ago

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

docbook_arg_processing.diff (4.9 kB) - added by kpg123 15 months ago.
Diff for --genxmltable feature against revision 6477

Change History

Changed 15 months ago by kpg123

Diff for --genxmltable feature against revision 6477

Changed 15 months ago by edahl

  • owner changed from edahl to ecn
  • priority changed from medium to blocker
  • component changed from All to Documentation

ECN can you get this in? Drew we can gen the examples and include them into the admin guide. Kells is this gong to be in a version that we are currently using? I think its 4.5?

Changed 14 months ago by ecn

  • status changed from new to closed
  • resolution set to fixed

(In [6923]) * fixes #1992 : generate options documentation in docbook format

Changed 14 months ago by ecn

(In [6924]) * fixes #1992 : we are using docbook 4.0

Changed 8 weeks ago by bbibeault

  • documentation set to Not required
  • reviewed set to 1
Note: See TracTickets for help on using tickets.