mirror of
https://github.com/RGBCube/serenity
synced 2025-07-27 20:37:34 +00:00
Meta: Document QtCreator auto-format and compiler kits
This commit is contained in:
parent
154ffa3f5f
commit
7a8c72d136
1 changed files with 29 additions and 2 deletions
|
@ -1,11 +1,13 @@
|
||||||
## Using Qt Creator for working with SerenityOS
|
# Using Qt Creator for working with SerenityOS
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
First, make sure you have a working toolchain and can build and run SerenityOS. Go [here](https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md) for instructions for setting that up.
|
First, make sure you have a working toolchain and can build and run SerenityOS. Go [here](https://github.com/SerenityOS/serenity/blob/master/Documentation/BuildInstructions.md) for instructions for setting that up.
|
||||||
|
|
||||||
* Install [Qt Creator](https://www.qt.io/offline-installers). You don't need the entire Qt setup, just click 'Qt Creator' on the left side, and install that.
|
* Install [Qt Creator](https://www.qt.io/offline-installers). You don't need the entire Qt setup, just click 'Qt Creator' on the left side, and install that.
|
||||||
* Open Qt Creator, select `File -> New File or Project...`
|
* Open Qt Creator, select `File -> New File or Project...`
|
||||||
* Select `Import Existing Project`
|
* Select `Import Existing Project`
|
||||||
* Give it a name, and navigate to the root of your SerenityOS project checkout. Click Next.
|
* Give it a name (some tools assume lower-case `serenity`), and navigate to the root of your SerenityOS project checkout. Click Next.
|
||||||
* Wait for the file list to generate. This can take a minute or two!
|
* Wait for the file list to generate. This can take a minute or two!
|
||||||
* Ignore the file list, we will overwrite it later. Click Next.
|
* Ignore the file list, we will overwrite it later. Click Next.
|
||||||
* Set `Add to version control` to `<None>`. Click Finish.
|
* Set `Add to version control` to `<None>`. Click Finish.
|
||||||
|
@ -16,3 +18,28 @@ First, make sure you have a working toolchain and can build and run SerenityOS.
|
||||||
* Edit the `serenity.includes` file, add the following lines: `.`, `..`, `../..`, `Services/`, `Libraries/`, `Libraries/LibC/`, `Libraries/LibPthread/`, `Libraries/LibM/`, `Toolchain/Local/i686-pc-serenity/include/c++/10.1.0`, `Build/Services/`, `Build/Libraries/`, `AK/`
|
* Edit the `serenity.includes` file, add the following lines: `.`, `..`, `../..`, `Services/`, `Libraries/`, `Libraries/LibC/`, `Libraries/LibPthread/`, `Libraries/LibM/`, `Toolchain/Local/i686-pc-serenity/include/c++/10.1.0`, `Build/Services/`, `Build/Libraries/`, `AK/`
|
||||||
|
|
||||||
Qt Creator should be set up correctly now, go ahead and explore the project and try making changes. Have fun! :^)
|
Qt Creator should be set up correctly now, go ahead and explore the project and try making changes. Have fun! :^)
|
||||||
|
|
||||||
|
## Auto-Formatting
|
||||||
|
|
||||||
|
You can use `clang-format` to help you with the [style guide](https://github.com/SerenityOS/serenity/blob/master/Documentation/CodingStyle.md). Before you proceed, check that you're actually using clang-format version 10, as some OSes still ship clang-format version 9 by default.
|
||||||
|
|
||||||
|
- In QtCreator, go to "Help > About Plugins…"
|
||||||
|
- Find the `Beautifier (experimental)` row (for example, by typing `beau` into the search)
|
||||||
|
- Put a checkmark into the box
|
||||||
|
- Restart QtCreator if it asks you
|
||||||
|
- In QtCreator, go to "Tools > Options…"
|
||||||
|
- Type "beau" in the search box, go to "Beautifier > Clang Format"
|
||||||
|
- Select the "customized" style, click "edit"
|
||||||
|
- Paste the entire content of the file `.clang-format` into the "value" box, and click "OK"
|
||||||
|
- In the "Beatifier > General" tab, check "Enable auto format on file save"
|
||||||
|
- Select the tool "ClangFormat" if not already selected, and click "OK"
|
||||||
|
|
||||||
|
Note that not the entire project is clang-format-clean (yet), so sometimes you will see large diffs.
|
||||||
|
Use your own judgement whether you want to include such changes. Generally speaking, if it's a few lines then it's a good idea; if it's the entire file then maybe there's a better way to do it, like doing a separate commit, or just ignoring the clang-format changes.
|
||||||
|
|
||||||
|
You may want to read up what `git add -p` does (or `git checkout -p`, to undo).
|
||||||
|
|
||||||
|
## Compiler Kits
|
||||||
|
|
||||||
|
You can slightly improve how well Qt interprets the code by adding and setting up an appropriate "compiler kit".
|
||||||
|
For that you will need to reference the compilers at `Toolchain/Local/bin/i686-pc-serenity-gcc` and `Toolchain/Local/bin/i686-pc-serenity-g++`.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue