Browse Source

Add README with maintenance status for patches

Maximilian Luz 4 years ago
parent
commit
c67f887a61
1 changed files with 19 additions and 0 deletions
  1. 19 0
      patches/README.md

+ 19 - 0
patches/README.md

@@ -0,0 +1,19 @@
+# Linux Patches for Microsoft Surface Devices
+
+Patches are grouped in directory by kernel version and inside those directories split up in patch-sets based on their functionality.
+They should be used with the appropriate config fragments from the `/configs/<version>` directory.
+
+These patches are generated from the `-surface` branches of our [kernel repository][1].
+Please direct any pull-requests for new patches and kernel functionality to this repository, targetting the latest `-surface-devel` branch.
+
+## Maintained Versions
+
+The currently maintained versions are
+- [`5.11`](https://github.com/linux-surface/kernel/tree/v5.11-surface) (latest)
+- [`5.10`](https://github.com/linux-surface/kernel/tree/v5.10-surface) (latest LTS), and
+- [`4.19`](https://github.com/linux-surface/kernel/tree/v4.19-surface) (Surface LTS)
+
+Any other versions are only included for historical purposes.
+Unmaintained versions will likely (if necessary with a bit of re-basing) still work, but will not have the latest changes (so please don't report bugs for those).
+
+[1]: https://github.com/linux-surface/kernel