[boost] [Boost-bugs] [ boost-Bugs-1632327 ] [program_options] parse_config_file documentation bug

From: SourceForge.net (noreply_at_[hidden])
Date: 2007-01-10 07:56:27

Bugs item #1632327, was opened at 2007-01-10 13:56
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=107586&aid=1632327&group_id=7586

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Rodrigo Benenson (rodrigo_b)
Assigned to: Nobody/Anonymous (nobody)
Summary: [program_options] parse_config_file documentation bug

Initial Comment:
No where in the documentation the expected syntax of the config_file is mentioned.

I found on the code the comment

http://www.google.com/codesearch?hl=en&q=+file:config_file.hpp+show:Zye14269keo:YJNqZ7IaevU:1tGSWV4a4yE&sa=N&cd=4&ct=rc&cs_p=http://spirit.sourceforge.net/dl_more/program_options.zip&cs_f=boost/program_options/config_file.hpp#a0

  /** Standalone parser for config files in ini-line format:

        Config file can not contain arguments.

        - '#' is comment character: it is ignored together with
          the rest of the line.
        - variable assignments are in the form
          name '=' value.
          spaces around '=' are trimmed.
        - Section names are given in brackets.

         The actuall variable name is constructed by combining current section
         name and variable name, with dot between. If section_name already
         contains dot at the end, new dot is not inserted. For example:
         @verbatim
         [gui.accessibility]
         visual_bell=yes
         @endverbatim
         will result in option "gui.accessibility.visual_bell" with value
         "yes" been returned.
     */

Such kind of information should be on the documentation.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=107586&aid=1632327&group_id=7586

-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
Boost-bugs mailing list
Boost-bugs_at_[hidden]
https://lists.sourceforge.net/lists/listinfo/boost-bugs