Ticket #7336: 7336.patch

File 7336.patch, 4.3 KB (added by viboes, 10 years ago)

Documentation fix

  • boost/thread/detail/config.hpp

     
    4343#endif
    4444#endif
    4545
    46 // Uses Boost.System by default if not stated the opposite defining BOOST_THREAD_DONT_USE_SYSTEM
    47 #if ! defined BOOST_THREAD_DONT_USE_SYSTEM && ! defined BOOST_THREAD_USES_SYSTEM
    48 #define BOOST_THREAD_USES_SYSTEM
    49 #endif
    50 
    51 // Uses Boost.Chrono by default if not stated the opposite  defining BOOST_THREAD_DONT_USE_CHRONO or BOOST_THREAD_DONT_USE_SYSTEM
    52 #if ! defined BOOST_THREAD_DONT_USE_CHRONO && ! defined BOOST_THREAD_DONT_USE_SYSTEM && ! defined BOOST_THREAD_USES_CHRONO
     46// Uses Boost.Chrono by default if not stated the opposite defining BOOST_THREAD_DONT_USE_CHRONO
     47#if ! defined BOOST_THREAD_DONT_USE_CHRONO && ! defined BOOST_THREAD_USES_CHRONO
    5348#define BOOST_THREAD_USES_CHRONO
    5449#endif
    5550

  • libs/thread/doc/overview.qbk

     
    4242
    4343The source code compiled when building the library defines a macros BOOST_THREAD_SOURCE that is used to import or export it. The user must not define this macro in any case.
    4444
     45Boost.Thread depends on some non header-only libraries.
     46
     47* Boost.System: This dependency is mandatory and you will need to link with the library.
     48
     49* Boost.Chrono: This dependency is optional (see below how to configure) and you will need to link with the library if you use some of the time related interfaces.
     50
     51* Boost.DateTime: This dependency is mandatory, but even if Boost.DateTime is a non header-only library Boost.Thread uses only parts that are header-only, so in principle you should not need to link with the library.
     52
     53It seems that there are some IDE (as e.g. Visual Studio) that deduce the libraries that a program needs to link to inspecting the sources. Such IDE could force to link to Boost.DateTime and/or Boost.Chrono.
     54
     55As the single mandatory dependency is to Boost.System, the following
     56
     57  bjam toolset=msvc-11.0 --build-type=complete --with-thread
     58
     59will install only boost_thread and boost_system.
     60
     61Users of such IDE should force the Boost.Chrono and Boost.DateTime build using
     62
     63  bjam toolset=msvc-11.0 --build-type=complete --with-thread --with-chrono --with-date_time
     64
     65
    4566The following section describes all the macros used to configure Boost.Thread.
    4667
    4768[include configuration.qbk]

  • libs/thread/doc/configuration.qbk

     
    88
    99[section:configuration Configuration]
    1010
    11 [section:system Boost.System]
    1211
    13 Boost.Thread uses by default Boost.System to define the exceptions. For backward compatibility and also for compilers that don't work well with Boost.System the user can define `BOOST_THREAD_DONT_USE_SYSTEM `.
    14 
    15 `BOOST_THREAD_USES_SYSTEM` is defined when Boost.Thread uses Boost.Move.
    16 
    17 [endsect]
    18 
    1912[section:chrono Boost.Chrono]
    2013
    21 Boost.Thread uses by default Boost.Chrono for the time related functions. For backward compatibility and also for compilers that don't work well with Boost.Chrono the user can define `BOOST_THREAD_DONT_USE_CHRONO`. If `BOOST_THREAD_DONT_USE_SYSTEM` is defined then `BOOST_THREAD_DONT_USE_CHRONO` is defined implicitly.
     14Boost.Thread uses by default Boost.Chrono for the time related functions. For backward compatibility and also for compilers that don't work well with Boost.Chrono the user can define `BOOST_THREAD_DONT_USE_CHRONO`.
    2215
    2316`BOOST_THREAD_USES_CHRONO` is defined when Boost.Thread uses Boost.Chrono.
    2417
     18
    2519[endsect]
    2620
    2721[section:move  Boost.Move]
    … …  
    2923Boost.Thread uses by default an internal move semantic implementation. Since version 3.0.0 you can use the move emulation emulation provided by Boost.Move.
    3024
    3125When `BOOST_THREAD_VERSION==2` define `BOOST_THREAD_USES_MOVE ` if you want to use Boost.Move interface.
    32 When `BOOST_THREAD_VERSION==3` define `BOOST_THREAD_DONT_USE_MOVE ` if you want to use boost::unique_future.
     26When `BOOST_THREAD_VERSION==3` define `BOOST_THREAD_DONT_USE_MOVE ` if you don't want to use Boost.Move interface.
    3327
    3428[endsect]
    3529