system/serenity
system/serenity
1
0
Fork 0
mirror of https://github.com/SerenityOS/serenity synced 2024-09-06 08:56:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
serenity/Documentation/CLionConfiguration.md

54 lines
3 KiB
Markdown
Raw Normal View History

Meta: Add configuration for setting up project in CLion This commit adds a CMakeLists.txt file that will be used by CLion to configure the project and documentation explaining the steps to follow. Configuring CLion this way enables important features like code completion and file search. The configuration isn't perfect. There are source files for which CLion cannot pick up the headers and asks to manually include them from certain directories. But for the most part, it works all right.
2020-05-03 17:21:13 +00:00
## CLion Project Configuration
Documentation: Update CLion configuration documentation Closes #5512
2021-02-26 13:37:48 +00:00
CLion can integrate with CMake to provide code comprehension features.
Meta: Add configuration for setting up project in CLion This commit adds a CMakeLists.txt file that will be used by CLion to configure the project and documentation explaining the steps to follow. Configuring CLion this way enables important features like code completion and file search. The configuration isn't perfect. There are source files for which CLion cannot pick up the headers and asks to manually include them from certain directories. But for the most part, it works all right.
2020-05-03 17:21:13 +00:00
Documentation: Add notes for first time setup of the project in CLion Mention the "Open Project Wizard" where you can set the CMake options before making the cache. Remind users to use the "Default" build type and to build the Toolchain so CMake does not complain.
2021-07-03 00:51:00 +00:00
After opening the `serenity` repository in CLion as a new project, the "`Open Project Wizard`" window will open, from here set the following fields:
(Assuming you use `Ninja` as the build system and configured the CMake build directory to `Build/i686`)
`Build type`: `Default`
> _CMake will complain with any other build type, make sure to use `Default` so that `CMAKE_BUILD_TYPE` is empty in the `Build/i686/CMakeCache.txt` file._
Meta: Add configuration for setting up project in CLion This commit adds a CMakeLists.txt file that will be used by CLion to configure the project and documentation explaining the steps to follow. Configuring CLion this way enables important features like code completion and file search. The configuration isn't perfect. There are source files for which CLion cannot pick up the headers and asks to manually include them from certain directories. But for the most part, it works all right.
2020-05-03 17:21:13 +00:00
Documentation: Update CLion configuration documentation Closes #5512
2021-02-26 13:37:48 +00:00
`CMake Options`: `-G Ninja -DBUILD_LAGOM=ON -DCMAKE_C_COMPILER=gcc-10 -DCMAKE_CXX_COMPILER=g++-10`
Meta: Add configuration for setting up project in CLion This commit adds a CMakeLists.txt file that will be used by CLion to configure the project and documentation explaining the steps to follow. Configuring CLion this way enables important features like code completion and file search. The configuration isn't perfect. There are source files for which CLion cannot pick up the headers and asks to manually include them from certain directories. But for the most part, it works all right.
2020-05-03 17:21:13 +00:00
Documentation: Change CMake build directory to Build/i686 in CLion config
2021-04-17 10:18:33 +00:00
`Build Directory`: `Build/i686`
Meta: Update CLion and WSL configuration documentations This commit updates CLionConfiguration.md and NotesOnWSL.md so that they comply with new build system. In addition to that, the WSL doc is updated to include instructions to run qemu (and serenity) natively on Windows, without needing an X-window server.
2020-05-17 13:56:46 +00:00
Documentation: Add notes for first time setup of the project in CLion Mention the "Open Project Wizard" where you can set the CMake options before making the cache. Remind users to use the "Default" build type and to build the Toolchain so CMake does not complain.
2021-07-03 00:51:00 +00:00
> _If you have not built the Toolchain at this point, please do so: `./Toolchain/BuildIt.sh`_
If you already have the project open, you can go to "`File->Settings->Build, Execution, Deployment->Cmake`" to find these options.
Remember to recreate the CMake cache after changing any of the options.
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.
2021-05-03 08:58:15 +00:00
## 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
Everywhere: Fix a bunch of typos
2021-05-17 16:48:55 +00:00
in search results. This is often confusing, unintuitive, and can result in you losing changes you have made to files. To exclude
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.
2021-05-03 08:58:15 +00:00
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`
Meta: Update CLion and WSL configuration documentations This commit updates CLionConfiguration.md and NotesOnWSL.md so that they comply with new build system. In addition to that, the WSL doc is updated to include instructions to run qemu (and serenity) natively on Windows, without needing an X-window server.
2020-05-17 13:56:46 +00:00
## Notes for WSL Users
It is possible to set the embedded terminal in CLion to the one that your WSL distribution provides.
This way you can build and run serenity without leaving the IDE.
Note that following will only help if you don't use an X-window server to access qemu.
It is possible to install qemu natively on Windows and allow WSL to use it instead of installing qemu first on (wsl) linux and then use X server to launch serenity inside of it.
Check the updated manual [here](https://github.com/SerenityOS/serenity/blob/master/Documentation/NotesOnWSL.md).
- Locate the terminal emulator for your linux distribution.
Open CMD with elevated privileges and cd to `C:/Program Files/WindowsApps/`.
The directory is usually hidden and requires additional privileges. You should be able to cd as administrator.
`dir` and look for your distribution in directory names. In case of Ubuntu, it starts with `CanonicalGroupLimited.Ubuntu20.04onWindows_2004.2020.424.0_x64`.
cd to it. The directory should contain the shell executable. In my case it's named `ubuntu2004.exe`.
Copy `absolute/path/to/ubuntu2004.exe`.
- Go to your IDE settings: `File->Settings->Tools->Terminal` and paste the path you just copied to `shell path`. Click OK.
- Close CLion and restart.
The default IDE terminal should now be changed to WSL, and now you can run `CLion/run.sh`.
You may also want to copy `serenity/Meta/CLion/run.sh` to your project directory and run it from there, so that you don't have to fight with git every time you modify the script.
Reference in a new issue Copy permalink