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
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ pa11y: pa11y-install html
find $(BUILDDIR) -name *.html -print0 | xargs -n 1 -0 $(PA11Y)

lint-md: pymarkdownlnt-install
@. $(VENV); pymarkdownlnt --config $(SPHINXDIR)/.pymarkdown.json scan --recurse --exclude=./$(SPHINXDIR)/** $(SOURCEDIR)
@. $(VENV); pymarkdownlnt --config $(SPHINXDIR)/.pymarkdown.json scan --recurse --exclude=$(SPHINXDIR) $(SOURCEDIR)

vale-install: install
@. $(VENV); test -f $(VALE_CONFIG) || python3 $(SPHINXDIR)/get_vale_conf.py
Expand Down
6 changes: 6 additions & 0 deletions docs/explanation/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Ubuntu kernel development processes, security policies, and stable release updates. Explore explanations of kernel sources and workflows."
---

# Explanation

The explanatory guides in this section talk about different aspects of the
Expand Down
6 changes: 6 additions & 0 deletions docs/explanation/post-release-updates.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Learn Ubuntu kernel security and update policies for post-release trees. Understand SRU criteria, patch submission process, and archive updates."
---

# Kernel security and update policy for post-release trees

This document describes the process and criteria for post-release kernel updates.
Expand Down
6 changes: 6 additions & 0 deletions docs/explanation/stable-release-updates.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Understand Ubuntu kernel stable release updates (SRU). Learn about the 4/2 cycle cadence, patch submission, review process, and kernel streams."
---

# About kernel stable release updates (SRU)

Every supported kernel for an Ubuntu release is part of a Stable Release Updates
Expand Down
6 changes: 6 additions & 0 deletions docs/explanation/ubuntu-linux-kernel-sources.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Overview of Ubuntu Linux kernel source repository structure, how to find Launchpad Git URLs, branches, and protocols for accessing source code."
---

# About Ubuntu Linux kernel sources

Ubuntu Linux kernel source packages are essential for users and developers who
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/develop-customise/build-kernel-snap.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Learn to build Ubuntu Linux kernel snaps. Follow detailed instructions for creating snap packages from kernel source code for local testing and development."
---

# How to build an Ubuntu Linux kernel snap

If you are running an Ubuntu Core system and want to use boot into a custom
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/develop-customise/build-kernel.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Step-by-step guide to build an Ubuntu Linux kernel from source. Learn prerequisites, configuration, customization, and installation procedures."
---

# How to build an Ubuntu Linux kernel

If you have patches you need to apply to the Ubuntu Linux kernel, or you want to
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/develop-customise/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
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
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Guides for Ubuntu kernel development. Learn how to obtain source code, build kernels, test in -proposed versions, and contribute to the documentation."
---

# How-to guides

These guides accompany through the various stages and building and publishing
Expand Down
7 changes: 6 additions & 1 deletion docs/how-to/source-code/enable-source-repositories.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Enable Ubuntu kernel source package repositories. Learn to configure sources.list or ubuntu.sources for kernel development and building."
---

# How to enable kernel source package repositories

If you want to build or modify an Ubuntu kernel package from source, you will first need the kernel source code.
Expand Down Expand Up @@ -31,7 +37,6 @@ file. If not, add or uncomment these lines for your Ubuntu release.
deb-src http://archive.ubuntu.com/ubuntu jammy main
deb-src http://archive.ubuntu.com/ubuntu jammy-updates main
```
````
`````

## Update package list
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/source-code/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
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
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/source-code/obtain-kernel-source-git.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Obtain Ubuntu kernel source code using Git. Follow step-by-step instructions for cloning kernel repositories for any Ubuntu release."
---

# How to obtain kernel source for an Ubuntu release using Git

The kernel source code for each Ubuntu release is maintained in its own
Expand Down
3 changes: 3 additions & 0 deletions docs/how-to/source-code/send-patches.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Submit kernel patches to the Ubuntu kernel team mailing list. Learn formatting requirements, review process, and best practices for patches.

.. _how-to-send-patches:

How to send patches to the mailing-list
Expand Down
6 changes: 6 additions & 0 deletions docs/how-to/testing-verification/test-kernel-in-proposed.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Learn to enable -proposed pocket, install test kernels, and verify stability of kernels before release."
---

# How to test kernels in -proposed

Ubuntu kernels are uploaded to the -proposed pocket for testing before being
Expand Down
6 changes: 6 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Official Ubuntu kernel documentation. Learn to build, customize, and contribute to Ubuntu kernels. Understand the cadence for stable release updates and HWE kernels."
---

# Ubuntu Kernel documentation

The Ubuntu Linux kernel is the core software enabling applications on Ubuntu to
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/dkms-upload-rights.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: DKMS (Dynamic Kernel Module Support) upload rights for Ubuntu. Understand permissions, responsibilities, and application procedures.

DKMS upload rights
##################

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/glossary.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Ubuntu kernel terminology glossary. Find definitions for SRU, DKMS, HWE, edge kernels, and other kernel development terms. Quick reference guide."
---

# Kernel glossary

This page is a running list of terminology that is frequently used when talking
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/hwe-kernels.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Hardware Enablement (HWE) kernels for Ubuntu LTS releases. Learn about support lifecycles, installation procedures, and edge kernel variants.

HWE kernels
===========

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Reference guides for Ubuntu kernel development processes. Explore kernel variants, patch formats, acceptance criteria, upload rights, and terminology."
---

# Reference

Reference material about Ubuntu kernel development processes, terminology, and
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/kernel-upload-rights.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Ubuntu kernel upload rights and permissions. Learn about access levels, responsibilities, and how to obtain upload privileges for kernels.

.. _kernel-upload-rights:

Kernel upload rights
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/oem-kernels.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: OEM kernels for Ubuntu hardware partners. Understand specialized kernels for pre-installed systems, staging processes, and release timelines.

OEM kernels
===========

Expand Down
3 changes: 3 additions & 0 deletions docs/reference/patch-acceptance-criteria.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Understand Ubuntu kernel patch acceptance criteria. Learn what patches are accepted for stable releases and the evaluation process used.

.. highlight:: email

.. _ubuntu-patches-acceptance-criteria:
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/stable-patch-format.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Ubuntu kernel stable patch format requirements. Learn proper structure, SRU justification, commit messages, and submission guidelines.

Stable patch format
===================

Expand Down
7 changes: 7 additions & 0 deletions docs/reference/ubuntu-kernels.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
myst:
html_meta:
description: "Understand Ubuntu kernel variants including development, optimized, OEM, and HWE kernels. Learn about git branching strategies and lifecycles."
---

(ref-ubuntu-kernel-variants-branches)=

# Ubuntu kernel variants and branches
Expand Down Expand Up @@ -134,6 +140,7 @@ The `master-next` or `main-next` branches serve as the staging area for the **ne
The `master` or `main` branches represent the current state of the kernel source as it exists in the `-updates` pocket of the Ubuntu archive.
It contains the linear history of all the stable releases published for that kernel.


% LINKS

[Ubuntu kernels from Canonical]: https://ubuntu.com/kernel
Expand Down
Loading