search

conan-io / docs

conan.io reStructuredText documentation
http://docs.conan.io
MIT License
110 stars 358 forks source link

Document all `download_cache`'s properly #3176

Open maksim-petukhov opened 1 year ago

maksim-petukhov commented 1 year ago

I would like to cache downloads of sources. I look into documentation documentation and see that it mentions core.download:download_cache configuration and describes it as

Define path to a file download cache

Are sources files? Yep. This must be a right fit. And it's not because this conf controls path to a cache of internal files. It would be great to mention that in docs.

Then we have tools.files.download:download_cache configuration and the documentation says that it's a conf for

caching the external/third_party files downloaded by recipes in download() or get() calls.

So I set it and get an error from conan

ERROR: Unknown conf 'tools.files.download:download_cache'.

And... This conf doesn't exist. It turns out that this conf was deleted. Changelogs doesn't mention that fact at all. This conf was replaced (as far as I understand) by core.sources:download_cache which is not documented at all.

Summing up

memsharded commented 1 year ago

Thanks for the report @maksim-petukhov

Indeed, the tools.files.download:download_cache was removed as buggy in latest 2.0.X. And we have developed a new (very desired) feature, which is a backup of sources, that can store the cached files in a remote server and reuse them later.

This is expected not to be documented at the moment, as we are first implementing this ourselves in ConanCenter, to polish it and make sure everything is ok, and only after that we will documented it for public usage.

(We will remove the trailing tools.files.download:download_cache from the docs asap)

Please use the output of conan config list as the ground truth, and wait a bit until this is publicly documented and released. Many thanks!

System-Arch commented 1 month ago

Hi @memsharded,

Has the dust settled around core.sources:download_cache and has it or will it be documented as a fully supported feature?

Thanks!