Update user-patches and hardened config docs (closes #779) (#801)

Frogging-Family · Aug 31, 2023 · 7b4bf31 · 7b4bf31
1 parent e4bcfc8
commit 7b4bf31
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -50,7 +50,7 @@ The `customization.cfg` file offers many toggles for extra tweaks:
 - ...
 #### User patches
 
-To apply your own patch files using the provided scripts, you will need to put them in a `linux5y-tkg-userpatches` folder -- `y` needs to be changed with the kernel version the patch works on, _e.g_ `linux510-tkg-userpatches` -- at the same level as the `PKGBUILD` file, with the `.mypatch` extension. The script will by default ask if you want to apply them, one by one. The option `_user_patches` should be set to `true` in the `customization.cfg` file for this to work.
+To apply your own patch files using the provided scripts, you will need to put them in a `linux<VERSION><PATCHLEVEL>-tkg-userpatches` folder -- where _VERSION_ and _PATCHLEVEL_ are the kernel version and patch level, as specified in [linux Makefile](https://github.com/torvalds/linux/blob/master/Makefile), the patch works on, _e.g_ `linux65-tkg-userpatches` -- at the same level as the `PKGBUILD` file, with the `.mypatch` extension. The script will by default ask if you want to apply them, one by one. The option `_user_patches` should be set to `true` in the `customization.cfg` file for this to work.
 
 #### Anbox usage
 

diff --git a/customization.cfg b/customization.cfg
@@ -77,7 +77,7 @@ _dracut_options="--lz4"
 # Default (empty)  : "config.x86_64" from the linux-tkg-config/5.y folder.
 # "running-kernel" : Picks the .config file from the currently running kernel.
 #                    It is recommended to be running an official kernel before running this script, to pick off a correct .config file
-# "config_hardened.x86_64" : config file for a hardened kernel, available for kernel version "5.13", "5.10" and "5.4" .
+# "config_hardened.x86_64" : config file for a hardened kernel, available for kernel version "5.15", "5.13", "5.11", "5.10", "5.7", "5.4".
 #                            To get a complete hardened setup, you have to use "cfs" as _cpusched.
 # User provided value : custom user provided file, the given path should be relative to the PKGBUILD file. This enables for example to use a user stripped down .config file.
 #         If the .config file isn't up to date with the chosen kernel version, any extra CONFIG_XXXX is set to its default value.
@@ -284,7 +284,7 @@ _mglru="true"
 # example: _community_patches="clear_nack_in_tend_isr.myrevert ffb_regression_fix.mypatch 0008-drm-amd-powerplay-force-the-trim-of-the-mclk-dpm-levels-if-OD-is-enabled.mypatch"
 _community_patches=""
 
-# You can use your own patches by putting them in a subfolder called linux<version>-tkg-userpatches (e.g. linux510-tkg-userpatches) next to the PKGBUILD and giving them the .mypatch extension.
+# You can use your own patches by putting them in a subfolder called linux<VERSION><PATCHLEVEL>-tkg-userpatches (see README.md for more info) next to the PKGBUILD and giving them the .mypatch extension.
 # You can also revert patches by putting them in that same folder and giving them the .myrevert extension.
 
 # Also, userpatches variable below must be set to true for the above to work.