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.

Sign up for GitHub

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

Jump to bottom

Document %workspace% and other token expansions #13480

Open
jpeach opened this issue May 16, 2021 · 0 comments
Open

Document %workspace% and other token expansions #13480

jpeach opened this issue May 16, 2021 · 0 comments
Labels
help wanted Someone outside the Bazel team could own this P2 We'll consider working on this in future. (Assignee optional) team-Documentation Documentation improvements that cannot be directly linked to other team labels team-ExternalDeps External dependency handling, remote repositiories, WORKSPACE file. type: documentation (cleanup)

Comments

@jpeach
Copy link

jpeach commented May 16, 2021

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.
@aiuto aiuto added team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website type: documentation (cleanup) untriaged labels May 17, 2021
@Wyverald Wyverald added team-Documentation Documentation improvements that cannot be directly linked to other team labels and removed team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website labels Jan 24, 2022
@sgowroji sgowroji added the team-ExternalDeps External dependency handling, remote repositiories, WORKSPACE file. label Nov 22, 2022
@meteorcloudy meteorcloudy added P2 We'll consider working on this in future. (Assignee optional) and removed untriaged labels Dec 6, 2022
@keertk keertk added the help wanted Someone outside the Bazel team could own this label Jan 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Someone outside the Bazel team could own this P2 We'll consider working on this in future. (Assignee optional) team-Documentation Documentation improvements that cannot be directly linked to other team labels team-ExternalDeps External dependency handling, remote repositiories, WORKSPACE file. type: documentation (cleanup)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@jpeach @Wyverald @aiuto @meteorcloudy @sgowroji @keertk