Documentation update to reflect changes made to where caches go. #12983
Conversation
doc/reference/caches.rst
Outdated
| command. | ||
| - The toolchains cache: contains the compiler (and compiler variants) when they | ||
| can't be installed as standard packages. | ||
| - The revision store: contains packaging information fetched from package |
There was a problem hiding this comment.
I'd say it is a git repository containing all revisions fetched via git.
I believe it is also used when we fetch a package via git (e.g. pinned packages).
doc/reference/caches.rst
Outdated
| Dune implements a cache of build results that is shared across different | ||
| workspaces. Before executing a build rule, Dune looks it up in the shared | ||
| Before executing a build rule, Dune looks it up in the shared |
There was a problem hiding this comment.
It was not introduced in this PR but I think it would be nice to know what "it" actually is. Otherwise this is very vague.
|
I would transpose the table, if we have other caches we will run out of width. |
doc/reference/caches.rst
Outdated
| Dune implements several different caches: | ||
|
|
||
| - The build cache: contains build artifacts that are shared across different | ||
| workspaces. This is the main cache, interacted with with the ``dune cache`` |
There was a problem hiding this comment.
| workspaces. This is the main cache, interacted with with the ``dune cache`` | |
| workspaces. This is the main cache, interacted with via the ``dune cache`` |
doc/reference/caches.rst
Outdated
| Before executing a build rule, Dune looks it up in the shared | ||
| cache, and if it finds a matching entry, Dune skips the rule's execution and |
There was a problem hiding this comment.
I think the issues @Leonidas-from-XIV points out here is a result of 'it' being used with two different referents: first to 'a build rule' then to dune (or dune's cache looking up).
ElectreAAS
force-pushed
the
push-rtqrmtlkywlo
branch
from
3f37b5a to
a6a9e5d
Compare
Signed-off-by: Ambre Austen Suhamy <[email protected]>
ElectreAAS
force-pushed
the
push-rtqrmtlkywlo
branch
from
a6a9e5d to
f571bcc
Compare
|
Let's leave the LMDB cache out of this document for now. We are waiting on introducing the versioning #12637 and if we end up using this for other parts of Dune we might need to move it anyway, making it unrelated to the revision store. |
doc/reference/caches.rst
Outdated
| On Windows, you can replace ``XDG_CACHE_HOME`` by ``%LOCALAPPDATA%\Microsoft\Windows\Temporary Internet Files`` | ||
|
|
||
| .. note:: | ||
| It is in fact ``git-repo`` (with a dash) and ``rev_store`` (with an underline) |
There was a problem hiding this comment.
We should probably change the names to be more descriptive, because this whole thing is very confusing.
There was a problem hiding this comment.
Yep that's the confusion I wanted to get in front of in the docs, but obviously fixing it is also good
… it's ready Signed-off-by: Ambre Austen Suhamy <[email protected]>
4 participants
Follow-up to #12858, the documentation needs to be updated to show where things go.
Draft mode because I'm not the best technical writer
Rendered output visible here https://dune--12983.org.readthedocs.build/en/12983/reference/caches.html