Jump to: navigation, search

Difference between revisions of "Blueprint-evolution-of-autogenerate-config-docs"

(Current limitations)
(Current limitations and problems)
Line 12: Line 12:
 
=== Current limitations and problems ===
 
=== Current limitations and problems ===
  
* The sections are not shown at all
+
* The filenames, and sections within them are not shown at all
 
* We need to be able to show the same option in different tables for shared options
 
* We need to be able to show the same option in different tables for shared options
 
* Options with the same name - but specified in different tables - will show up as duplicated entries in a table.
 
* Options with the same name - but specified in different tables - will show up as duplicated entries in a table.

Revision as of 08:49, 7 October 2013

Overview

The current autogenerate tools have a couple of limitations and we need to improve the tool to handle all current uses in the manuals. We should also evaluate switching to generator.py from oslo-incubator - and enhancing that tool.

Blueprint

Current limitations and problems

  • The filenames, and sections within them are not shown at all
  • We need to be able to show the same option in different tables for shared options
  • Options with the same name - but specified in different tables - will show up as duplicated entries in a table.

Using generator.py from oslo-incubator

New format for generated tables

The tables should additionally contain the section, for example [DEFAULT]

Related bug reports