bazelbuild / bazelbuild/bazel

Incorrect information regarding output directory name

Open
#19,270 0 comments 0 reactions 0 assignees View on GitHub
help wanted P3 team-Documentation team-Remote-Exec type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 20h
Merged PRs (30d)
72

Description

### Page link:

https://bazel.build/remote/output-directories

### Problem description (include actual vs expected text, if applicable):

`The symlinks for "bazel-", "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 `/ <== 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-", "bazel-out", "bazel-testlogs", and "bazel-bin" are put in the workspace directory; `

In "Layout diagram" you probably could replace `` 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_

Contributor guide

Open the contributing guide

Research direction

Open the remote output directories page and review the paragraph containing the symlink names and the Layout diagram below it. Check the distinction between the workspace directory name, workspace name, and the `my-project` example, then revise the wording and diagram labels so the source of each name is explicit and verify the rendered page.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.