Documentation: Add a note about excluding the Build directory in CLion

This was discussed a while back on discord, but no one got around to writing it down yet.
Author: https://github.com/bgianfo Commit: https://github.com/SerenityOS/serenity/commit/f1c4a42840f Pull-request: https://github.com/SerenityOS/serenity/pull/6835
2021-05-03 01:58:15 -07:00 · 2021-05-03 01:58:15 -07:00 · f1c4a42840 · 2024-07-18 18:44:58 +09:00
commit f1c4a42840
parent 0726d39cb1
1 changed files with 10 additions and 0 deletions
--- a/Documentation/CLionConfiguration.md
+++ b/Documentation/CLionConfiguration.md
@ -9,6 +9,16 @@ and set the following fields: (Assuming you use `Ninja` as the build system and

 `Build Directory`: `Build/i686`

+## Excluding Build Artifacts
+
+Source files are copied to the `Build` directory during the build, if you do not exclude them from CLion indexing they will show up
+in search results. This is often confusing, unintuitive, and can result in your loosing changes you have made to files. To exclude
+these files navigate to the `Project` tool window, right-click the `Build` folder and select `Mark Directory as | Excluded`. If you
+want exclude Toolchain files as well, follow the same procedure with the following paths:
+- `Toolchain/Local`
+- `Toolchain/Tarballs`
+- `Toolchain/Build`
+
 ## Notes for WSL Users

 It is possible to set the embedded terminal in CLion to the one that your WSL distribution provides.