Add some documentation describing how to interpret the symbols shown …

…during recompilation (#3903) * preliminary wording; need someone to help with TODOs * Update docs/src/environments.md Co-authored-by: Ian Butterworth <[email protected]> * Add words describing check mark, reorganize text * Update docs/src/environments.md Co-authored-by: Anshul Singhvi <[email protected]> * Update docs/src/environments.md --------- Co-authored-by: Ian Butterworth <[email protected]> Co-authored-by: Anshul Singhvi <[email protected]>
JuliaLang · Jul 9, 2024 · a140321 · a140321
1 parent 1e4497e
commit a140321
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/src/environments.md b/docs/src/environments.md
@@ -192,6 +192,14 @@ force these packages to be retried, as `pkg> precompile` will always retry all p
 
 To disable the auto-precompilation, set `ENV["JULIA_PKG_PRECOMPILE_AUTO"]=0`.
 
+The indicators next to the package names displayed during precompilation
+indicate the status of that package's precompilation. 
+
+- `[◐, ◓, ◑, ◒]` Animated "clock" characters indicate that the package is currently being precompiled.
+- `✓` A green checkmark indicates that the package has been successfully precompiled (after which that package will disappear from the list). If the checkmark is yellow it means that the package is currently loaded so the session will need to be restarted to access the version that was just precompiled.
+- `?` A question mark character indicates that a `PrecompilableError` was thrown, indicating that precompilation was disallowed, i.e. `__precompile__(false)` in that package.
+- `✗` A cross indicates that the package failed to precompile.
+
 ### Precompiling new versions of loaded packages
 
 If a package that has been updated is already loaded in the session, the precompilation process will go ahead and precompile