summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRyan Harrison <rharrison@chromium.org>2018-04-11 14:50:41 +0000
committerChromium commit bot <commit-bot@chromium.org>2018-04-11 14:50:41 +0000
commit63c5fa9cf2250dcd91dd88d8233c0d9d93b1d917 (patch)
treedec4fbdfe9cd940032d82b8326ad85b9f8e16092
parent6bebd2e3cfb7790580722836d0debab3103c94d0 (diff)
downloadpdfium-63c5fa9cf2250dcd91dd88d8233c0d9d93b1d917.tar.xz
Add documentation about Valgrind LLD workaround
BUG=chromium:830706 Change-Id: I72ea6373d898953c10e523399655f1f630941b09 Reviewed-on: https://pdfium-review.googlesource.com/30110 Commit-Queue: Ryan Harrison <rharrison@chromium.org> Reviewed-by: Henrique Nakashima <hnakashima@chromium.org>
-rw-r--r--README.md7
-rw-r--r--docs/safetynet.md3
2 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 62efdbc033..dd6224eecd 100644
--- a/README.md
+++ b/README.md
@@ -141,6 +141,13 @@ checkout to see if the same failures appear.
Code coverage reports for PDFium can be generated in Linux development
environments. Details can be found [here](/docs/code-coverage.md).
+## Profiling
+
+Valgrind and other profiling tools do not work correctly with the standard build
+setup that PDFium uses. You will need to add
+`ro_segment_workaround_for_valgrind=true` to `args.gn` to get symbols to
+correctly appear.
+
## Waterfall
The current health of the source tree can be found at
diff --git a/docs/safetynet.md b/docs/safetynet.md
index 540f7db2eb..3ec1ccc5d0 100644
--- a/docs/safetynet.md
+++ b/docs/safetynet.md
@@ -106,6 +106,9 @@ Make sure valgrind is installed:
$ valgrind
```
+Add `ro_segment_workaround_for_valgrind=true` to `args.gn` for symbols to appear
+correctly.
+
This is a slow and accurate profiler. Expect variations of around 100
instructions. However, this takes about 50 times longer to run than perf stat.