Bug 1531283: Add MOZ_QUIET description to explain how to disable ++DOMWINDOW and ++DOCSHELL logging r=sole
authorMichael Ratcliffe <mratcliffe@mozilla.com>
Thu, 28 Feb 2019 12:02:44 +0000
changeset 519605 3fa94e4ff5dbf92d13b28d4e3e0178f6ec0c8a6b
parent 519604 c21e3a9d44571587b757ab279c6876bba9e5be83
child 519606 865ffd54922df9290d217c75d126da23d0a373c0
push id10862
push userffxbld-merge
push dateMon, 11 Mar 2019 13:01:11 +0000
treeherdermozilla-beta@a2e7f5c935da [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerssole
bugs1531283
milestone67.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1531283: Add MOZ_QUIET description to explain how to disable ++DOMWINDOW and ++DOCSHELL logging r=sole Differential Revision: https://phabricator.services.mozilla.com/D21514
devtools/docs/SUMMARY.md
devtools/docs/tests/tips.md
--- a/devtools/docs/SUMMARY.md
+++ b/devtools/docs/SUMMARY.md
@@ -22,16 +22,17 @@
   * [Filing good bugs](./contributing/filing-good-bugs.md)
   * [Investigating performance issues](./contributing/performance.md)
   * [Writing efficient React code](./contributing/react-performance-tips.md)
 * [Automated tests](tests/README.md)
   * Running tests
     * [`xpcshell`](tests/xpcshell.md)
     * [Chrome mochitests](tests/mochitest-chrome.md)
     * [DevTools mochitests](tests/mochitest-devtools.md)
+    * [Tips](tests/tips.md)
   * [Writing tests](tests/writing-tests.md)
   * [Debugging intermittent failures](tests/debugging-intermittents.md)
   * [Performance tests (DAMP)](tests/performance-tests.md)
     * [Writing a new test](tests/writing-perf-tests.md)
 * [Files and directories](files/README.md)
   * [Adding New Files](files/adding-files.md)
 * [Tool Architectures](tools/tools.md)
   * [Inspector](tools/inspector.md)
new file mode 100644
--- /dev/null
+++ b/devtools/docs/tests/tips.md
@@ -0,0 +1,22 @@
+# Automated tests: Tips
+
+If you run tests in debug mode, e.g. when debugging memory leaks, the test logs are often dominated by `++DOMWINDOW`, `++DOCSHELL`, `--DOMWINDOW`, `--DOCSHELL` lines.
+
+These lines pollute the test logs making it difficult to find real problems. They also slow down our tests because they are not useful for debugging DevTools issues.
+
+You can add this to your `.zshrc` or `.bashrc` to disable them:
+
+```bash
+# Disable those annoying +++DOMWINDOW and +++DOCSHELL printfs from Firefox logs
+export MOZ_QUIET=1
+```
+
+You can also send `MOZ_QUIET` when you push to try&hellip; it makes the logs easier to read and makes the tests run faster because there is so much less logging.
+
+Example try syntax containing `MOZ_QUIET`:
+
+```
+./mach try -b do -p linux,linux64,macosx64,win32,win64 \
+  -u xpcshell,mochitest-bc,mochitest-e10s-bc,mochitest-dt,mochitest-chrome \
+  -t damp-e10s --setenv MOZ_QUIET=1
+```