diff options
| author | Richard Smith <richard-llvm@metafoo.co.uk> | 2018-10-11 23:48:11 +0000 |
|---|---|---|
| committer | Richard Smith <richard-llvm@metafoo.co.uk> | 2018-10-11 23:48:11 +0000 |
| commit | df398bd5fe1f318b018ac1280ac264d4098b34e2 (patch) | |
| tree | c170f5f13f56c4b3dd6772e8912d8811c0d949cf /clang/docs | |
| parent | c7efb6f990456d61cf282865462fdd7300d88198 (diff) | |
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.
llvm-svn: 344319
Diffstat (limited to 'clang/docs')
| -rw-r--r-- | clang/docs/UsersManual.rst | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst index 6d321952cf8a..b3841c01d79c 100644 --- a/clang/docs/UsersManual.rst +++ b/clang/docs/UsersManual.rst @@ -1831,13 +1831,15 @@ The profile remapping file is a text file containing lines of the form 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:: |