Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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/",
}
Expand Down
2 changes: 1 addition & 1 deletion docs/explanation/stable-release-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
18 changes: 0 additions & 18 deletions docs/how-to/develop-customise/index.md

This file was deleted.

25 changes: 14 additions & 11 deletions docs/how-to/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,38 @@ 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}
:titlesonly:
:maxdepth: 1
:hidden:

Source code access and management </how-to/source-code/index>
Development and customization </how-to/develop-customise/index>
Enable kernel source package repositories </how-to/source-code/enable-source-repositories>
Obtain kernel source for an Ubuntu release using Git </how-to/source-code/obtain-kernel-source-git>
Send patches to the mailing-list </how-to/source-code/send-patches>
Build an Ubuntu Linux kernel </how-to/develop-customise/build-kernel>
Build an Ubuntu Linux kernel snap </how-to/develop-customise/build-kernel-snap>
Test kernels in -proposed </how-to/testing-verification/test-kernel-in-proposed>
Contribute to kernel docs </how-to/contribute>
```

## 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 </how-to/source-code/enable-source-repositories>`
- {doc}`Obtain kernel source for an Ubuntu release using Git </how-to/source-code/obtain-kernel-source-git>`
- {doc}`Send patches to the mailing-list </how-to/source-code/send-patches>`

## 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 </how-to/develop-customise/build-kernel>`
- {doc}`Build an Ubuntu Linux kernel snap </how-to/develop-customise/build-kernel-snap>`

## Testing and verification

Expand Down
1 change: 0 additions & 1 deletion docs/how-to/source-code/enable-source-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,3 @@ Once you have updated {file}`sources.list` or {file}`ubuntu.sources`, update the
```{code-block} shell
sudo apt update
```

19 changes: 0 additions & 19 deletions docs/how-to/source-code/index.md

This file was deleted.

34 changes: 19 additions & 15 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,43 +9,47 @@ myst:
Reference material about Ubuntu kernel development processes, terminology, and
more.

<!--
.. toctree::
:maxdepth: 1
:caption: Ubuntu on Xilinx:
## Kernel patch & contribution guidelines

xilinx/index
-->
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
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
```
Loading