update source to Ceph Pacific 16.2.2

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

diff --git a/ceph/src/boost/tools/build/src/tools/features/variant-feature.jam b/ceph/src/boost/tools/build/src/tools/features/variant-feature.jam
index b1e6544df1db2229b91c8f6459ac67036f6c5254..ced88cebea6391f5777e08d53de169ed87b89176 100644 (file)
--- a/ceph/src/boost/tools/build/src/tools/features/variant-feature.jam
+++ b/ceph/src/boost/tools/build/src/tools/features/variant-feature.jam
@@ -3,12 +3,44 @@
 # (See accompanying file LICENSE_1_0.txt or copy at
 # http://www.boost.org/LICENSE_1_0.txt)
 
-# TODO: Documentation.
-
 import feature ;
 import errors ;
 import property ;
 
+#| tag::doc[]
+
+[[bbv2.builtin.features.variant]]`variant`::
+*Allowed values:* `debug`, `release`, `profile`.
++
+A feature combining several low-level features, making it easy to
+request common build configurations.
++
+The value `debug` expands to
++
+----
+<optimization>off <debug-symbols>on <inlining>off <runtime-debugging>on
+----
++
+The value `release` expands to
++
+----
+<optimization>speed <debug-symbols>off <inlining>full <runtime-debugging>off
+----
++
+The value `profile` expands to the same as `release`, plus:
++
+----
+<profiling>on <debug-symbols>on
+----
++
+Users can define their own build variants using the `variant` rule
+from the `common` module.
++
+NOTE: Runtime debugging is on in debug builds to suit the expectations of
+people used to various IDEs.
+
+|# # end::doc[]
+
 feature.feature variant
     :
     : implicit composite propagated symmetric ;