From d9ec475d945d3035377a0d89ed42e382d8988891 Mon Sep 17 00:00:00 2001 From: DongHun Kwak Date: Thu, 6 Oct 2016 10:33:54 +0900 Subject: Imported Upstream version 1.60.0 Change-Id: Ie709530d6d5841088ceaba025cbe175a4ef43050 Signed-off-by: DongHun Kwak --- doc/html/bbv2/reference.html | 228 +++++++++++++++++++++---------------------- 1 file changed, 114 insertions(+), 114 deletions(-) (limited to 'doc/html/bbv2/reference.html') diff --git a/doc/html/bbv2/reference.html b/doc/html/bbv2/reference.html index 42a6602938..54574d19bb 100644 --- a/doc/html/bbv2/reference.html +++ b/doc/html/bbv2/reference.html @@ -6,7 +6,7 @@ - + @@ -260,7 +260,7 @@ path-constant DATA : data/a.txt ;

This section documents the features that are built-in into Boost.Build. For features with a fixed set of values, that set is provided, with the default value listed first.

-
+
variant

@@ -605,7 +605,7 @@ path-constant DATA : data/a.txt ;

embed-manifest
-

+

Allowed values: on, off.

This feature is specific to the msvc toolset (see @@ -618,7 +618,7 @@ path-constant DATA : data/a.txt ;

embed-manifest-file
-

This feature is specific to the msvc toolset (see +

This feature is specific to the msvc toolset (see the section called “Microsoft Visual C++”), and controls which manifest files should be embedded inside executables and shared libraries. This @@ -633,8 +633,8 @@ path-constant DATA : data/a.txt ; Builtin tools

Boost.Build comes with support for a large number of C++ compilers, and other tools. This section documents how to use those tools.

@@ -723,7 +723,7 @@ using gcc : [version be either windres for msvc resource compiler, or rc for borland's resource compiler.

- + In order to compile 64-bit applications, you have to specify address-model=64, and the instruction-set @@ -740,7 +740,7 @@ using gcc : [version to that of the gcc module.

- + The darwin toolset can generate so called "fat" binaries—binaries that can run support more than one architecture, or address mode. To build a binary that can run both @@ -850,7 +850,7 @@ using msvc : [version

64-bit support
-

Starting with version 8.0, Microsoft Visual Studio can +

Starting with version 8.0, Microsoft Visual Studio can generate binaries for 64-bit processor, both 64-bit flavours of x86 (codenamed AMD64/EM64T), and Itanium (codenamed IA64). In addition, compilers that are itself run in 64-bit mode, for better @@ -897,7 +897,7 @@ using msvc : [version

Windows Runtime support
-

+

Starting with version 11.0, Microsoft Visual Studio can produce binaries for Windows Store and Phone in addition to traditional Win32 desktop. To specify which Windows API set @@ -1226,7 +1226,7 @@ using sun : [version

Specifies additional command line options that will be passed to the linker.

- + Starting with Sun Studio 12, you can create 64-bit applications by using the address-model=64 property. @@ -1251,7 +1251,7 @@ using vacpp ;

-Third-party libraries

+Third-party libraries
STLport library
zlib
@@ -1261,7 +1261,7 @@ using vacpp ;
STLport library
-

The STLport library +

The STLport library is an alternative implementation of C++ runtime library. Boost.Build supports using that library on Windows platfrom. Linux is hampered by different naming of libraries in each STLport @@ -1290,7 +1290,7 @@ using stlport : [version

zlib
-

Provides support for the +

Provides support for the zlib library. zlib can be configured either to use precompiled binaries or to build the library from source.

@@ -1340,7 +1340,7 @@ using zlib : 1.2.7 : : <toolset>gcc ;

-Documentation tools

+Documentation tools
xsltproc
boostbook
@@ -1354,7 +1354,7 @@ using zlib : 1.2.7 : : <toolset>gcc ;
xsltproc
-

To use xsltproc, you first need to configure it using the following syntax:

+

To use xsltproc, you first need to configure it using the following syntax:

 using xsltproc : [xsltproc] ;
 
@@ -1402,7 +1402,7 @@ rule xslt-dir ( target : source stylesheet : properties * : dirname )
boostbook
-

To use boostbook, you first need to configure it using the following syntax:

+

To use boostbook, you first need to configure it using the following syntax:

 using boostbook : [docbook-xsl-dir] : [docbook-dtd-dir] : [boostbook-dir] ;
 
@@ -1456,7 +1456,7 @@ rule boostbook ( target-name : sources * : requirements * : default-build * )
doxygen
-

To use doxygen, you first need to configure it using the following syntax:

+

To use doxygen, you first need to configure it using the following syntax:

 using doxygen : [name] ;
 
@@ -1515,7 +1515,7 @@ rule doxygen ( target : sources * : requirements * : default-build * : usage-req
quickbook
-

The quickbook module provides a generator to convert from +

The quickbook module provides a generator to convert from Quickbook to BoostBook XML.

To use quickbook, you first need to configure it using the following syntax:

@@ -1531,7 +1531,7 @@ using quickbook : [command<
 
fop
-

The fop module provides generators to convert from +

The fop module provides generators to convert from XSL formatting objects to Postscript and PDF.

To use fop, you first need to configure it using the following syntax:

@@ -1568,7 +1568,7 @@ using fop : [fop-command
 

modules

-

+

The modules module defines basic functionality for handling modules.

@@ -1618,7 +1618,7 @@ using fop : [fop-command
  1. -rule binding ( module-name )

    Returns the filesystem binding of the given module.

    +rule binding ( module-name )

    Returns the filesystem binding of the given module.

    For example, a module can get its own location with:

    me = [ modules.binding $(__name__) ] ;
    @@ -1626,7 +1626,7 @@ using fop : [fop-command
  2. -rule poke ( module-name ? : variables + : value * )

    Sets the module-local value of a variable.

    +rule poke ( module-name ? : variables + : value * )

    Sets the module-local value of a variable.

    For example, to set a variable in the global module:

    modules.poke : ZLIB_INCLUDE : /usr/local/include ;
    @@ -1634,7 +1634,7 @@ using fop : [fop-command
  3. -rule peek ( module-name ? : variables + )

    Returns the module-local value of a variable.

    +rule peek ( module-name ? : variables + )

    Returns the module-local value of a variable.

    For example, to read a variable from the global module:

    @@ -1643,7 +1643,7 @@ using fop : [fop-command
  4. -rule call-in ( module-name ? : rule-name args * : * )

    Call the given rule locally in the given module. Use +rule call-in ( module-name ? : rule-name args * : * )

    Call the given rule locally in the given module. Use this for rules accepting rule names as arguments, so that the passed rule may be invoked in the context of the rule's caller (for example, if the rule accesses module globals or @@ -1678,7 +1678,7 @@ using fop : [fop-command

  5. -rule load ( module-name : filename ? : search * )

    Load the indicated module if it is not already loaded.

    +rule load ( module-name : filename ? : search * )

    Load the indicated module if it is not already loaded.

    module-name

    Name of module to load.

    @@ -1694,7 +1694,7 @@ using fop : [fop-command
  6. -rule import ( module-names + : rules-opt * : rename-opt * )

    Load the indicated module and import rule names into the +rule import ( module-names + : rules-opt * : rename-opt * )

    Load the indicated module and import rule names into the current module. Any members of rules-opt will be available without qualification in the caller's module. Any members of rename-opt will be taken as the names @@ -1723,7 +1723,7 @@ import path : native make :

  7. -rule clone-rules ( source-module target-module )

    Define exported copies in $(target-module) +rule clone-rules ( source-module target-module )

    Define exported copies in $(target-module) of all rules exported from $(source-module). Also make them available in the global module with qualification, so that it is just as though the rules were defined originally @@ -1734,7 +1734,7 @@ import path : native make :

    path

    -

    +

    Performs various path manipulations. Paths are always in a 'normalized' representation. In it, a path may be either: @@ -1753,25 +1753,25 @@ import path : native make :

    1. -rule make ( native )

      Converts the native path into normalized form.

      +rule make ( native )

      Converts the native path into normalized form.

    2. -rule native ( path )

      Builds the native representation of the path.

      +rule native ( path )

      Builds the native representation of the path.

    3. -rule is-rooted ( path )

      Tests if a path is rooted.

      +rule is-rooted ( path )

      Tests if a path is rooted.

    4. -rule has-parent ( path )

      Tests if a path has a parent.

      +rule has-parent ( path )

      Tests if a path has a parent.

    5. -rule basename ( path )

      Returns the path without any directory components.

      +rule basename ( path )

      Returns the path without any directory components.

    6. -rule parent ( path )

      Returns the parent directory of the path. If no parent exists, an error is issued.

      +rule parent ( path )

      Returns the parent directory of the path. If no parent exists, an error is issued.

    7. -rule reverse ( path )

      +rule reverse ( path )

      Returns path2 such that [ join path path2 ] = ".". The path may not contain ".." @@ -1779,23 +1779,23 @@ import path : native make :

    8. -rule join ( elements + )

      +rule join ( elements + )

      Concatenates the passed path elements. Generates an error if any element other than the first one is rooted. Skips any empty or undefined path elements.

    9. -rule root ( path root )

      +rule root ( path root )

      If path is relative, it is rooted at root. Otherwise, it is unchanged.

    10. -rule pwd ( )

      Returns the current working directory.

      +rule pwd ( )

      Returns the current working directory.

    11. -rule glob ( dirs * : patterns + : exclude-patterns * )

      +rule glob ( dirs * : patterns + : exclude-patterns * )

      Returns the list of files matching the given pattern in the specified directory. Both directories and patterns are supplied as portable paths. Each pattern should be a non-absolute path, and can't contain "." or ".." elements. @@ -1820,7 +1820,7 @@ import path : native make :

    12. -rule glob-tree ( roots * : patterns + : exclude-patterns * )

      +rule glob-tree ( roots * : patterns + : exclude-patterns * )

      Recursive version of glob. Builds the glob of files while also searching in the subdirectories of the given roots. An optional set of exclusion patterns @@ -1830,10 +1830,10 @@ import path : native make :

    13. -rule exists ( file )

      Returns true if the specified file exists.

      +rule exists ( file )

      Returns true if the specified file exists.

    14. -rule all-parents ( path : upper_limit ? : cwd ? )

      +rule all-parents ( path : upper_limit ? : cwd ? )

      Find out the absolute name of path and return the list of all the parents, starting with the immediate one. Parents are returned as relative names. If upper_limit is specified, directories above it @@ -1841,7 +1841,7 @@ import path : native make :

    15. -rule glob-in-parents ( dir : patterns + : upper-limit ? )

      +rule glob-in-parents ( dir : patterns + : upper-limit ? )

      Search for patterns in parent directories of dir, up to and including upper_limit, if it is specified, or @@ -1849,23 +1849,23 @@ import path : native make :

    16. -rule relative ( child parent : no-error ? )

      +rule relative ( child parent : no-error ? )

      Assuming child is a subdirectory of parent, return the relative path from parent to child.

    17. -rule relative-to ( path1 path2 )

      Returns the minimal path to path2 that is relative path1.

      +rule relative-to ( path1 path2 )

      Returns the minimal path to path2 that is relative path1.

    18. -rule programs-path ( )

      +rule programs-path ( )

      Returns the list of paths which are used by the operating system for looking up programs.

    19. -rule makedirs ( path )

      +rule makedirs ( path )

      Creates a directory and all parent directories that do not already exist.

      @@ -1875,7 +1875,7 @@ import path : native make :

      regex

      -

      +

      Contains rules for string processing using regular expressions.

        @@ -1924,7 +1924,7 @@ import path : native make :
      1. -rule split ( string separator )

        Returns a list of the following substrings: +rule split ( string separator )

        Returns a list of the following substrings:

        1. from beginning till the first occurrence of @@ -1942,34 +1942,34 @@ import path : native make :

        2. -rule split-list ( list * : separator )

          Returns the concatenated results of applying +rule split-list ( list * : separator )

          Returns the concatenated results of applying regex.split to every element of the list using the separator pattern.

        3. -rule match ( pattern : string : indices * )

          Match string against +rule match ( pattern : string : indices * )

          Match string against pattern, and return the elements indicated by indices.

        4. -rule transform ( list * : pattern : indices * )

          Matches all elements of list against +rule transform ( list * : pattern : indices * )

          Matches all elements of list against the pattern and returns a list of elements indicated by indices of all successful matches. If indices is omitted returns a list of first parenthesized groups of all successful matches.

        5. -rule escape ( string : symbols : escape-symbol )

          Escapes all of the characters in symbols +rule escape ( string : symbols : escape-symbol )

          Escapes all of the characters in symbols using the escape symbol escape-symbol for the given string, and returns the escaped string.

        6. -rule replace ( string match replacement )

          Replaces occurrences of a match string in a given string and +rule replace ( string match replacement )

          Replaces occurrences of a match string in a given string and returns the new string. The match string can be a regex expression.

        7. -rule replace-list ( list * : match : replacement )

          Replaces occurrences of a match string in a given list of strings +rule replace-list ( list * : match : replacement )

          Replaces occurrences of a match string in a given list of strings and returns a list of new strings. The match string can be a regex expression.

          @@ -1980,7 +1980,7 @@ import path : native make :

          sequence

          -

          +

          Various useful list functions. Note that algorithms in this module execute largely in the caller's module namespace, so that local rules can be used as function objects. Also note that most predicates @@ -1990,50 +1990,50 @@ import path : native make :

          1. -rule filter ( predicate + : sequence * )

            Return the elements e of +rule filter ( predicate + : sequence * )

            Return the elements e of $(sequence) for which [ $(predicate) e ] has a non-null value.

          2. -rule transform ( function + : sequence * )

            Return a new sequence consisting of +rule transform ( function + : sequence * )

            Return a new sequence consisting of [ $(function) $(e) ] for each element e of $(sequence).

          3. -rule reverse ( s * )

            Returns the elements of s in +rule reverse ( s * )

            Returns the elements of s in reverse order.

          4. -rule insertion-sort ( s * : ordered * )

            Insertion-sort s using the +rule insertion-sort ( s * : ordered * )

            Insertion-sort s using the BinaryPredicate ordered.

          5. -rule merge ( s1 * : s2 * : ordered * )

            Merge two ordered sequences using the BinaryPredicate +rule merge ( s1 * : s2 * : ordered * )

            Merge two ordered sequences using the BinaryPredicate ordered.

          6. -rule join ( s * : joint ? )

            Join the elements of s into one +rule join ( s * : joint ? )

            Join the elements of s into one long string. If joint is supplied, it is used as a separator.

          7. -rule length ( s * )

            Find the length of any sequence.

            +rule length ( s * )

            Find the length of any sequence.

          8. -rule unique ( list * : stable ? )

            Removes duplicates from list. +rule unique ( list * : stable ? )

            Removes duplicates from list. If stable is passed, then the order of the elements will be unchanged.

          9. -rule max-element ( elements + : ordered ? )

            Returns the maximum number in elements. +rule max-element ( elements + : ordered ? )

            Returns the maximum number in elements. Uses ordered for comparisons or numbers.less if none is provided.

          10. -rule select-highest-ranked ( elements * : ranks * )

            Returns all of elements for which +rule select-highest-ranked ( elements * : ranks * )

            Returns all of elements for which the corresponding element in the parallel list rank is equal to the maximum value in rank.

            @@ -2043,13 +2043,13 @@ import path : native make :

            type

            -

            +

            Deals with target type declaration and defines target class which supports typed targets.

            1. -rule register ( type : suffixes * : base-type ? )

              +rule register ( type : suffixes * : base-type ? )

              Registers a target type, possible derived from a base-type. Providing a list of suffixes here is a shortcut for separately calling the @@ -2060,7 +2060,7 @@ import path : native make :

            2. -rule register-suffixes ( suffixes + : type )

              +rule register-suffixes ( suffixes + : type )

              Specifies that files with suffix from suffixes be recognized as targets of type type. Issues an error if a different type is already specified for any @@ -2068,47 +2068,47 @@ import path : native make :

            3. -rule registered ( type )

              Returns true iff type has been registered.

              +rule registered ( type )

              Returns true iff type has been registered.

            4. -rule validate ( type )

              Issues an error if type is unknown.

              +rule validate ( type )

              Issues an error if type is unknown.

            5. -rule set-scanner ( type : scanner )

              Sets a scanner class that will be used for this type.

              +rule set-scanner ( type : scanner )

              Sets a scanner class that will be used for this type.

            6. -rule get-scanner ( type : property-set )

              +rule get-scanner ( type : property-set )

              Returns a scanner instance appropriate to type and property-set.

            7. -rule base ( type )

              +rule base ( type )

              Returns a base type for the given type or nothing in case the given type is not derived.

            8. -rule all-bases ( type )

              +rule all-bases ( type )

              Returns the given type and all of its base types in order of their distance from type.

            9. -rule all-derived ( type )

              +rule all-derived ( type )

              Returns the given type and all of its derived types in order of their distance from type.

            10. -rule is-derived ( type base )

              +rule is-derived ( type base )

              Returns true if type is equal to base or has base as its direct or indirect base.

            11. -rule set-generated-target-suffix ( type : properties * : suffix )

              +rule set-generated-target-suffix ( type : properties * : suffix )

              Sets a file suffix to be used when generating a target of type with the specified properties. Can be called with no properties if no suffix has already been specified for the type. The suffix parameter can be an empty @@ -2125,19 +2125,19 @@ import path : native make :

            12. -rule change-generated-target-suffix ( type : properties * : suffix )

              +rule change-generated-target-suffix ( type : properties * : suffix )

              Change the suffix previously registered for this type/properties combination. If suffix is not yet specified, sets it.

            13. -rule generated-target-suffix ( type : property-set )

              +rule generated-target-suffix ( type : property-set )

              Returns the suffix used when generating a file of type with the given properties.

            14. -rule set-generated-target-prefix ( type : properties * : prefix )

              +rule set-generated-target-prefix ( type : properties * : prefix )

              Sets a target prefix that should be used when generating targets of type with the specified properties. Can be called with empty properties if no prefix for @@ -2154,19 +2154,19 @@ import path : native make :

            15. -rule change-generated-target-prefix ( type : properties * : prefix )

              +rule change-generated-target-prefix ( type : properties * : prefix )

              Change the prefix previously registered for this type/properties combination. If prefix is not yet specified, sets it.

            16. -rule generated-target-prefix ( type : property-set )

              +rule generated-target-prefix ( type : property-set )

              Returns the prefix used when generating a file of type with the given properties.

            17. -rule type ( filename )

              +rule type ( filename )

              Returns file type given its name. If there are several dots in filename, tries each suffix. E.g. for name of "file.so.1.2" suffixes "2", "1", and "so" will be tried. @@ -2189,7 +2189,7 @@ import path : native make :

              Class abstract-target

              -

              +

              Base class for all abstract targets.

              @@ -2226,19 +2226,19 @@ import path : native make :
               
            18. -rule name ( )

              Returns the name of this target.

              +rule name ( )

              Returns the name of this target.

            19. -rule project ( )

              Returns the project for this target.

              +rule project ( )

              Returns the project for this target.

            20. -rule location ( )

              Returns the location where the target was declared.

              +rule location ( )

              Returns the location where the target was declared.

            21. -rule full-name ( )

              Returns a user-readable name for this target.

              +rule full-name ( )

              Returns a user-readable name for this target.

            22. -rule generate ( property-set )

              +rule generate ( property-set )

              Generates virtual targets for this abstract target using the specified properties, unless a different value of some feature is required by the target. This is an abstract method which must be overriden by derived @@ -2261,7 +2261,7 @@ import path : native make :

              Class project-target

              -
              +
               class project-target : abstract-target {
                   rule generate ( property-set )
                   rule build-dir ( )
              @@ -2286,7 +2286,7 @@ import path : native make :
               
              1. -rule generate ( property-set )

                +rule generate ( property-set )

                Overrides abstract-target.generate. @@ -2303,26 +2303,26 @@ import path : native make :

              2. -rule build-dir ( )

                +rule build-dir ( )

                Returns the root build directory of the project.

              3. -rule main-target ( name )

                +rule main-target ( name )

                Returns a main-target class instance corresponding to name. Can only be called after the project has been fully loaded.

              4. -rule has-main-target ( name )

                +rule has-main-target ( name )

                Returns whether a main-target with the specified name exists. Can only be called after the project has been fully loaded.

              5. -rule find ( id : no-error ? )

                +rule find ( id : no-error ? )

                Find and return the target with the specified id, treated relative to self. Id may specify either a target or a file name with the target taking priority. May report an error or return nothing if the target is not found @@ -2334,7 +2334,7 @@ import path : native make :

                Class main-target

                -
                +
                 class main-target : abstract-target {
                     rule generate ( property-set )
                 
                @@ -2350,7 +2350,7 @@ import path : native make :
                 
                1. -rule generate ( property-set )

                  +rule generate ( property-set )

                  Overrides abstract-target.generate. @@ -2374,7 +2374,7 @@ import path : native make :

                  Class basic-target

                  -
                  +
                   class basic-target : abstract-target {
                       rule __init__ ( name : project : sources * : requirements * : default-build * : usage-requirements * )  
                       rule generate ( property-set )
                  @@ -2410,7 +2410,7 @@ import path : native make :
                   
                2. -rule generate ( property-set )

                  +rule generate ( property-set )

                  Overrides abstract-target.generate. @@ -2429,7 +2429,7 @@ import path : native make :

                3. -rule construct ( name : source-targets * : property-set )

                  +rule construct ( name : source-targets * : property-set )

                  Constructs virtual targets for this abstract target. Returns a usage-requirements property-set and a list of virtual targets. Should be overriden in derived classes. @@ -2440,7 +2440,7 @@ import path : native make :

                  Class typed-target

                  -
                  +
                   class typed-target : basic-target {
                       rule __init__ ( name : project : type : sources * : requirements * : default-build * : usage-requirements * ) 
                       rule type ( )
                  @@ -2483,13 +2483,13 @@ import path : native make :
                   
                4. -rule type ( )

                  +rule type ( )

                  Returns the type of the target.

                5. -rule construct ( name : source-targets * : property-set )

                  +rule construct ( name : source-targets * : property-set )

                  Implements basic-target.construct. Attempts to create a target of the correct type using generators appropriate for the given @@ -2518,7 +2518,7 @@ import path : native make :

                  Class property-set

                  -

                  Class for storing a set of properties.

                  +

                  Class for storing a set of properties.

                   class property-set {
                       rule raw ( )
                  @@ -2537,20 +2537,20 @@ import path : native make :
                   
                  1. -rule raw ( )

                    Returns a Jam list of the stored properties.

                    +rule raw ( )

                    Returns a Jam list of the stored properties.

                  2. -rule str ( )

                    Returns the string repesentation of the stored properties.

                    +rule str ( )

                    Returns the string repesentation of the stored properties.

                  3. -rule propagated ( )

                    +rule propagated ( )

                    Returns a property-set containing all the propagated properties in this property-set.

                  4. -rule add ( ps )

                    +rule add ( ps )

                    Returns a new property-set containing the union of the properties in this @@ -2572,7 +2572,7 @@ import path : native make :

                  5. -rule add-raw ( properties * )

                    +rule add-raw ( properties * )

                    Link add, except that it takes a list of properties instead of a @@ -2580,7 +2580,7 @@ import path : native make :

                  6. -rule refine ( ps )

                    +rule refine ( ps )

                    Refines properties by overriding any non-free and non-conditional properties for which a different value is specified in ps. Returns the resulting @@ -2588,7 +2588,7 @@ import path : native make :

                  7. -rule get ( feature )

                    +rule get ( feature )

                    Returns all the values of feature.

                  8. @@ -2700,7 +2700,7 @@ exe a : a.cpp

                    Target Paths

                    -

                    Several factors determine the location of a concrete +

                    Several factors determine the location of a concrete file target. All files in a project are built under the directory bin unless this is overriden by the build-dir project attribute. Under bin is a path that depends on the properties -- cgit v1.2.3