Skip to content

Commit

Permalink
docs: add notes about scratchspaces in depot (#52367)
Browse files Browse the repository at this point in the history
Co-authored-by: Fredrik Ekre <[email protected]>
(cherry picked from commit bf6c31c)
  • Loading branch information
IanButterworth authored and KristofferC committed Dec 12, 2023
1 parent af11859 commit 1dd88d1
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions base/initdefs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,21 @@ environment variable if set.
Each entry in `DEPOT_PATH` is a path to a directory which contains subdirectories used by Julia for various purposes.
Here is an overview of some of the subdirectories that may exist in a depot:
* `artifacts`: Contains content that packages use for which Pkg manages the installation of.
* `clones`: Contains full clones of package repos. Maintained by `Pkg.jl` and used as a cache.
* `config`: Contains julia-level configuration such as a `startup.jl`
* `compiled`: Contains precompiled `*.ji` files for packages. Maintained by Julia.
* `dev`: Default directory for `Pkg.develop`. Maintained by `Pkg.jl` and the user.
* `environments`: Default package environments. For instance the global environment for a specific julia version. Maintained by `Pkg.jl`.
* `logs`: Contains logs of `Pkg` and `REPL` operations. Maintained by `Pkg.jl` and `Julia`.
* `packages`: Contains packages, some of which were explicitly installed and some which are implicit dependencies. Maintained by `Pkg.jl`.
* `registries`: Contains package registries. By default only `General`. Maintained by `Pkg.jl`.
* `scratchspaces`: Contains content that a package itself installs via the [`Scratch.jl`](https://github.com/JuliaPackaging/Scratch.jl) package. `Pkg.gc()` will delete content that is known to be unused.
!!! note
Packages that want to store content should use the `scratchspaces` subdirectory via
[`Scratch.jl`](https://github.com/JuliaPackaging/Scratch.jl) instead of creating new
subdirectories in the depot root.
See also [`JULIA_DEPOT_PATH`](@ref JULIA_DEPOT_PATH), and
[Code Loading](@ref code-loading).
Expand Down

0 comments on commit 1dd88d1

Please sign in to comment.