Ports: Add ReadMe files explaining port patches that have explanations

14 files changed, 204 insertions, 0 deletions

diff --git a/Ports/SDL2-GNUBoy/patches/ReadMe.md b/Ports/SDL2-GNUBoy/patches/ReadMe.md
new file mode 100644
index 0000000000..fd16886b00
--- /dev/null
+++ b/Ports/SDL2-GNUBoy/patches/ReadMe.md
@@ -0,0 +1,6 @@
+# Patches for SDL2-GNUBoy
+
+## `fix-make.patch`
+
+Rewrites the makefile, presumably to make it work for serenity.
+
diff --git a/Ports/SDLPoP/patches/ReadMe.md b/Ports/SDLPoP/patches/ReadMe.md
new file mode 100644
index 0000000000..17fca39076
--- /dev/null
+++ b/Ports/SDLPoP/patches/ReadMe.md
@@ -0,0 +1,18 @@
+# Patches for SDLPoP
+
+## `sdl-path.patch`
+
+Use the correct path to refer to SDL (instead of a MacOS specific path)
+
+## `includes.patch`
+
+Use `SDL2/` paths for includes.
+
+## `disable_extra_features.patch`
+
+Disables some (presumably) unsupported features.
+
+## `remove_fscanf_unknwn_conversion_specfier.patch`
+
+Removes some (presumably) unsupported scanf specifiers.
+
diff --git a/Ports/SDL_sound/patches/ReadMe.md b/Ports/SDL_sound/patches/ReadMe.md
new file mode 100644
index 0000000000..c2ac5bfbd1
--- /dev/null
+++ b/Ports/SDL_sound/patches/ReadMe.md
@@ -0,0 +1,6 @@
+# Patches for SDL_sound
+
+## `fix_cmakelists.patch`
+
+Use `FindPkgConfig` to find SDL2 instead of `find_package`.
+
diff --git a/Ports/Super-Mario/patches/ReadMe.md b/Ports/Super-Mario/patches/ReadMe.md
new file mode 100644
index 0000000000..eefd91cb69
--- /dev/null
+++ b/Ports/Super-Mario/patches/ReadMe.md
@@ -0,0 +1,23 @@
+# Patches for Super-Mario
+
+## `cwd.patch`
+
+`chdir()`s to the installed directory before execution.
+
+## `gcc-11-static-initializers.patch`
+
+Removes global static initializers.
+Presumably not needed anymore.
+
+## `fix_cmakelists.patch`
+
+Use `FindPkgConfig` instead of `find_package()` to locate SDL2.
+
+## `fix_fireball_header.patch`
+
+Fixes a header include name.
+
+## `disable_graphic_acceleration.patch`
+
+Disables SDL2 hardware acceleration as we don't support that.
+
diff --git a/Ports/angband/patches/ReadMe.md b/Ports/angband/patches/ReadMe.md
new file mode 100644
index 0000000000..a55e0eceab
--- /dev/null
+++ b/Ports/angband/patches/ReadMe.md
@@ -0,0 +1,10 @@
+# Patches for angband
+
+## `use-sdl2-config.patch`
+
+Replaces uses of the system `sdl2-config` with the one from serenity.
+
+## `disable-accelerated-rendering.patch`
+
+Disable SDL2 hardware acceleration as we do not support that.
+
diff --git a/Ports/bash/patches/ReadMe.md b/Ports/bash/patches/ReadMe.md
new file mode 100644
index 0000000000..171c738f01
--- /dev/null
+++ b/Ports/bash/patches/ReadMe.md
@@ -0,0 +1,5 @@
+# Patches for bash
+
+## `include-sys-select.patch`
+
+Include `<sys/select.h>` before using it.
diff --git a/Ports/brogue/patches/ReadMe.md b/Ports/brogue/patches/ReadMe.md
new file mode 100644
index 0000000000..29527c4be3
--- /dev/null
+++ b/Ports/brogue/patches/ReadMe.md
@@ -0,0 +1,5 @@
+# Patches for brogue
+
+## `config.patch`
+
+Switches the DATADIR to the installed directory.
diff --git a/Ports/dmidecode/patches/ReadMe.md b/Ports/dmidecode/patches/ReadMe.md
new file mode 100644
index 0000000000..ce783b3e21
--- /dev/null
+++ b/Ports/dmidecode/patches/ReadMe.md
@@ -0,0 +1,5 @@
+# Patches for dmidecode
+
+## `dmidecode.patch`
+
+Remove IPv6 uses and set the correct path for the dmi firmware.
diff --git a/Ports/dos2unix/patches/ReadMe.md b/Ports/dos2unix/patches/ReadMe.md
new file mode 100644
index 0000000000..83e3b47c5b
--- /dev/null
+++ b/Ports/dos2unix/patches/ReadMe.md
@@ -0,0 +1,5 @@
+# Patches for dos2unix
+
+## `Makefile.patch`
+
+Link with `-lintl`.
diff --git a/Ports/dungeonrush/patches/ReadMe.md b/Ports/dungeonrush/patches/ReadMe.md
new file mode 100644
index 0000000000..b0f4b905c7
--- /dev/null
+++ b/Ports/dungeonrush/patches/ReadMe.md
@@ -0,0 +1,9 @@
+# Patches for dungeonrush
+
+## `sw-renderer.patch`
+
+Disable SDL hardware acceleration.
+
+## `cwd.patch`
+
+`chdir()` to the installed directory as the game tries to load resources with relative paths.
diff --git a/Ports/glib/patches/README.md b/Ports/glib/patches/ReadMe.md
index 3918a11443..3918a11443 100644
--- a/Ports/glib/patches/README.md
+++ b/Ports/glib/patches/ReadMe.md
diff --git a/Ports/libuv/patches/ReadMe.md b/Ports/libuv/patches/ReadMe.md
new file mode 100644
index 0000000000..92f7af10a4
--- /dev/null
+++ b/Ports/libuv/patches/ReadMe.md
@@ -0,0 +1,72 @@
+# Patches for LibUV on SerenityOS
+
+## `0001-unix-Stub-out-get-set-priority-for-serenity.patch`
+
+Serenity does not have `{get,set}priority()`, this stubs them out.
+
+### Status
+- [X] Local?
+- [ ] Should be merged to upstream?
+- [X] Resolves issues(s) with our side of things
+- [X] Hack
+
+## `0002-fs-Stub-out-unsupported-syscalls.patch`
+
+Makes libuv use `statvfs` instead of `statfs`.
+
+### Status
+- [ ] Local?
+- [X] Should be merged to upstream?
+- [ ] Resolves issues(s) with our side of things
+- [ ] Hack
+
+## `0003-stream-Don-t-use-AF_INET6.patch`
+
+Serenity does not support IPv6, this removes them.
+
+### Status
+- [ ] Local?
+- [ ] Should be merged to upstream?
+- [X] Resolves issues(s) with our side of things
+- [ ] Hack
+
+## `0004-tcp-Don-t-use-SO_LINGER.patch`
+
+Serenity does not support `SO_LINGER`, this removes them.
+
+### Status
+- [ ] Local?
+- [ ] Should be merged to upstream?
+- [X] Resolves issues(s) with our side of things
+- [X] Hack
+
+## `0005-build-Add-SerenityOS-platform-definitions.patch`
+
+Adds SerenityOS platform definitions to the build.
+
+### Status
+- [ ] Local?
+- [X] Should be merged to upstream?
+- [ ] Resolves issues(s) with our side of things
+- [ ] Hack
+
+## `0006-include-Teach-the-header-about-serenity.patch`
+
+Make the header include guards understand that SerenityOS is a thing.
+
+### Status
+- [ ] Local?
+- [X] Should be merged to upstream?
+- [ ] Resolves issues(s) with our side of things
+- [ ] Hack
+
+## `0007-build-Add-platform-specific-stubs-and-implementation.patch`
+
+Adds implementations for libuv's primitives specific to SerenityOS.
+
+### Status
+- [ ] Local?
+- [X] Should be merged to upstream?
+- [ ] Resolves issues(s) with our side of things
+- [ ] Hack
+
diff --git a/Ports/llvm/patches/ReadMe.md b/Ports/llvm/patches/ReadMe.md
index 1f20713004..815e5a3336 100644
--- a/Ports/llvm/patches/ReadMe.md
+++ b/Ports/llvm/patches/ReadMe.md
@@ -32,3 +32,14 @@ stack-smashing protection and building position-independent executables by defau
 - [x] Should be merged to upstream?
 - [ ] Resolves issue(s) with our side of things
 - [ ] Hack
