From: Richard Smith Date: Thu, 11 Oct 2018 23:48:11 +0000 (+0000) Subject: Update user's manual documentation of profile remapping file to match X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e16c2548c17721bcced8cbbe0afdaa8903eb611c;p=clang 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. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@344319 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/docs/UsersManual.rst b/docs/UsersManual.rst index 6d321952cf..b3841c01d7 100644 --- a/docs/UsersManual.rst +++ b/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 `>s, -<`type `>s, or -<`encoding `>s, +<`name `_>s, +<`type `_>s, or +<`encoding `_>s, respectively. - Blank lines and lines starting with ``#`` are ignored. +For convenience, built-in s such as ``St`` and ``Ss`` +are accepted as s (even though they technically are not 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::