diff --git a/docs/conf.py b/docs/conf.py index da12f26..203692c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -207,7 +207,9 @@ redirects = { "reference/patch_acceptance_criteria/index.html": "../patch-acceptance-criteria/", - "how-to/develop-customize/": "how-to/develop-customise/", + "how-to/develop-customize/": "how-to/", + "how-to/develop-customise/": "how-to/", + "how-to/source-code/": "how-to/", "how-to/develop-customize/build-kernel/": "how-to/develop-customise/build-kernel/", "how-to/develop-customize/build-kernel-snap/": "how-to/develop-customise/build-kernel-snap/", } diff --git a/docs/explanation/stable-release-updates.md b/docs/explanation/stable-release-updates.md index a0ab80f..c62f244 100644 --- a/docs/explanation/stable-release-updates.md +++ b/docs/explanation/stable-release-updates.md @@ -133,7 +133,7 @@ model. [Ubuntu Kernel Team]: https://kernel.ubuntu.com/ [Ubuntu Wiki - Kernel Updates]: https://wiki.ubuntu.com/KernelTeam/KernelUpdates -[Ubuntu archive has a single proposed pocket]: https://canonical-ubuntu-packaging-guide.readthedocs-hosted.com/en/latest/explanation/archive/#archivepockets +[Ubuntu archive has a single proposed pocket]: https://documentation.ubuntu.com/project/how-ubuntu-is-made/concepts/package-archive/#proposed [Discourse - Ubuntu Kernel 4/2 SRU Cycle Announcement]: https://discourse.ubuntu.com/t/ubuntu-kernel-4-2-sru-cycle-announcement/37478 [Ubuntu Wiki - Stable Kernel Release Cadence]: https://wiki.ubuntu.com/Kernel/StableReleaseCadence [Kernel team stable dashboard]: https://kernel.ubuntu.com/reports/kernel-stable-board/ diff --git a/docs/how-to/develop-customise/index.md b/docs/how-to/develop-customise/index.md deleted file mode 100644 index a3961d6..0000000 --- a/docs/how-to/develop-customise/index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -myst: - html_meta: - description: "Build and customize Ubuntu kernels. Follow guides for building kernel packages and snaps across different platforms and architectures." ---- - -# Development and customization - -These guides cover how to build kernel packages, kernel snaps, and kernel -components. - -```{toctree} -:titlesonly: -:maxdepth: 1 - -Build a kernel -Build a kernel snap -``` diff --git a/docs/how-to/index.md b/docs/how-to/index.md index 0f9094f..64c3d68 100644 --- a/docs/how-to/index.md +++ b/docs/how-to/index.md @@ -6,7 +6,7 @@ myst: # How-to guides -These guides accompany through the various stages and building and publishing +These guides accompany through the various stages of building and publishing kernel packages and components. ```{toctree} @@ -14,27 +14,30 @@ kernel packages and components. :maxdepth: 1 :hidden: -Source code access and management -Development and customization +Enable kernel source package repositories +Obtain kernel source for an Ubuntu release using Git +Send patches to the mailing-list +Build an Ubuntu Linux kernel +Build an Ubuntu Linux kernel snap Test kernels in -proposed Contribute to kernel docs ``` ## Source code access and management -Get access to kernel source code if you need to modify the kernel for specific -requirements, optimize the performance for selected hardware, inspect the source -tree to build custom kernel modules, and more. +You can get access to kernel source code via `apt` or directly from the kernel Git repositories. +You can also check the formatting requirements, review process, and best practices for submitting kernel patches to the Ubuntu kernel team mailing list. -- [Obtain kernel source for an Ubuntu release using Git](/how-to/source-code/obtain-kernel-source-git) +- {doc}`Enable kernel source package repositories ` +- {doc}`Obtain kernel source for an Ubuntu release using Git ` +- {doc}`Send patches to the mailing-list ` ## Development and customization -The steps to build a kernel is similar but may have slightly difference -configuration requirements on different platforms and/or architectures. +The steps to build a kernel is similar but may have slightly difference configuration requirements on depending on the build package (snap, debs), platform and/or architectures. -- [Build an Ubuntu Linux kernel](/how-to/develop-customise/build-kernel) -- [Build an Ubuntu Linux kernel snap](/how-to/develop-customise/build-kernel-snap) +- {doc}`Build an Ubuntu Linux kernel ` +- {doc}`Build an Ubuntu Linux kernel snap ` ## Testing and verification diff --git a/docs/how-to/source-code/enable-source-repositories.md b/docs/how-to/source-code/enable-source-repositories.md index c972cee..a2c998c 100644 --- a/docs/how-to/source-code/enable-source-repositories.md +++ b/docs/how-to/source-code/enable-source-repositories.md @@ -46,4 +46,3 @@ Once you have updated {file}`sources.list` or {file}`ubuntu.sources`, update the ```{code-block} shell sudo apt update ``` - diff --git a/docs/how-to/source-code/index.md b/docs/how-to/source-code/index.md deleted file mode 100644 index 4089cb5..0000000 --- a/docs/how-to/source-code/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -myst: - html_meta: - description: "Find out where to obtain kernel sources via Git, enable repositories, and send patches to the mailing list." ---- - -# Source code access and management - -These guides cover processes related to obtaining kernel source trees and -preparing the kernel before the build process. - -```{toctree} -:titlesonly: -:maxdepth: 1 - -Obtain kernel source using Git -Enable kernel source package repositories -Send patches to the mailing-list -``` diff --git a/docs/reference/index.md b/docs/reference/index.md index 1ab695f..f3c66b2 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -9,17 +9,25 @@ myst: Reference material about Ubuntu kernel development processes, terminology, and more. - +It's important to follow the Ubuntu kernel patch guidelines so your contributions are accepted into the Ubuntu kernel tree without delays or rejection. +These pages show how to properly format and submit your patches. + +```{toctree} +:maxdepth: 1 + +stable-patch-format +patch-acceptance-criteria +``` + +## Kernel variants and snaps + +Different kernel variants and branches serve different purposes - long-term support, new hardware enablement, or experimental features. +Understanding them helps you choose the right kernel for testing, development, or deployment. ```{toctree} :maxdepth: 1 -:caption: Kernel variants and snaps ubuntu-kernels hwe-kernels @@ -27,25 +35,21 @@ oem-kernels snap-lifecycle ``` -```{toctree} -:maxdepth: 1 -:caption: Kernel patch guidelines +## Privileges -stable-patch-format -patch-acceptance-criteria -``` +Understand the criteria and process to apply for Ubuntu kernel and DKMS package upload rights. ```{toctree} :maxdepth: 1 -:caption: Privileges kernel-upload-rights dkms-upload-rights ``` +## General + ```{toctree} :maxdepth: 1 -:caption: General glossary ```