Document the remote-repo-cache option as is implemented (it is).

[exarkun]

Fixes #8737

---

Please include the following checklist in your PR:

• Patches conform to the coding conventions.
• Any changes that could be relevant to users have been recorded in the changelog.
• The documentation has been updated, if necessary.

I tested that the feature really is implemented and left a transcript on the issue. I tested that the docs build and render using Python 3.8 on NixOS 22.11 in a virtualenv using the requirements.txt in the repo and visual inspection.

[ulysses4ever]

Thank you!

[Mikolaj]

However, are we sure this works in general and not in one easy corner case?

[exarkun]

However, are we sure this works in general and not in one easy corner case?

I could test in some other cases if that would help. Can you give me an idea of what the general problem space is? I just learned about this option today and as far as I can tell "specify a different directory" like in the example is the only thing you can do with it.

[Mikolaj]

Hah, I've never used this option, so I don't have any idea. Could anybody toss any other use case for this feature so that we could try?

@exarkun: feel free to set the merge_me label and this will still leave 2 days for people to come up with evil examples to try.

[ulysses4ever]

I can't think of trickier examples, but I think if anyone wanted to get to the bottom of it, one could investigate what patch changed the state of things and what that patch had to say about all of that. But that maybe too much effort for such a small thing. It's more efficient to apply the current change and wait for bug reports! In the meantime we have many more "pr-welcome" issues that @exarkun or anyone else could spend their energy for.

[Mikolaj]

Let me rebase to apply one more CI fix.

[Mikolaj]

@mergify rebase

[mergify]

rebase

❌ Pull request can't be updated with latest base branch changes

Mergify needs the author permission to update the base branch of the pull request.
@PrivateStorageio needs to authorize modification on its head branch.
err-code: 5E022

[Mikolaj]

@exarkun: could you let admins write to your branch or, alternatively, rebase youself? Thank you.

[exarkun]

@Mikolaj rebased (I would grant permission too but I can't find that github button today...)

[Mikolaj]

@mergify refresh

[mergify]

refresh

✅ Pull request refreshed

[Mikolaj]

Apparently that blocks auto-merging, too. so let me merge manually.

[Mikolaj]

@exarkun: thank you again!