Mention how to work around the libcanberra warning. Fixes #458 (#583)

Also update the precompilation section, including deleting the old userimg.jl instructions.
JuliaGraphics · Jul 28, 2021 · 0ff7447 · 0ff7447
1 parent af66d31
commit 0ff7447
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 21 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,7 +1,9 @@
 using Documenter, Gtk
 
 makedocs(
-    format = Documenter.HTML(),
+    format = Documenter.HTML(
+        prettyurls = get(ENV, "CI", nothing) == "true"
+    ),
     modules = [Gtk],
     sitename = "Gtk.jl",
     authors = "...",

diff --git a/docs/src/doc/precompilation.md b/docs/src/doc/precompilation.md
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -17,9 +17,24 @@ using Pkg
 Pkg.add("Gtk")
 ```
 
+!!! tip
+    On some platforms, you may see messages like
+
+    > Gtk-Message: 20:15:48.288: Failed to load module "canberra-gtk-module"
+
+    These are harmless. If you want to suppress them, on Unix platforms you can add something like
+
+    ```bash
+    export GTK_PATH=$GTK_PATH:/usr/lib/x86_64-linux-gnu/gtk-3.0
+    ```
+
+    to your `.bashrc` file. (You may need to customize the path for your system; it should have a `modules` directory containing `libcanberra`.)
+
 ## Precompilation
 
-Gtk is precompilable by normal mechanisms. For further reduction of startup time for applications that use Gtk, one can even [build it into your local installation of julia](doc/precompilation.md).
+Gtk is precompilable by normal mechanisms. Julia 1.6 or higher is recommended as having much shorter load times than earlier Julia versions.
+
+On very old Julia versions, you can use [PackageCompiler](https://github.com/JuliaLang/PackageCompiler.jl). Be aware that this has [downsides](https://julialang.github.io/PackageCompiler.jl/dev/sysimages/#Drawbacks-to-custom-sysimages-1) and should not be necessary on modern versions of Julia.
 
 ## Usage