+
+## `llvm-backport-objcopy-update-section.patch`
+
+Backports support for `llvm-objcopy --update-section` used by our toolchain from reviews.llvm.org/D112116.
+
+### Status
+- [ ] Local?
+- [ ] Should be merged to upstream?
+- [ ] Resolves issues(s) with our side of things
+- [ ] Hack
+
diff --git a/Ports/mold/patches/ReadMe.md b/Ports/mold/patches/ReadMe.md
new file mode 100644
index 0000000000..597cbc1010
--- /dev/null
+++ b/Ports/mold/patches/ReadMe.md
@@ -0,0 +1,29 @@
+# Patches for mold on SerenityOS
+
+## `0001-Disable-mold_preload.so-for-Serenity.patch`
+This feature depends on RTLD_NEXT capabilities which are not yet
+implemented in the Serenity DynamicLoader.
+
+## `0002-Disable-mimalloc-for-serenity.patch`
+mimalloc needs some help to compile on serenity. That's one yak too
+far for right now.
+
+## `0004-Add-POSIX-headers-for-timeval-and-select.patch`
+mold was relying on other libc implementations leaking these definitions
+from other headers.
+
+## `0005-Tell-TBB-that-SerenityOS-does-not-support-weak-symbo.patch`
+Something about the Clang toolchain configuration causes undefined weak
+references to scalable_malloc to remain in the mold executable even
+though there's no chance we'll be loading the tbbmalloc library at
+runtime. So, just lie to TBB that we don't support weak symbols.
+
+## `0006-Tell-TBB-that-SerenityOS-libraries-are-named-like-BS.patch`
+We won't be loading these libraries when building TBB as a static
+library for mold, but the OS detection logic still needs updated.
+
+## `0007-Stub-out-a-definition-of-RTLD_NOLOAD.patch`
+SerenityOS's DynamicLoader doesn't support this flag. However, we won't
+be dynamically loading any tbb extensions for the static library build
+mold uses, so we can just define it as a no-op as the code paths that
+use it will never be used.