Skip to content

Update our instructions/examples regarding how we declare remote caches

James Ennisrequested to merge
jennis/docs_patch into master

I started this patch as I initially noticed that following !899 (merged), we did not update the documentation in how we declare remote caches in both:

  1. The project.conf, and,
  2. The user configuration (~/.config/buildstream.conf)

Which both contain out-of-date instructions.

However, implementing how we should declare this on those separate pages would have meant that we documented how to declare artifact caches in three separate places:

  1. The user configuration documentation
  2. The project configuration documentation
  3. The setting up an artifact server documentation

I've tided this up so that we only show examples of cache declarations in their respective documentation, and this describes what the effect of declaring it in such a place does.

For example, declaring the following code block:

artifacts:
  url: https://foo.com:8080
  server-crt: server.crt

in your project.conf and your buildstream.conf will result in different BuildStream behaviours as the latter is a global cache declaration, meaning that this cache will be used for all of the user's projects. Whereas the former is just a project cache declaration. This distinction is not made clear in the current documentation and this patch aims to resolve this.

Edited by James Ennis

Merge request reports