beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-22 07:30:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6
ladybird/Documentation/CLionConfiguration.md

104 lines
5.7 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
Meta: Update Documentation and CI for repo move
2024-05-30 21:06:21 +00:00
After opening the `ladybird` repository in CLion as a new project, the "`Open Project Wizard`" window will open, from here set the following fields:
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
Documentation: Update CLion Configuration to use the x86-64 target Since the default target is x86-64 after PR #15441 was merged, then let us update the CLion Configuration accordingly.
2022-10-11 21:05:37 +00:00
(Assuming you use `Ninja` as the build system and configured the CMake build directory to `Build/x86_64`)
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
`Build type`: `Default`
Documentation: Update CLion Configuration to use the x86-64 target Since the default target is x86-64 after PR #15441 was merged, then let us update the CLion Configuration accordingly.
2022-10-11 21:05:37 +00:00
> _CMake will complain with any other build type, make sure to use `Default` so that `CMAKE_BUILD_TYPE` is empty in the `Build/x86_64/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 CLionConfiguration for SuperBuild Extra configure options may need passed to CLion in order for it not to choke on the new CMake setup. In particular, it's now a very bad idea to pass CMAKE_CXX_COMPILER and CMAKE_C_COMPILER to the target build.
2021-09-15 13:10:31 +00:00
`CMake Options`:
```
Documentation: Recommend setting PREFIX_PATH instead of INSTALL_PREFIX This was straight up the wrong CMake variable to set. We care about where the project will find Lagom, not where it wants to install its own binaries to.
2021-09-16 07:54:53 +00:00
-DCMAKE_PREFIX_PATH=$CMakeProjectDir$/Build/lagom-install
Documentation: Configure cache dir in CMake settings for CLion Without this, CMake would err out on a missing `/CLDR/version.txt`.
2023-05-24 10:44:51 +00:00
-DCMAKE_TOOLCHAIN_FILE=$CMakeProjectDir$/Build/x86_64/CMakeToolchain.txt
Documentation: Update CLion Configuration to use the x86-64 target Since the default target is x86-64 after PR #15441 was merged, then let us update the CLion Configuration accordingly.
2022-10-11 21:05:37 +00:00
-DSERENITY_ARCH=x86_64
Documentation: Configure cache dir in CMake settings for CLion Without this, CMake would err out on a missing `/CLDR/version.txt`.
2023-05-24 10:44:51 +00:00
-DSERENITY_CACHE_DIR=$CMakeProjectDir$/Build/caches
-GNinja
Documentation: Update CLionConfiguration for SuperBuild Extra configure options may need passed to CLion in order for it not to choke on the new CMake setup. In particular, it's now a very bad idea to pass CMAKE_CXX_COMPILER and CMAKE_C_COMPILER to the target build.
2021-09-15 13:10:31 +00:00
```
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 CLionConfiguration for SuperBuild Extra configure options may need passed to CLion in order for it not to choke on the new CMake setup. In particular, it's now a very bad idea to pass CMAKE_CXX_COMPILER and CMAKE_C_COMPILER to the target build.
2021-09-15 13:10:31 +00:00
> CLion will complain that the toolchain file doesn't exist yet, if you haven't `cmake` for the SuperBuild step before. The SuperBuild configure step creates the Toolchain file.
Documentation: Update CLion Configuration to use the x86-64 target Since the default target is x86-64 after PR #15441 was merged, then let us update the CLion Configuration accordingly.
2022-10-11 21:05:37 +00:00
> To re-create the file after blasting your build directory, run `cmake -GNinja -S Meta/CMake/Superbuild -B Build/superbuild-x86_64` from the top level in a terminal, or simply run `./Meta/serenity.sh run`
Documentation: Make docs for CLionConfiguration more understandable
2021-07-31 16:38:06 +00:00
Documentation: Update CLion Configuration to use the x86-64 target Since the default target is x86-64 after PR #15441 was merged, then let us update the CLion Configuration accordingly.
2022-10-11 21:05:37 +00:00
`Build Directory`: `Build/x86_64`
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
Meta: Rename `BuildIt.sh` to `BuildGNU.sh` Bring it in line with `Toolchain/BuildClang.sh`.
2023-06-12 08:23:56 +00:00
> _If you have not built the Toolchain at this point, please do so: `./Toolchain/BuildGNU.sh`_
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
Documentation: Update CLion Configuration to use the x86-64 target Since the default target is x86-64 after PR #15441 was merged, then let us update the CLion Configuration accordingly.
2022-10-11 21:05:37 +00:00
> _If you have not built host tools from Lagom at this point, please do so: `./Meta/serenity.sh build` or `ninja -C Build/superbuild-x86_64` after running `cmake -GNinja -S Meta/CMake/Superbuild -B Build/superbuild-x86_64`_
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
Documentation: Update CLionConfiguration for SuperBuild Extra configure options may need passed to CLion in order for it not to choke on the new CMake setup. In particular, it's now a very bad idea to pass CMAKE_CXX_COMPILER and CMAKE_C_COMPILER to the target build.
2021-09-15 13:10:31 +00:00
If you already have the project open, you can go to `File -> Settings -> Build, Execution, Deployment -> CMake` to find these options.
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
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
Documentation: Change spelling error in CLionConfiguration.md Change "want exclude" to "want to exclude"
2022-08-21 20:35:33 +00:00
want to exclude Toolchain files as well, follow the same procedure with the following paths:
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
- `Toolchain/Local`
- `Toolchain/Tarballs`
- `Toolchain/Build`
Meta: Add section to CLion Configuration Docs about including headers
2021-09-19 19:51:44 +00:00
## Include headers and source files for code insight
To get proper code insight mark the folders `AK`, `Kernel` and `Userland` by right-clicking on them and selecting `Mark Directory as | Project Sources and Headers`.
A symptom of this not being configured correctly is CLion giving a warning for every single file:
> The file does not belong to any project target, code insight features might not work properly.
Documentation: Add preferred coding style options to CLion configuration
2021-07-27 20:32:20 +00:00
## Code Generation Settings
Documentation: Fix typo in CLionConfiguration.md
2023-01-08 17:25:12 +00:00
To make code generated by CLion match the SerenityOS coding style, import the `CLionCodeStyleSettings.xml` from this directory as code style scheme via
Documentation: Recommend CLion code style settings over manual steps Changing the naming conventions one-by-one was tedious and error-prone. A settings file is likely to be more forward compatible than a screenshot. The settings file was made by repeating the manual steps provided in the documentation, and exporting the file in CLion.
2022-11-24 23:03:57 +00:00
`Settings -> Editor -> Code Style -> C/C++ -> Scheme -> Cog icon -> Import Scheme...`
Documentation: Add preferred coding style options to CLion configuration
2021-07-27 20:32:20 +00:00
Documentation: Add Kernel/Userland quick switch to CLion configuration
2022-04-01 15:21:16 +00:00
## Quick switching between Kernel and Userland targets
In order to let CLion know what kind of code you're currently working on (Kernel / Userland) to make sure it parses and displays the correct half of statements like this:
```c++
#ifdef KERNEL
...
#else
...
#endif
```
You need to add build configurations for each:
Click on one of the buttons below (top right of the IDE) - If you have the second one, press Edit Configurations after the dropdown box opens, then press CTRL+A to select the 1000s of automatically generated targets, and then press Delete to remove them.
![Add Configuration...](CLion_Add_Configuration.png)
![Kernel | Default](CLion_Add_Configuration_Existing.png)
Then press the `+` button to add a new configuration, select `CMake Application`, name the configuration `Kernel`, set the target to `Kernel` (typing while the dropdown box is open searches), and then repeat the process one more time, this time with the name being `Userland` and the target being `true`.
Finally, to quickly switch between the two different contexts, simply click the `Kernel | Default` / `Userland | Default` button to switch.
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
Docs: Update CLion configuration for WSL In CLion on Windows subsystem for linux (WSL) we need to set up a CLion toolchain so that the IDE can find the correct CMake.
2022-08-19 16:29:49 +00:00
### Toolchain
Meta: Update Documentation and CI for repo move
2024-05-30 21:06:21 +00:00
If the ladybird directory is on the WSL filesystem you need to configure the CLion toolchain to be WSL.
To set that up go to `File->Settings->Build, Execution, Deployment->Toolchains` and click on the `+` icon, then select WSL. In `Toolset` select the distribution you have the ladybird directory on.
Docs: Update CLion configuration for WSL In CLion on Windows subsystem for linux (WSL) we need to set up a CLion toolchain so that the IDE can find the correct CMake.
2022-08-19 16:29:49 +00:00
### Terminal
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
It is possible to set the embedded terminal in CLion to the one that your WSL distribution provides.
Meta: Update Documentation and CI for repo move
2024-05-30 21:06:21 +00:00
This way you can build and run ladybird without leaving the IDE.
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
Note that following will only help if you don't use an X-window server to access qemu.
Meta: Update Documentation and CI for repo move
2024-05-30 21:06:21 +00:00
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 ladybird inside of it.
Documentation: Reorganize the build documentation
2021-07-09 22:53:28 +00:00
Check the updated manual [here](BuildInstructionsWindows.md).
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
- 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`.
Meta: Update Documentation and CI for repo move
2024-05-30 21:06:21 +00:00
You may also want to copy `ladybird/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