Skip to content

Commit ec6bafb

Browse files
bhumilmayani12-ossfujitatomoya
authored andcommitted
docs: add note for wsl users about filesystem location. (#6101)
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> (cherry picked from commit 2e05f75)
1 parent 8895a89 commit ec6bafb

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,9 @@ To test building the multisite version deployed to the website use:
7070
`sensible-browser build/html/rolling/index.html`
7171

7272
**NB:** This will ignore local workspace changes and build from the branches.
73+
74+
### Note for Windows (WSL) Users
75+
76+
When building the documentation on windows using WSL, it is recommended to clone and work with this repository inside the Linux filesystem (for example, under `/home/<user>/`) rather than under `/mnt/c`.
77+
78+
Working under `/mnt/c` can lead to slower builds and filesystem-related issues with Sphinx and ROS tooling.

0 commit comments

Comments
 (0)