Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document all download_cache's properly #3176

Open
maksim-petukhov opened this issue Apr 18, 2023 · 2 comments
Open

Document all download_cache's properly #3176

maksim-petukhov opened this issue Apr 18, 2023 · 2 comments
Assignees
Milestone

Comments

@maksim-petukhov
Copy link

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

  • core.download:download_cache conf documentation should say that it's for internal files
  • tools.files.download:download_cache conf documentation should be removed
  • core.sources:download_cache conf should be documented
@memsharded memsharded added this to the 2 milestone Apr 18, 2023
@memsharded memsharded self-assigned this Apr 18, 2023
@memsharded
Copy link
Member

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
Copy link

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants