From 879df03f74a98f0cb98680981a2a7e9236a16112 Mon Sep 17 00:00:00 2001 From: Patrick Bouffard Date: Thu, 16 May 2024 12:19:14 -0700 Subject: [PATCH 1/5] preliminary wording; need someone to help with TODOs --- docs/src/environments.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/src/environments.md b/docs/src/environments.md index fd6fff9ab4..44e4f20d24 100644 --- 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. A `?` character indicates +that [TODO: something to do with waiting?]; animated "clock" characters +(`◐`,`◓`,`◑`,`◒`) indicate that the package is currently being precompiled; a +`✓` indicates that the package has been successfully precompiled [TODO: these +disappear when... all their dependencies are also precompiled?]; a `✗` 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 From 97c47ba65e47da02932b1e16f77cec5ccabb8564 Mon Sep 17 00:00:00 2001 From: pbouffard <231346+pbouffard@users.noreply.github.com> Date: Thu, 16 May 2024 14:14:13 -0700 Subject: [PATCH 2/5] Update docs/src/environments.md Co-authored-by: Ian Butterworth --- docs/src/environments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/environments.md b/docs/src/environments.md index 44e4f20d24..d25e59a32b 100644 --- a/docs/src/environments.md +++ b/docs/src/environments.md @@ -194,7 +194,7 @@ 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. A `?` character indicates -that [TODO: something to do with waiting?]; animated "clock" characters +that a `PrecompilableError` was thrown which indicates precompilation was disallowed i.e. `__precompile__(false)`; animated "clock" characters (`◐`,`◓`,`◑`,`◒`) indicate that the package is currently being precompiled; a `✓` indicates that the package has been successfully precompiled [TODO: these disappear when... all their dependencies are also precompiled?]; a `✗` indicates From 0c347d886dcd5b720534cfd1cb3e1677855eb942 Mon Sep 17 00:00:00 2001 From: pbouffard <231346+pbouffard@users.noreply.github.com> Date: Fri, 31 May 2024 09:37:38 -0700 Subject: [PATCH 3/5] Add words describing check mark, reorganize text --- docs/src/environments.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/src/environments.md b/docs/src/environments.md index d25e59a32b..619020f8a9 100644 --- a/docs/src/environments.md +++ b/docs/src/environments.md @@ -193,12 +193,12 @@ 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. A `?` character indicates -that a `PrecompilableError` was thrown which indicates precompilation was disallowed i.e. `__precompile__(false)`; animated "clock" characters -(`◐`,`◓`,`◑`,`◒`) indicate that the package is currently being precompiled; a -`✓` indicates that the package has been successfully precompiled [TODO: these -disappear when... all their dependencies are also precompiled?]; a `✗` indicates -that the package failed to precompile. +indicate the status of that package's precompilation. Animated "clock" characters +(`◐`,`◓`,`◑`,`◒`) indicate that the package is currently being precompiled. +A checkmark (`✓`) indicates that the package has been successfully precompiled (after which that package will disappear from the list). +A question mark (`?`) character indicates that a `PrecompilableError` was thrown, indicating that precompilation was disallowed, +i.e. `__precompile__(false)` in that package. +An `✗` indicates that the package failed to precompile. ### Precompiling new versions of loaded packages From f6feb551d6ea64e8d6f2910fe9c3ca38a56a8445 Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 8 Jul 2024 15:12:04 -0400 Subject: [PATCH 4/5] Update docs/src/environments.md Co-authored-by: Anshul Singhvi --- docs/src/environments.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/src/environments.md b/docs/src/environments.md index 619020f8a9..86246cfafa 100644 --- a/docs/src/environments.md +++ b/docs/src/environments.md @@ -193,12 +193,12 @@ 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 checkmark (`✓`) indicates that the package has been successfully precompiled (after which that package will disappear from the list). -A question mark (`?`) character indicates that a `PrecompilableError` was thrown, indicating that precompilation was disallowed, -i.e. `__precompile__(false)` in that package. -An `✗` indicates that the package failed to precompile. +indicate the status of that package's precompilation. + +- `[◐, ◓, ◑, ◒]` Animated "clock" characters indicate that the package is currently being precompiled. +- `✓` A checkmark indicates that the package has been successfully precompiled (after which that package will disappear from the list). +- `?` 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 From 88ca290b06b47897b7898239936beb9cab17710c Mon Sep 17 00:00:00 2001 From: Ian Butterworth Date: Mon, 8 Jul 2024 15:14:28 -0400 Subject: [PATCH 5/5] Update docs/src/environments.md --- docs/src/environments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/environments.md b/docs/src/environments.md index 86246cfafa..f2e36883bf 100644 --- a/docs/src/environments.md +++ b/docs/src/environments.md @@ -196,7 +196,7 @@ 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 checkmark indicates that the package has been successfully precompiled (after which that package will disappear from the list). +- `✓` 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.