Skip to content

Commit

Permalink
remote: document remote download regex
Browse files Browse the repository at this point in the history
As we are switching to a default Build without Bytes, it would be useful
for users to be able to look up usage of remote_download_regex flag in
Bazel's reference documentation.

Also add a small note about accumulative usage of the flag.

Closes #19025.

PiperOrigin-RevId: 550818264
Change-Id: I1c6a128b99f452dcaa6e034a1c3560acbab9d7c0
(cherry picked from commit bfdcca8)
  • Loading branch information
sluongng authored and brentleyjones committed Jul 25, 2023
1 parent bade2e9 commit 13fe617
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ public class CommonRemoteOptions extends OptionsBase {
name = "experimental_remote_download_regex",
defaultValue = "null",
allowMultiple = true,
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
documentationCategory = OptionDocumentationCategory.REMOTE,
effectTags = {OptionEffectTag.AFFECTS_OUTPUTS},
help =
"Force Bazel to download the artifacts that match the given regexp. To be used in"
+ " conjunction with Build without the Bytes (or the internal equivalent) to allow"
+ " the client to request certain artifacts that might be needed locally (e.g. IDE"
+ " support)")
+ " support). Multiple regexes can be specified by repeating this flag.")
public List<String> remoteDownloadRegex;

/** Returns the specified duration. Assumes seconds if unitless. */
Expand Down

0 comments on commit 13fe617

Please sign in to comment.