update source to Ceph Pacific 16.2.2

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

diff --git a/ceph/src/boost/tools/build/src/tools/features/tag-feature.jam b/ceph/src/boost/tools/build/src/tools/features/tag-feature.jam
index 854a9a70ee8d5a12b0273fdf17408360a0758628..c03924edfbde9d376dc8c3f4830852c379cc9b18 100644 (file)
--- a/ceph/src/boost/tools/build/src/tools/features/tag-feature.jam
+++ b/ceph/src/boost/tools/build/src/tools/features/tag-feature.jam
@@ -3,10 +3,37 @@
 # (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.tag]]`tag`::
+Used to customize the name of the generated files. The value should have the
+form:
++
+----
+@rulename
+----
++
+where _rulename_ should be a name of a rule with the following signature:
++
+----
+rule tag ( name : type ? : property-set )
+----
++
+The rule will be called for each target with the default name computed by
+B2, the type of the target, and property set. The rule can either
+return a string that must be used as the name of the target, or an empty
+string, in which case the default name will be used.
++
+Most typical use of the `tag` feature is to encode build properties, or library
+version in library target names. You should take care to return non-empty
+string from the tag rule only for types you care about -- otherwise, you might
+end up modifying names of object files, generated header file and other targets
+for which changing names does not make sense.
+
+|# # end::doc[]
+
 feature.feature tag
     :
     : free ;