bazelbuild/bazel

Document %workspace% and other token expansions

Open

#13.480 geöffnet am 16. Mai 2021

Auf GitHub ansehen
 (0 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Java (4.465 Forks)batch import
P2help wantedteam-Documentationteam-ExternalDepstype: documentation (cleanup)

Repository-Metriken

Stars
 (25.384 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 22T 20h) (77 gemergte PRs in 30 T)

Beschreibung

The %workspace% token is mentioned in the user manual under the --package_path flag. It would be way easier to find if expansion tokens were documented in a separate section.

It would also be useful to document

  • where the expansion tokens are expanded (i.e. which files and flags they are valid in)
  • whether there are an other expansion tokens

The description of %workspace% is confusing, since it refers to a "Bazel directory", which seems to mean a directory literally named "bazel". I can't find a precise definition of this term, an it is not mentioned in the concepts page. IIUC a workspace would be a directory containing a "WORKSPACE" file, but that doesn't seem to be what this expansion variable means.

Contributor Guide