diff --git a/source/dub/dub.d b/source/dub/dub.d index 28ada24..87a78bc 100644 --- a/source/dub/dub.d +++ b/source/dub/dub.d @@ -1883,6 +1883,11 @@ * project directory, but this led to issues with packages stored on * read-only file system / location, and lingering artifacts scattered * through the file system. + * + * Dub writes in the cache directory some Json description files + * of the available artifacts. These files are intended to be read by + * 3rd party software (e.g. Meson). The default cache location specified + * in this function should therefore not change across future Dub versions. */ NativePath cache; diff --git a/source/dub/generators/generator.d b/source/dub/generators/generator.d index 8ff77d0..3e0914b 100644 --- a/source/dub/generators/generator.d +++ b/source/dub/generators/generator.d @@ -771,9 +771,15 @@ /** * Compute and returns the path were artifacts are stored for a given package * - * Artifacts are usually stored in: + * Artifacts are stored in: * `$DUB_HOME/cache/$PKG_NAME/$PKG_VERSION[/+$SUB_PKG_NAME]/` * Note that the leading `+` in the sub-package name is to avoid any ambiguity. + * + * Dub writes in the returned path a Json description file of the available + * artifacts in this cache location. This Json file is read by 3rd party + * software (e.g. Meson). Returned path should therefore not change across + * future Dub versions. + * * Build artifacts are usually stored in a sub-folder named "build", * as their names are based on user-supplied values. *