[PATCH] D57474: Update SanitizerCoverage doc regarding the issue with pc-table and gc-sections.

[Max Moroz via Phabricator via cfe-commits]

Dor1s created this revision.
Dor1s added a reviewer: morehouse.
Herald added a subscriber: cfe-commits.

There is a bug for this: https://bugs.llvm.org/show_bug.cgi?id=34636
But it would be also helpful to leave a note in the docs to prevent users from
running into issues, e.g. https://crbug.com/926588.


Repository:
  rC Clang

https://reviews.llvm.org/D57474

Files:
  docs/SanitizerCoverage.rst


Index: docs/SanitizerCoverage.rst
===================================================================
--- docs/SanitizerCoverage.rst
+++ docs/SanitizerCoverage.rst
@@ -144,6 +144,10 @@
 
 **Experimental, may change or disappear in future**
 
+**Note:** this instrumentation might be incompatible with dead code stripping
+(``-Wl,-gc-sections``), thus resulting in a significant binary size overhead.
+See `Bug 34636 <https://bugs.llvm.org/show_bug.cgi?id=34636>`_ for more info.
+
 With ``-fsanitize-coverage=pc-table`` the compiler will create a table of
 instrumented PCs. Requires either ``-fsanitize-coverage=inline-8bit-counters`` or
 ``-fsanitize-coverage=trace-pc-guard``.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D57474.184369.patch
Type: text/x-patch
Size: 680 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20190130/c9de5a4e/attachment.bin>