Ubuntu Kernel Next
==================

The Ubuntu Kernel Next (UKN from now on) is a Ubuntu kernel specifically crafted
to help third-parties code merging efforts: a periodical, read-only, snapshot of
Ubuntu linux-unstable, UKN provides a stable code base for your work, while
closely tracking development of next-release Ubuntu kernel.

NB: all code ported on top of UKN will first be merged in Ubuntu linux-unstable,
and only after the next sync will show up in UKN - here is a `workflow
explanation`_.

The UKN git tree is hosted in the Canonical Kernel Team Gitea `repository`_. In
order to be able to contribute to the code, please follow the instructions
on `Getting Access to Ubuntu Kernel Gitea <ukn_gitea_access_>`_.

The UKN git tree consists of a single branch named 'next' - you are encouraged
to `fork`_ it, push changes in a topic branch and prepare a pull request when
you think it's ready.

Here is a step-by-step guide to get you started:

#. Enviroment setup (one time task): UKN tracks the Ubuntu development series,
   so an Ubuntu devel chroot must be `setup`_ to properly build UKN.

#. Formatting your patches: new patches must follow the Ubuntu `patch guideline`_
   and fall under the `acceptance criteria`_ - read them carefully, code not following
   these guidelines will likely be rejected.

#. The Ubuntu kernel config: learn how to apply `kernel config changes`_ to UKN.

#. Kernel build: before submitting any pull request, make sure your kernel
   `builds in a clean chroot`_.

#. Contributing your changes: go to your Gitea fork/topic-branch page, click on the
   ``New Pull Request`` button, fill a sensible commit message and send your
   patches for review.

And that should be it, if in doubt or have any feature request, please contact the
Ubuntu kernel team: **kernel-team@lists.ubuntu.com**

Quick index
-----------
.. toctree::
   :maxdepth: 1

   ukn_workflow
   kteamtools_chroot_creation
   ubuntu_acceptance_criteria
   ubuntu_code_patches
   kernel_config
   fdr_build_the_kernel
   ukn_gitea_access

.. _repository: https://kernel.ubuntu.com/gitea/ubuntu-kernel-next/linux
.. _fork: https://kernel.ubuntu.com/gitea/ubuntu-kernel-next/linux/fork
.. _Launchpad group: https://launchpad.net/~ubuntu-kernel-next
.. _setup: kteamtools_chroot_creation.html
.. _patch guideline: ubuntu_code_patches.html
.. _acceptance criteria: ubuntu_acceptance_criteria.html
.. _kernel config changes: kernel_config.html
.. _builds in a clean chroot: fdr_build_the_kernel.html
.. _workflow explanation: ukn_workflow.html
.. _ukn_gitea_access: ukn_gitea_access.html