bug 1496176: marionette: document marionette.log.truncate pref; r=me
authorAndreas Tolfsen <ato@sny.no>
Wed, 03 Oct 2018 19:28:40 +0100
changeset 487744 fa568bd2149fb9f324fab80f8511063bb1819a81
parent 487743 c2b5dfcbd692d0c713ace2076d00b8d973c9a400
child 487745 23171f66fb8923a83a218439094fc09decb10064
push id246
push userfmarier@mozilla.com
push dateSat, 13 Oct 2018 00:15:40 +0000
reviewersme
bugs1496176
milestone64.0a1
bug 1496176: marionette: document marionette.log.truncate pref; r=me
testing/marionette/doc/Prefs.md
testing/marionette/prefs/marionette.js
--- a/testing/marionette/doc/Prefs.md
+++ b/testing/marionette/doc/Prefs.md
@@ -34,16 +34,23 @@ Sets the verbosity level of the Marionet
 that this preference does not control the verbosity of other loggers
 used in Firefox or Fennec.
 
 The available levels are, in descending order of severity, `Trace`,
 `debug`, `config`, `info`, `warn`, `error`, and `fatal`.  The value
 is treated case-insensitively.
 
 
+`marionette.log.truncate`
+-------------------------
+
+Certain log messages that are known to be long, such as wire protocol
+dumps, are truncated.  This preference causes them not to be truncated.
+
+
 `marionette.port`
 -----------------
 
 Defines the port on which the Marionette server will listen.  Defaults
 to port 2828.
 
 This can be set to 0 to have the system atomically allocate a free
 port, which can be useful when running multiple Marionette servers
--- a/testing/marionette/prefs/marionette.js
+++ b/testing/marionette/prefs/marionette.js
@@ -16,19 +16,18 @@ pref("marionette.debugging.clicktostart"
 
 // Verbosity of Marionette logger repository.
 //
 // Available levels are, in descending order of severity,
 // "trace", "debug", "config", "info", "warn", "error", and "fatal".
 // The value is treated case-insensitively.
 pref("marionette.log.level", "Info");
 
-// Certain log messages that are known to be long are truncated
-// before they are dumped to stdout.  The `marionette.log.truncate`
-// preference indicates that the values should not be truncated.
+// Certain log messages that are known to be long are truncated.
+// This preference causes them to not be truncated.
 pref("marionette.log.truncate", true);
 
 // Port to start Marionette server on.
 pref("marionette.port", 2828);
 
 // Sets recommended automation preferences when Marionette is started.
 pref("marionette.prefs.recommended", true);