RGBCube/serenity
1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 12:47:35 +00:00
Code Issues Activity Actions

Documentation: Fix a few typos

Browse source
This commit is contained in:
Nico Weber 2022-12-27 13:40:23 -05:00 • committed by Brian Gianforcaro
parent 7f52f45e9d
commit 7aa9413b53
4 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Documentation/AdvancedBuildInstructions.md
View file

@ -204,7 +204,7 @@ can't be built with Clang yet.
To build the Clang-based toolchain, run `BuildClang.sh` from the `Toolchain` directory. The script will build a Clang To build the Clang-based toolchain, run `BuildClang.sh` from the `Toolchain` directory. The script will build a Clang
toolchain that is capable of building applications for the build host and serenity, toolchain that is capable of building applications for the build host and serenity,
for all supported architecutres (i686, x86_64 and aarch64). for all supported architectures (i686, x86_64 and aarch64).
**Warning:** While the build script is running, your computer may slow down extremely or even lock up for short **Warning:** While the build script is running, your computer may slow down extremely or even lock up for short
intervals. This generally happens if you have more CPU cores than free RAM in gigabytes. To fix this, limit the number intervals. This generally happens if you have more CPU cores than free RAM in gigabytes. To fix this, limit the number

2
Documentation/BuildInstructions.md
View file

@ -47,7 +47,7 @@ Serenity-specific patches were upstreamed to CMake in major version 3.25. To avo
patches to CMake, the minimum required CMake to build Serenity is set to that version. patches to CMake, the minimum required CMake to build Serenity is set to that version.
If more patches are upstreamed to CMake, the minimum will be bumped again once that version releases. If more patches are upstreamed to CMake, the minimum will be bumped again once that version releases.
To accomodate distributions that do not ship bleeding-edge CMake versions, the build scripts will To accommodate distributions that do not ship bleeding-edge CMake versions, the build scripts will
attempt to build CMake from source if the version on your path is older than 3.25.x. attempt to build CMake from source if the version on your path is older than 3.25.x.
### Windows ### Windows

2
Documentation/BuildInstructionsMacOS.md
View file

@ -45,5 +45,5 @@ Installing macfuse for the first time requires enabling its system extension in
It's important to make sure that Xcode is not only installed but also accordingly updated, otherwise CMake will run into incompatibilities with GCC. It's important to make sure that Xcode is not only installed but also accordingly updated, otherwise CMake will run into incompatibilities with GCC.
Homebrew is known to ship bleeding edge CMake versions, but building CMake from source with homebrew Homebrew is known to ship bleeding edge CMake versions, but building CMake from source with homebrew
gcc or llvm may not work. If homebrew does not offer cmake 3.25.x+ on your platform, it may be neccessary gcc or llvm may not work. If homebrew does not offer cmake 3.25.x+ on your platform, it may be necessary
to manually run Toolchain/BuildCMake.sh with Apple clang from Xcode as the first compiler in your $PATH. to manually run Toolchain/BuildCMake.sh with Apple clang from Xcode as the first compiler in your $PATH.

6
Documentation/Kernel/DevelopmentGuidelines.md
View file

@ -34,7 +34,7 @@ An exception to this is when there's simply no way to propagate the error code t
Maybe it's a `ATAPort` (in the IDE ATA code) that asynchronously tries to handle reading data from the harddrive, Maybe it's a `ATAPort` (in the IDE ATA code) that asynchronously tries to handle reading data from the harddrive,
but because of the async operation, we can't send the `errno` code back to userland, so we what we do is but because of the async operation, we can't send the `errno` code back to userland, so we what we do is
to ensure that internal functions still use the `ErrorOr<>` return type, and in main calling function, we use to ensure that internal functions still use the `ErrorOr<>` return type, and in main calling function, we use
other meaningful infrastructure utilties in the Kernel to indicate that the operation failed. other meaningful infrastructure utilities in the Kernel to indicate that the operation failed.
## We don't break userspace - the SerenityOS version ## We don't break userspace - the SerenityOS version
@ -58,7 +58,7 @@ each git commit is bisectable by itself.
**It's expected that changes to the Kernel will be tested with userland utilities to ensure the changes **It's expected that changes to the Kernel will be tested with userland utilities to ensure the changes
are not creating any misbehaves in the userland functionality.** are not creating any misbehaves in the userland functionality.**
Even more strictier than what has been said above - we don't remove functionality unless it's absolutely Even more stricter than what has been said above - we don't remove functionality unless it's absolutely
clear that nobody uses that functionality. Even when it's absolutely clear that nobody uses some kind clear that nobody uses that functionality. Even when it's absolutely clear that nobody uses some kind
of kernel functionality, it could still be useful to think about how to make it more available and usable of kernel functionality, it could still be useful to think about how to make it more available and usable
to the SerenityOS project community. to the SerenityOS project community.
@ -112,7 +112,7 @@ in the past and many of them were removed eventually.**
We, as the SerenityOS project, take seriously the concept of security information. We, as the SerenityOS project, take seriously the concept of security information.
Many security mitigations have been implemented in the Kernel, and are documented in a Many security mitigations have been implemented in the Kernel, and are documented in a
[different file](../../Base/usr/share/man/man7/Mitigations.md). [different file](../../Base/usr/share/man/man7/Mitigations.md).
As kernel developers, we should be even more strictier on the security measures being As kernel developers, we should be even more stricter on the security measures being
taken than the rest of system. taken than the rest of system.
One of the core guidelines in that aspect **is to never undermine any security measure One of the core guidelines in that aspect **is to never undermine any security measure
that was implemented, at the very least.** that was implemented, at the very least.**