summaryrefslogtreecommitdiffstats
path: root/source/code.rst
diff options
authorKonstantin Ryabitsev <konstantin@linuxfoundation.org>2024-10-08 15:24:36 -0400
committerKonstantin Ryabitsev <konstantin@linuxfoundation.org>2024-10-08 15:24:36 -0400
commitf3216be1efae259f0551c744f03f7195640573e5 (patch)
tree5d97f6604a3f16ad1d5439126665f0ff12bed59c /source/code.rst
parent96836ca0c23f0f5eb766cfe0a39a72a3bc216f2a (diff)
downloadbackports-master.tar.gz
Final tweaks before publishingHEADmaster
Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Diffstat (limited to 'source/code.rst')
-rw-r--r--source/code.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/source/code.rst b/source/code.rst
new file mode 100644
index 0000000..4ceb072
--- /dev/null
+++ b/source/code.rst
@@ -0,0 +1,61 @@
+Code
+====
+
+In order to backport the Linux kernel we must divide and conquer the
+tasks at hand.
+
+This is now deprecated use :doc:`hacking on backports <documentation/backports/hacking>`.
+
+Backport components
+-------------------
+
+There are currently two components to the backports effort.
+
+compat
+~~~~~~
+
+compat is a shared module / headers that implements newer features for usage on older kernels.
+
+- git://github.com/mcgrof/compat.git>`__
+- :doc:`documentation/compat`
+
+compat-drivers
+~~~~~~~~~~~~~~
+
+compat-drivers is the framework that pulls code from the Linux kernel,
+adds the compat module and backports features that compat could not
+backport within its module / headers.
+
+- git://github.com/mcgrof/compat-drivers.git``
+- :doc:`documentation/compat-drivers`
+
+Getting all required code
+-------------------------
+
+To be able to make releases and test building releases however you need
+quite a bit more code. The setup is simplified with scripts from the
+compat.git tree. To set your system up for the first time you can run::
+
+ wget https://github.com/mcgrof/compat/raw/master/bin/get-compat-trees
+ wget https://github.com/mcgrof/compat/raw/master/bin/get-compat-kernels
+
+ chmod 755 get-compat-trees get-compat-kernels
+
+ ./get-compat-trees
+ ./get-compat-kernels
+
+Hacking on the project
+----------------------
+
+You should realize that there are a few components to the project and
+that although they are used together each one can be considered
+independent of each other.
+
+- Read the :doc:`hacking on compat documentation <documentation/compat>`
+- Read the :doc:`hacking on compat-drivers documentation <documentation/compat-drivers>`
+
+TODO list
+~~~~~~~~~
+
+Read the :doc:`hacking TODO <documentation/compat-drivers/hacking>` for
+a list of wish items we should be working towards.