summaryrefslogtreecommitdiff
path: root/Documentation/CLionConfiguration.md
diff options
context:
space:
mode:
authorBrian Gianforcaro <bgianf@serenityos.org>2021-05-03 01:58:15 -0700
committerLinus Groh <mail@linusgroh.de>2021-05-03 15:20:26 +0200
commitf1c4a42840f1d137b4aa5b0606cbc16403993f64 (patch)
tree135d6adb626630d1abed4b06168e0961dc288cd0 /Documentation/CLionConfiguration.md
parent0726d39cb1e257ba70666862f6380537019d8b94 (diff)
downloadserenity-f1c4a42840f1d137b4aa5b0606cbc16403993f64.zip
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.
Diffstat (limited to 'Documentation/CLionConfiguration.md')
-rw-r--r--Documentation/CLionConfiguration.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/CLionConfiguration.md b/Documentation/CLionConfiguration.md
index 50745a788b..60c76039c0 100644
--- 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.