From 486ef6474e558073bc2dbc4de35255a360593144 Mon Sep 17 00:00:00 2001
From: projectmoon <projectmoon@agnos.is>
Date: Sun, 5 Mar 2023 09:03:33 +0000
Subject: [PATCH] Add kernel ebuild update documentation

---
 docs/Updating-Kernel-Ebuild.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 docs/Updating-Kernel-Ebuild.md

diff --git a/docs/Updating-Kernel-Ebuild.md b/docs/Updating-Kernel-Ebuild.md
new file mode 100644
index 0000000..23bc7a9
--- /dev/null
+++ b/docs/Updating-Kernel-Ebuild.md
@@ -0,0 +1,25 @@
+How to update the Linux-libre Kernel ebuild for a new version
+---
+
+1. Check for new stable version of `gentoo-kernel` on packages.gentoo.org.
+2. If so, version bump `libre-kernel` ebuild to match new
+   `gentoo-kernel` version.
+3. Check the `gentoo-kernel` ebuild for changes to the Gentoo config and
+   patches versions.
+4. If the Gentoo patchset version has changed:
+   1. Update the patchset version in the `libre-kernel` ebuild.
+   2. Extract the patchset from the `gentoo-kernel` ebuild and see if
+      there are any new patches, or patches removed.
+   2. Most patches aside from the `1000`- series that patch the entire
+      kernel should work.
+   3. Add all new patches that apply to the patchset in the ebuild.
+   4. Make sure ebuild applies patches with `ebuild
+      libre-kernel-X.Y.Z.ebuild clean prepare`.
+4. If the Gentoo config version has changed:
+   5. Update the config version in the `libre-kernel` ebuild.
+   6. Make sure ebuild applies config changes with `ebuild
+      libre-kernel-X.Y.Z.ebuild clean prepare`.
+5. Attempt to build the kernel using `ebuild libre-kernel-X.Y.Z.ebuild
+   clean merge`. You might need to use `sudo` or `doas` for this.
+
+If the build succeeds, the new ebuild can be pushed to the repository.