update source to Ceph Pacific 16.2.2

[ceph.git] / ceph / src / boost / tools / build / src / tools / features / dll-feature.jam

diff --git a/ceph/src/boost/tools/build/src/tools/features/dll-feature.jam b/ceph/src/boost/tools/build/src/tools/features/dll-feature.jam
index fc59cc1738b55332f02bc690e9d401ed40d7d2d7..3c7ed0d652661aaa43760142ad766bba44305e99 100644 (file)
--- a/ceph/src/boost/tools/build/src/tools/features/dll-feature.jam
+++ b/ceph/src/boost/tools/build/src/tools/features/dll-feature.jam
@@ -3,14 +3,41 @@
 # (See accompanying file LICENSE_1_0.txt or copy at
 # http://www.boost.org/LICENSE_1_0.txt)
 
-# TODO: Documentation.
-
 import feature ;
 
+#| tag::doc[]
+
+[[bbv2.builtin.features.dll-path]]`dll-path`::
+Specifies an additional directory where the system should look for shared
+libraries when the executable or shared library is run. This feature only
+affects Unix compilers. Please see
+<<Why are the `dll-path` and `hardcode-dll-paths` properties useful?>>
+in <<Frequently Asked Questions>> for details.
+
+|# # end::doc[]
+
 feature.feature dll-path
     :
     : free path ;
 
+#| tag::hardcode-doc[]
+
+[[bbv2.builtin.features.hardcode-dll-paths]]`hardcode-dll-paths`::
+*Allowed values:* `true`, `false`.
++
+Controls automatic generation of dll-path properties.
++
+This property is specific to Unix systems. If an executable is built with
+`<hardcode-dll-paths>true`, the generated binary will contain the list of all
+the paths to the used shared libraries. As the result, the executable can be
+run without changing system paths to shared libraries or installing the
+libraries to system paths. This is very convenient during development. Please
+see the <<bbv2.faq.dll-path,FAQ entry>> for details. Note that on Mac OSX,
+the paths are unconditionally hardcoded by the linker, and it is not possible
+to disable that behavior
+
+|# # end::hardcode-doc[]
+
 feature.feature hardcode-dll-paths
     : true false
     : incidental ;
@@ -23,11 +50,24 @@ feature.feature xdll-path
     :
     : free path ;
 
-# Provides means to specify def-file for windows DLLs.
+#| tag::def-doc[]
+
+[[bbv2.builtin.features.def-file]]`def-file`::
+Provides a means to specify def-file for windows DLLs.
+
+|# # end::def-doc[]
+
 feature.feature def-file
     :
     : free dependency ;
 
+#| tag::suppress-doc[]
+
+[[bbv2.builtin.features.suppress-import-lib]]`suppress-import-lib`::
+Suppresses creation of import library by the linker.
+
+|# # end::suppress-doc[]
+
 feature.feature suppress-import-lib
     : false true
     : incidental ;