r344319 - Update user's manual documentation of profile remapping file to match

[Richard Smith via cfe-commits]

Author: rsmith
Date: Thu Oct 11 16:48:11 2018
New Revision: 344319

URL: http://llvm.org/viewvc/llvm-project?rev=344319&view=rev
Log:
Update user's manual documentation of profile remapping file to match
llvm-cxxmap documentation.

Add a hint as to how to perform off-line profile data remapping.

Modified:
    cfe/trunk/docs/UsersManual.rst

Modified: cfe/trunk/docs/UsersManual.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/UsersManual.rst?rev=344319&r1=344318&r2=344319&view=diff
==============================================================================
--- cfe/trunk/docs/UsersManual.rst (original)
+++ cfe/trunk/docs/UsersManual.rst Thu Oct 11 16:48:11 2018
@@ -1831,13 +1831,15 @@ The profile remapping file is a text fil
 
 where ``fragmentkind`` is one of ``name``, ``type``, or ``encoding``,
 indicating whether the following mangled name fragments are
-<`name <http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangle.name>`>s,
-<`type <http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangle.type>`>s, or
-<`encoding <http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangle.encoding>`>s,
+<`name <http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangle.name>`_>s,
+<`type <http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangle.type>`_>s, or
+<`encoding <http://itanium-cxx-abi.github.io/cxx-abi/abi.html#mangle.encoding>`_>s,
 respectively.
-
 Blank lines and lines starting with ``#`` are ignored.
 
+For convenience, built-in <substitution>s such as ``St`` and ``Ss``
+are accepted as <name>s (even though they technically are not <name>s).
+
 For example, to specify that ``absl::string_view`` and ``std::string_view``
 should be treated as equivalent when matching profile data, the following
 remapping file could be used:
@@ -1854,7 +1856,8 @@ remapping file could be used:
 Matching profile data using a profile remapping file is supported on a
 best-effort basis. For example, information regarding indirect call targets is
 currently not remapped. For best results, you are encouraged to generate new
-profile data matching the updated program.
+profile data matching the updated program, or to remap the profile data
+using the ``llvm-cxxmap`` and ``llvm-profdata merge`` tools.
 
 .. note::