Merge pull request #1807 from brizental/1727352-qt-dev-docs

Bug 1727352 - Document how to use unminified Glean.js in Qt
mozilla · Sep 28, 2021 · 2791d63 · 2791d63
2 parents 78dd5fe + d44fb51
commit 2791d63
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/.dictionary b/.dictionary
@@ -1,4 +1,4 @@
-personal_ws-1.1 en 239 utf-8
+personal_ws-1.1 en 241 utf-8
 AAR
 AARs
 ABI
@@ -174,6 +174,7 @@ mdbook
 mdroettboom
 megazord
 metric's
+minified
 mozilla
 mozregression
 musl
@@ -230,6 +231,7 @@ und
 unencoded
 unhandled
 uniffi
+unminified
 uploader
 vendored
 webextension

diff --git a/docs/user/user/adding-glean-to-your-project/qt.md b/docs/user/user/adding-glean-to-your-project/qt.md
@@ -109,3 +109,21 @@ glean_parser glinter path/to/metrics.yaml path/to/pings.yaml
 
 [Glean Dictionary]: https://dictionary.telemetry.mozilla.org
 
+## Debugging
+
+By default, the Glean.js QML module uses a minified version of the Glean.js library.
+It may be useful to use the unminified version of the library in order to get proper
+line numbers and function names when debugging crashes.
+
+The bundle provided contains the unminified version of the library.
+In order to use it, open the `glean.js` file inside the included module and change the line:
+
+```
+.import "glean.lib.js" as Glean
+```
+
+to
+
+```
+.import "glean.dev.js" as Glean
+```