RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 23:37:36 +00:00
Code Issues Activity Actions

Meta: Update all references of clang-format-14 to clang-format-15

Browse source 
Also, we add a section that describes how to get an updated clang-format
with multiple possible options to do that.
This commit is contained in:
Liav A 2022-12-04 16:32:33 +02:00 • committed by Andrew Kaster
parent 88ecc4a1e5
commit bef9ad4e44
4 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
Documentation/AdvancedBuildInstructions.md
View file

@ -213,3 +213,11 @@ of parallel compile tasks be setting the `MAKEJOBS` environment variable to a nu
Once the build script finishes, you can use it to compile SerenityOS. Either set the `SERENITY_TOOLCHAIN` build
option to `Clang` as shown [above](#cmake-build-options), or pass `Clang` as the TOOLCHAIN option to
`Meta/serenity.sh`, for example: `Meta/serenity.sh run i686 Clang`.
## Clang-format updates
There 3 options to acquire an updated clang-format tool:
1) If you have a Debian-based (apt-based) distribution, refer to [SelfHostedRunners.md](https://github.com/SerenityOS/serenity/blob/master/Documentation/SelfHostedRunners.md) document to learn more about using the LLVM apt repositories to install the latest clang-format tool.
2) Compile using `Toolchain/BuildClang.sh` as being pointed above use the compiled `Toolchain/Local/clang/bin/clang-format` binary.
3) Compile LLVM from source as pointed [here](https://llvm.org/docs/GettingStarted.html#compiling-the-llvm-suite-source-code).

2
Documentation/CodingStyle.md
View file

@ -2,7 +2,7 @@
For low-level styling (spaces, parentheses, brace placement, etc), all code should follow the format specified in `.clang-format` in the project root.
**Important: Make sure you use `clang-format` version 14 or later!**
**Important: Make sure you use `clang-format` version 15 or later!**
This document describes the coding style used for C++ code in the Serenity Operating System project. All new code should conform to this style.

2
Documentation/QtCreatorConfiguration.md
View file

@ -38,7 +38,7 @@ Qt Creator should be set up correctly now, go ahead and explore the project and
## Auto-Formatting
You can use `clang-format` to help you with the [style guide](CodingStyle.md). Before you proceed, check that you're actually using clang-format version 14, as some OSes will ship older clang-format versions by default.
You can use `clang-format` to help you with the [style guide](CodingStyle.md). Before you proceed, check that you're actually using clang-format version 15, as some OSes will ship older clang-format versions by default.
- In QtCreator, go to "Help > About Plugins…"
- Find the `Beautifier (experimental)` row (for example, by typing `beau` into the search)