仓库指标
- Star
- (25,384 star)
- PR 合并指标
- (平均合并 22天 20小时) (30 天内合并 77 个 PR)
描述
Page link:
https://bazel.build/remote/output-directories
Problem description (include actual vs expected text, if applicable):
The symlinks for "bazel-<workspace-name>", "bazel-out", "bazel-testlogs", and "bazel-bin" are put in the workspace directory;
Where do you see this issue? (include link to specific section of the page, if applicable)
This text is incorrect. Bazel is not going to use workspace name that is defined in WORKSPACE file. Instead, Bazel will use workspace folder name. For example, if you clone Bazel git repo into a folder called kalle and build Bazel source code, generated link will be called bazel-kalle and not bazel-io_bazel. Bazel workspace name is defined in WORKSPACE file as workspace(name = "io_bazel") .
In the "Layout diagram" example just below that text there is a line <workspace-name>/ <== The workspace directory but I think that's introduced a bit too late to make connection between folder name and workspace directory. It's also not clear where my-project name in bazel-my-project comes from in that example. It's mentioned above in text but easy to miss. I think documentation would be better if there will be clear explanation and example of difference between workspace-name, workspace directory and my-project.
Suggested edit: The symlinks for "bazel-<workspace-directory-name>", "bazel-out", "bazel-testlogs", and "bazel-bin" are put in the workspace directory;
In "Layout diagram" you probably could replace <workspace-name> with my-project as comment on the side "The workspace directory" explains which folder is that.
Any other information you'd like to share?
No response