[Boost-bugs] [Boost C++ Libraries] #3929: Property.tree - outdated "Five Minute Tutorial"

Subject: [Boost-bugs] [Boost C++ Libraries] #3929: Property.tree - outdated "Five Minute Tutorial"
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2010-02-14 08:14:19

#3929: Property.tree - outdated "Five Minute Tutorial"
--------------------------------------------------------+-------------------
 Reporter:  Sergey Voropaev <Serge-Voropaev@…>          |       Owner:  cornedbee    
     Type:  Bugs                                        |      Status:  new          
Milestone:  Boost 1.43.0                                |   Component:  property_tree
  Version:  Boost 1.42.0                                |    Severity:  Problem      
 Keywords:                                              |  
--------------------------------------------------------+-------------------
 The documentation of "Property tree" does not correspond current version
 of library:

 1)"Five Minute Tutorial"
 ([http://www.boost.org/doc/libs/1_42_0/doc/html/boost_propertytree/tutorial.html]).
 It is not possible to compile function save(). The problem line is:
 {{{
 .........
       pt.put("debug.modules.module", name, true);
 ........
 }}}

 2) I built and ran example '''debug_settings.cpp'''
 ([http://www.boost.org/doc/libs/1_42_0/libs/property_tree/examples/debug_settings.cpp]).
 The input file (debug_settings.xml) is not equal to output file
 (debug_settings_out.xml).

 As far as understand, library was changed in last version. Specifically,
 function '''put''' was changed and new function '''add''' was introduced.
 But "Five Minute Tutorial" was not updated. But, ironically,
 '''debug_settings.cpp''' was changed by commenting line with '''put'''
 function.

 As result, I spend a lot of time to make the first steps with this
 library.

 My suggestions:[[BR]]
 1) Update "Five Minute Tutorial" to current version of library. Explain
 difference between put and add functions.[[BR]]
 2) Update example. [[BR]]
 3) Expand "Five Minute Tutorial" to more complex usage of library. Or add
 new chapter to documentation with examples of usage.

 Best regards

 Sergey Voropaev

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/3929>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.