Re: conf vars in manual

[Patrice Dumas]

On Fri, Aug 10, 2012 at 01:03:32AM +0000, Karl Berry wrote:
> Patrice,
> 
> Would it be feasible to dump out a list of all the conf vars?  Or all
> that should be documented, if that's different?

That would be rather easy, they even are already grouped in relevant
groups.  I explain the groups below, tell me how you want that I 
output them.


document_settable_at_commands: commands that can also be set with
@-commands in the document and may appear more than once. Documented
in 'Configuration Variables for @@-Commands'

document_settable_unique_at_commands: commands that can also be set with 
@-commands in the document and should appear only once in a document
Documented in 'Configuration Variables for @@-Commands'

command_line_settables: customization options that have an associated 
command-line option (although I don't have the association itself)
Documented in 'Configuration variables for options'

parser_options: structures that are passed to the parser directly and
that are more or less parser stuff that are used to describe
Texinfo features/state/processing.  These are documented in the 
Texinfo::Parser in Pod, and I think they should not be documented in the 
main Texinfo manual, only in Pod.  The therefore appear in the Texinfo
manual automatically generated in doc/tp_api/tp_api.texi


obsolete_variables/variable_settables_not_used: should not be documented

formats_settable: described in 'Configuration Variables for Program
Behavior'; they change the format output 

variable_string_settables: remaining customization variables that are 
strings and therefore can be set on the command line, documented in 'Other
Configuration Variables'

variable_other_settables: remaining customization variables that are
not strings (hashes and arrays), and therefore can only be set in init
files.  Not documented for now, should be documented along with the HTML
customization API once it is documented.



-- 
Pat