From ee47c0275e2ce130c4b8883cc71a84e6bdbf2403 Mon Sep 17 00:00:00 2001 From: Ben Wiederhake Date: Sat, 6 May 2023 16:28:34 +0200 Subject: [PATCH] Everywhere: Run spellcheck on all documentation --- AK/HashTable.h | 4 ++-- AK/RedBlackTree.h | 8 ++++---- Base/usr/share/man/man5/GML/Widget/Toolbar.md | 4 ++-- Base/usr/share/man/man5/postcreate.md | 2 +- Base/usr/share/man/man6/Minesweeper.md | 2 +- Base/usr/share/man/man7/Mitigations.md | 2 +- Documentation/LadybirdBuildInstructions.md | 8 ++++---- Documentation/RunningOnRaspberryPi.md | 4 ++-- Ports/README.md | 2 +- Tests/AK/TestHashTable.cpp | 2 +- Userland/Libraries/LibGfx/GradientPainting.cpp | 2 +- Userland/Libraries/LibVideo/VP9/LookupTables.h | 2 +- Userland/Libraries/LibVideo/VP9/Parser.cpp | 4 ++-- Userland/Libraries/LibVideo/VP9/ProbabilityTables.cpp | 4 ++-- Userland/Libraries/LibVideo/VP9/Symbols.h | 2 +- 15 files changed, 26 insertions(+), 26 deletions(-) diff --git a/AK/HashTable.h b/AK/HashTable.h index c9c9e00ad7..b74b404f95 100644 --- a/AK/HashTable.h +++ b/AK/HashTable.h @@ -668,7 +668,7 @@ private: // that we can still probe for buckets with collisions, and we automatically optimize the // probe lengths. To do so, we shift the following buckets up until we reach a free bucket, // or a bucket with a probe length of 0 (the ideal index for that bucket). - auto update_bucket_neighbours = [&](BucketType* bucket) { + auto update_bucket_neighbors = [&](BucketType* bucket) { if constexpr (IsOrdered) { if (bucket->previous) bucket->previous->next = bucket; @@ -704,7 +704,7 @@ private: shift_from_bucket->next = nullptr; } shift_to_bucket->state = bucket_state_for_probe_length(shift_from_probe_length - 1); - update_bucket_neighbours(shift_to_bucket); + update_bucket_neighbors(shift_to_bucket); if (++shift_to_index == m_capacity) [[unlikely]] shift_to_index = 0; diff --git a/AK/RedBlackTree.h b/AK/RedBlackTree.h index 54a0f357f1..11bc141359 100644 --- a/AK/RedBlackTree.h +++ b/AK/RedBlackTree.h @@ -243,9 +243,9 @@ protected: // in place, this is quite a bit more expensive, as well as much less readable, is there a better way? if (node->left_child && node->right_child) { auto* successor_node = successor(node); // this is always non-null as all nodes besides the maximum node have a successor, and the maximum node has no right child - auto neighbour_swap = successor_node->parent == node; + auto neighbor_swap = successor_node->parent == node; node->left_child->parent = successor_node; - if (!neighbour_swap) + if (!neighbor_swap) node->right_child->parent = successor_node; if (node->parent) { if (node->parent->left_child == node) { @@ -258,7 +258,7 @@ protected: } if (successor_node->right_child) successor_node->right_child->parent = node; - if (neighbour_swap) { + if (neighbor_swap) { successor_node->parent = node->parent; node->parent = successor_node; } else { @@ -274,7 +274,7 @@ protected: swap(node->parent, successor_node->parent); } swap(node->left_child, successor_node->left_child); - if (neighbour_swap) { + if (neighbor_swap) { node->right_child = successor_node->right_child; successor_node->right_child = node; } else { diff --git a/Base/usr/share/man/man5/GML/Widget/Toolbar.md b/Base/usr/share/man/man5/GML/Widget/Toolbar.md index 8a6a63db98..0490271c6d 100644 --- a/Base/usr/share/man/man5/GML/Widget/Toolbar.md +++ b/Base/usr/share/man/man5/GML/Widget/Toolbar.md @@ -8,7 +8,7 @@ Defines a GUI toolbar widget. When `collapsible` is set to `true`, the toolbar can be resized below the size of its items. Any items that do not fit the current size, will be placed in an overflow menu. -To keep groups (i.e. Buttons/items separated by Separators) together, and move them to the overflow menu as one, set the `gouped` property. +To keep groups (i.e. Buttons/items separated by Separators) together, and move them to the overflow menu as one, set the `grouped` property. ## Synopsis @@ -29,4 +29,4 @@ To keep groups (i.e. Buttons/items separated by Separators) together, and move t | Property | Type | Possible values | Description | |-------------|------|-----------------|---------------------------------------------------------------------------------------| | collapsible | bool | true or false | If items that do not fit should be placed in an overflow menu | -| grouped | bool | true or false | If items should be moved to the overflow menu in groups, separated by Separator items | \ No newline at end of file +| grouped | bool | true or false | If items should be moved to the overflow menu in groups, separated by Separator items | diff --git a/Base/usr/share/man/man5/postcreate.md b/Base/usr/share/man/man5/postcreate.md index d7be930ed8..a688adef75 100644 --- a/Base/usr/share/man/man5/postcreate.md +++ b/Base/usr/share/man/man5/postcreate.md @@ -8,7 +8,7 @@ postcreate - HackStudio postcreate scripts ## Description -It is possible to define project templates that set up HackStudio projects. These templates can contain custom setup logic in the form of a `*.postcreate` script in the template directory. The script name must match the template's (directory) name. Postcreate scripts are regular shell scripts. They are executed from an undeterminate directory with the following arguments: +It is possible to define project templates that set up HackStudio projects. These templates can contain custom setup logic in the form of a `*.postcreate` script in the template directory. The script name must match the template's (directory) name. Postcreate scripts are regular shell scripts. They are executed from an indeterminate directory with the following arguments: - The path to the postcreate script - The name of the new project diff --git a/Base/usr/share/man/man6/Minesweeper.md b/Base/usr/share/man/man6/Minesweeper.md index 8e83881014..4f97bab183 100644 --- a/Base/usr/share/man/man6/Minesweeper.md +++ b/Base/usr/share/man/man6/Minesweeper.md @@ -14,6 +14,6 @@ $ Minesweeper The goal is to find all the mines without detonating them. -The player reveals what is underneath a tile by clicking on it. If it is a mine underneath the player loses. Otherwise the tile will show how many neighbouring mines there are to the tile. If there are no neighboring mines, all the neighboring tiles are revealed recursively. +The player reveals what is underneath a tile by clicking on it. If it is a mine underneath the player loses. Otherwise the tile will show how many neighboring mines there are to the tile. If there are no neighboring mines, all the neighboring tiles are revealed recursively. The player can mark a tile as being a mine by right-clicking the tile. This is then shown with a flag. diff --git a/Base/usr/share/man/man7/Mitigations.md b/Base/usr/share/man/man7/Mitigations.md index ad8cdd9336..4f890e56f8 100644 --- a/Base/usr/share/man/man7/Mitigations.md +++ b/Base/usr/share/man/man7/Mitigations.md @@ -341,7 +341,7 @@ Build + LibC: Enable -fstack-protector-strong in user space The kernel applies a exploit mitigation technique where vulnerable data related to the state of a process is separated out into it's own region -in memory which is always remmaped as read-only after it's initialized +in memory which is always remapped as read-only after it's initialized or updated. This means that an attacker needs more than an arbitrary kernel write primitive to be able to elevate a process to root for example. diff --git a/Documentation/LadybirdBuildInstructions.md b/Documentation/LadybirdBuildInstructions.md index aadb68c62b..c836166594 100644 --- a/Documentation/LadybirdBuildInstructions.md +++ b/Documentation/LadybirdBuildInstructions.md @@ -48,7 +48,7 @@ brew install cmake qt ninja On OpenIndiana: -Note that OpenIndianas latest GCC port (GCC 11) is too old to build Ladybird, so you need Clang, which is available in the repository. +Note that OpenIndiana's latest GCC port (GCC 11) is too old to build Ladybird, so you need Clang, which is available in the repository. ``` pfexec pkg install cmake ninja clang-15 libglvnd qt6 @@ -130,7 +130,7 @@ The `serenity.sh` build script does not know how to generate Xcode projects, so To be compatible with the script, a few extra options are required. If there is a previous Lagom build directory, CMake will likely complain that the generator has changed. ``` -cmake -GXcode -S Meta/Lagom -B Build/lagom -DBUILD_LAGOM=ON -DENABLE_LAGOM_LADBIRD=ON +cmake -GXcode -S Meta/Lagom -B Build/lagom -DBUILD_LAGOM=ON -DENABLE_LAGOM_LADYBIRD=ON ``` Alternatively, if you don't need your ladybird build to be compatible with `serenity.sh`, you can use Ladybird as the source directory like so: @@ -139,7 +139,7 @@ Alternatively, if you don't need your ladybird build to be compatible with `sere cmake -GXcode -S Ladybird -B Build/ladybird ``` -After generating an Xcode project into the specified build directory, you can open `ladbyird.xcodeproj` in Xcode. The project has a ton of targets, many of which are generated code. +After generating an Xcode project into the specified build directory, you can open `ladybird.xcodeproj` in Xcode. The project has a ton of targets, many of which are generated code. The only target that needs a scheme is the ladybird app bundle. In order for the application to launch properly through Xcode, the `SERENITY_SOURCE_DIR` environment variable must be set to your serenity checkout in the ladybird scheme, per the @@ -193,7 +193,7 @@ Next, create a build configuration in Qt Creator that uses an ``Android Qt 6.4.0 Ensure that you get Android API 30 or higher, and Android NDK 24 or higher. In the initial standup, an API 33 SDK for Android 13 was used. -Setup Android device settings in Qt Creator following this [link](https://doc.qt.io/qtcreator/creator-developing-android.html). Note that Qt Creator might not like the Android NDK version 24 we downloaded earlier, as it's "too new" and "not supported". No worries, we can force it to like our version by editing the ``sdk_defintions.json`` file as described under [Viewing Android Tool Chain Settings](https://doc.qt.io/qtcreator/creator-developing-android.html#viewing-android-tool-chain-settings). +Setup Android device settings in Qt Creator following this [link](https://doc.qt.io/qtcreator/creator-developing-android.html). Note that Qt Creator might not like the Android NDK version 24 we downloaded earlier, as it's "too new" and "not supported". No worries, we can force it to like our version by editing the ``sdk_definitions.json`` file as described under [Viewing Android Tool Chain Settings](https://doc.qt.io/qtcreator/creator-developing-android.html#viewing-android-tool-chain-settings). The relevant snippets of that JSON file are reproduced below. Just have to make sure it's happy with "platforms;android-33" and the exact installed NDK version. diff --git a/Documentation/RunningOnRaspberryPi.md b/Documentation/RunningOnRaspberryPi.md index b4f0e77cb5..24c0938e25 100644 --- a/Documentation/RunningOnRaspberryPi.md +++ b/Documentation/RunningOnRaspberryPi.md @@ -2,11 +2,11 @@ ## NOTE -This is for development purposes only - Serenity doesn't currently boot on Rasperry Pi! Use this guide if you want to set up a development environment. +This is for development purposes only - Serenity doesn't currently boot on Raspberry Pi! Use this guide if you want to set up a development environment. Currently only UART output is supported, no display. -64-bit only, so you need a Rasperry Pi 3 or newer. +64-bit only, so you need a Raspberry Pi 3 or newer. ## Running in QEMU diff --git a/Ports/README.md b/Ports/README.md index 560989b42f..705a96a68f 100644 --- a/Ports/README.md +++ b/Ports/README.md @@ -295,7 +295,7 @@ filename. #### `workdir` The working directory used for executing other commands via `run` as well as -cleanup. Usually the directory name of the upacked source archive. +cleanup. Usually the directory name of the unpacked source archive. Defaults to `$port-$version`. diff --git a/Tests/AK/TestHashTable.cpp b/Tests/AK/TestHashTable.cpp index 47b13da09f..5592871ed1 100644 --- a/Tests/AK/TestHashTable.cpp +++ b/Tests/AK/TestHashTable.cpp @@ -347,7 +347,7 @@ TEST_CASE(ordered_deletion_and_reinsertion) EXPECT_EQ(table.size(), 1u); // By adding 1 again but this time in a different position, we - // test whether the bucket's neighbours are reset properly. + // test whether the bucket's neighbors are reset properly. table.set(1); EXPECT_EQ(table.size(), 2u); diff --git a/Userland/Libraries/LibGfx/GradientPainting.cpp b/Userland/Libraries/LibGfx/GradientPainting.cpp index accdfed9a9..8e98b31ceb 100644 --- a/Userland/Libraries/LibGfx/GradientPainting.cpp +++ b/Userland/Libraries/LibGfx/GradientPainting.cpp @@ -111,7 +111,7 @@ public: auto int_loc = static_cast(floor(loc)); auto blend = loc - int_loc; auto color = get_color(repeat_wrap_if_required(int_loc)); - // Blend between the two neighbouring colors (this fixes some nasty aliasing issues at small angles) + // Blend between the two neighboring colors (this fixes some nasty aliasing issues at small angles) if (blend >= 0.004f) color = color_blend(color, get_color(repeat_wrap_if_required(int_loc + 1)), blend); return color; diff --git a/Userland/Libraries/LibVideo/VP9/LookupTables.h b/Userland/Libraries/LibVideo/VP9/LookupTables.h index 8d4ac6a8d0..9c7f1dc244 100644 --- a/Userland/Libraries/LibVideo/VP9/LookupTables.h +++ b/Userland/Libraries/LibVideo/VP9/LookupTables.h @@ -295,7 +295,7 @@ static constexpr u8 cat_probs[7][14] = { { 254, 254, 254, 252, 249, 243, 230, 196, 177, 153, 140, 133, 130, 129 } }; -static constexpr MotionVector mv_ref_blocks[BLOCK_SIZES][MVREF_NEIGHBOURS] = { +static constexpr MotionVector mv_ref_blocks[BLOCK_SIZES][MVREF_NEIGHBORS] = { { { -1, 0 }, { 0, -1 }, { -1, -1 }, { -2, 0 }, { 0, -2 }, { -2, -1 }, { -1, -2 }, { -2, -2 } }, { { -1, 0 }, { 0, -1 }, { -1, -1 }, { -2, 0 }, { 0, -2 }, { -2, -1 }, { -1, -2 }, { -2, -2 } }, { { -1, 0 }, { 0, -1 }, { -1, -1 }, { -2, 0 }, { 0, -2 }, { -2, -1 }, { -1, -2 }, { -2, -2 } }, diff --git a/Userland/Libraries/LibVideo/VP9/Parser.cpp b/Userland/Libraries/LibVideo/VP9/Parser.cpp index a6f9bc716c..7128bddce6 100644 --- a/Userland/Libraries/LibVideo/VP9/Parser.cpp +++ b/Userland/Libraries/LibVideo/VP9/Parser.cpp @@ -1705,7 +1705,7 @@ MotionVectorPair Parser::find_reference_motion_vectors(BlockContext& block_conte } block_context.mode_context[reference_frame] = counter_to_context[context_counter]; - for (auto i = 2u; i < MVREF_NEIGHBOURS; i++) { + for (auto i = 2u; i < MVREF_NEIGHBORS; i++) { MotionVector candidate = base_coordinates + mv_ref_blocks[block_context.size][i]; if (motion_vector_is_inside_tile(block_context.tile_context, candidate)) { different_ref_found = true; @@ -1716,7 +1716,7 @@ MotionVectorPair Parser::find_reference_motion_vectors(BlockContext& block_conte add_motion_vector_if_reference_frame_type_is_same(block_context, base_coordinates, reference_frame, list, true); if (different_ref_found) { - for (auto i = 0u; i < MVREF_NEIGHBOURS; i++) { + for (auto i = 0u; i < MVREF_NEIGHBORS; i++) { MotionVector candidate = base_coordinates + mv_ref_blocks[block_context.size][i]; if (motion_vector_is_inside_tile(block_context.tile_context, candidate)) add_motion_vector_if_reference_frame_type_is_different(block_context, candidate, reference_frame, list, false); diff --git a/Userland/Libraries/LibVideo/VP9/ProbabilityTables.cpp b/Userland/Libraries/LibVideo/VP9/ProbabilityTables.cpp index 2ecf4fb3ad..9c645cfa91 100644 --- a/Userland/Libraries/LibVideo/VP9/ProbabilityTables.cpp +++ b/Userland/Libraries/LibVideo/VP9/ProbabilityTables.cpp @@ -402,8 +402,8 @@ static constexpr InterModeProbs default_inter_mode_probs = { { 7, 166, 63 }, // 2 = two predicted mvs { 7, 94, 66 }, // 3 = one predicted/zero and one new mv { 8, 64, 46 }, // 4 = two new mvs - { 17, 81, 31 }, // 5 = one intra neighbour + x - { 25, 29, 30 }, // 6 = two intra neighbours + { 17, 81, 31 }, // 5 = one intra neighbor + x + { 25, 29, 30 }, // 6 = two intra neighbors }; static constexpr InterpFilterProbs default_interp_filter_probs = { diff --git a/Userland/Libraries/LibVideo/VP9/Symbols.h b/Userland/Libraries/LibVideo/VP9/Symbols.h index c367d5cb65..fe76729388 100644 --- a/Userland/Libraries/LibVideo/VP9/Symbols.h +++ b/Userland/Libraries/LibVideo/VP9/Symbols.h @@ -17,7 +17,7 @@ namespace Video::VP9 { #define REFS_PER_FRAME 3 #define MV_FR_SIZE 4 -#define MVREF_NEIGHBOURS 8 +#define MVREF_NEIGHBORS 8 #define BLOCK_SIZE_GROUPS 4 #define BLOCK_SIZES 13 #define BLOCK_INVALID 14