sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget;/translations/zh_CN/admin-guide/quickly-build-trimmed-linuxmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/zh_TW/admin-guide/quickly-build-trimmed-linuxmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/it_IT/admin-guide/quickly-build-trimmed-linuxmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/ja_JP/admin-guide/quickly-build-trimmed-linuxmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/ko_KR/admin-guide/quickly-build-trimmed-linuxmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/pt_BR/admin-guide/quickly-build-trimmed-linuxmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget;/translations/sp_SP/admin-guide/quickly-build-trimmed-linuxmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h0SPDX-License-Identifier: (GPL-2.0+ OR CC-BY-4.0)h]h0SPDX-License-Identifier: (GPL-2.0+ OR CC-BY-4.0)}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhU/var/lib/git/docbuild/linux/Documentation/admin-guide/quickly-build-trimmed-linux.rsthKubh)}(h<[see the bottom of this file for redistribution information]h]h<[see the bottom of this file for redistribution information]}hhsbah}(h]h ]h"]h$]h&]hhuh1hhhhhhhhKubhsection)}(hhh](htitle)}(h+How to quickly build a trimmed Linux kernelh]h+How to quickly build a trimmed Linux kernel}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(hThis guide explains how to swiftly build Linux kernels that are ideal for testing purposes, but perfectly fine for day-to-day use, too.h]hThis guide explains how to swiftly build Linux kernels that are ideal for testing purposes, but perfectly fine for day-to-day use, too.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(h(The essence of the process (aka 'TL;DR')h]h,The essence of the process (aka ‘TL;DR’)}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhK ubh)}(hXU*[If you are new to compiling Linux, ignore this TLDR and head over to the next section below: it contains a step-by-step guide, which is more detailed, but still brief and easy to follow; that guide and its accompanying reference section also mention alternatives, pitfalls, and additional aspects, all of which might be relevant for you.]*h]hemphasis)}(hjh]hXS[If you are new to compiling Linux, ignore this TLDR and head over to the next section below: it contains a step-by-step guide, which is more detailed, but still brief and easy to follow; that guide and its accompanying reference section also mention alternatives, pitfalls, and additional aspects, all of which might be relevant for you.]}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hX{If your system uses techniques like Secure Boot, prepare it to permit starting self-compiled Linux kernels; install compilers and everything else needed for building Linux; make sure to have 12 Gigabyte free space in your home directory. Now run the following commands to download fresh Linux mainline sources, which you then use to configure, build and install your own kernel::h]hXzIf your system uses techniques like Secure Boot, prepare it to permit starting self-compiled Linux kernels; install compilers and everything else needed for building Linux; make sure to have 12 Gigabyte free space in your home directory. Now run the following commands to download fresh Linux mainline sources, which you then use to configure, build and install your own kernel:}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh literal_block)}(hXgit clone --depth 1 -b master \ https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git ~/linux/ cd ~/linux/ # Hint: if you want to apply patches, do it at this point. See below for details. # Hint: it's recommended to tag your build at this point. See below for details. yes "" | make localmodconfig # Hint: at this point you might want to adjust the build configuration; you'll # have to, if you are running Debian. See below for details. make -j $(nproc --all) # Note: on many commodity distributions the next command suffices, but on Arch # Linux, its derivatives, and some others it does not. See below for details. command -v installkernel && sudo make modules_install install rebooth]hXgit clone --depth 1 -b master \ https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git ~/linux/ cd ~/linux/ # Hint: if you want to apply patches, do it at this point. See below for details. # Hint: it's recommended to tag your build at this point. See below for details. yes "" | make localmodconfig # Hint: at this point you might want to adjust the build configuration; you'll # have to, if you are running Debian. See below for details. make -j $(nproc --all) # Note: on many commodity distributions the next command suffices, but on Arch # Linux, its derivatives, and some others it does not. See below for details. command -v installkernel && sudo make modules_install install reboot}hj5sbah}(h]h ]h"]h$]h&]hhuh1j3hhhKhhhhubh)}(hJIf you later want to build a newer mainline snapshot, use these commands::h]hIIf you later want to build a newer mainline snapshot, use these commands:}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK(hhhhubj4)}(hXcd ~/linux/ git fetch --depth 1 origin # Note: the next command will discard any changes you did to the code: git checkout --force --detach origin/master # Reminder: if you want to (re)apply patches, do it at this point. # Reminder: you might want to add or modify a build tag at this point. make olddefconfig make -j $(nproc --all) # Reminder: the next command on some distributions does not suffice. command -v installkernel && sudo make modules_install install rebooth]hXcd ~/linux/ git fetch --depth 1 origin # Note: the next command will discard any changes you did to the code: git checkout --force --detach origin/master # Reminder: if you want to (re)apply patches, do it at this point. # Reminder: you might want to add or modify a build tag at this point. make olddefconfig make -j $(nproc --all) # Reminder: the next command on some distributions does not suffice. command -v installkernel && sudo make modules_install install reboot}hjQsbah}(h]h ]h"]h$]h&]hhuh1j3hhhK*hhhhubeh}(h]$the-essence-of-the-process-aka-tl-drah ]h"](the essence of the process (aka 'tl;dr')ah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hStep-by-step guideh]hStep-by-step guide}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjghhhhhK7ubh)}(hCompiling your own Linux kernel is easy in principle. There are various ways to do it. Which of them actually work and is the best depends on the circumstances.h]hCompiling your own Linux kernel is easy in principle. There are various ways to do it. Which of them actually work and is the best depends on the circumstances.}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK9hjghhubh)}(hXThis guide describes a way perfectly suited for those who want to quickly install Linux from sources without being bothered by complicated details; the goal is to cover everything typically needed on mainstream Linux distributions running on commodity PC or server hardware.h]hXThis guide describes a way perfectly suited for those who want to quickly install Linux from sources without being bothered by complicated details; the goal is to cover everything typically needed on mainstream Linux distributions running on commodity PC or server hardware.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK`] h]h bullet_list)}(hhh]h list_item)}(hCreate a fresh backup and put system repair and restore tools at hand, just to be prepared for the unlikely case of something going sideways. [:ref:`details`] h](h)}(hCreate a fresh backup and put system repair and restore tools at hand, just to be prepared for the unlikely case of something going sideways.h]hCreate a fresh backup and put system repair and restore tools at hand, just to be prepared for the unlikely case of something going sideways.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKUhjubh)}(h[:ref:`details`]h](h[}(hjhhhNhNubh)}(h:ref:`details`h]hinline)}(hjh]hdetails}(hjhhhNhNubah}(h]h ](xrefstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdoc'admin-guide/quickly-build-trimmed-linux refdomainjreftyperef refexplicitrefwarn reftargetbackupuh1hhhhKXhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKXhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]bullet*uh1jhhhKUhjubah}(h]jah ]h"] backup_sbsah$]h&]uh1jhhhKUhjghhexpect_referenced_by_name}j4jsexpect_referenced_by_id}jjsubj)}(h.. _secureboot_sbs:h]h}(h]h ]h"]h$]h&]jsecureboot-sbsuh1jhKZhjghhhhubj)}(hX* On platforms with 'Secure Boot' or similar techniques, prepare everything to ensure the system will permit your self-compiled kernel to boot later. The quickest and easiest way to achieve this on commodity x86 systems is to disable such techniques in the BIOS setup utility; alternatively, remove their restrictions through a process initiated by ``mokutil --disable-validation``. [:ref:`details`] h]j)}(hhh]j)}(hXOn platforms with 'Secure Boot' or similar techniques, prepare everything to ensure the system will permit your self-compiled kernel to boot later. The quickest and easiest way to achieve this on commodity x86 systems is to disable such techniques in the BIOS setup utility; alternatively, remove their restrictions through a process initiated by ``mokutil --disable-validation``. [:ref:`details`] h](h)}(hX|On platforms with 'Secure Boot' or similar techniques, prepare everything to ensure the system will permit your self-compiled kernel to boot later. The quickest and easiest way to achieve this on commodity x86 systems is to disable such techniques in the BIOS setup utility; alternatively, remove their restrictions through a process initiated by ``mokutil --disable-validation``.h](hX_On platforms with ‘Secure Boot’ or similar techniques, prepare everything to ensure the system will permit your self-compiled kernel to boot later. The quickest and easiest way to achieve this on commodity x86 systems is to disable such techniques in the BIOS setup utility; alternatively, remove their restrictions through a process initiated by }(hjQhhhNhNubhliteral)}(h ``mokutil --disable-validation``h]hmokutil --disable-validation}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjQubh.}(hjQhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK\hjMubh)}(h[:ref:`details`]h](h[}(hjshhhNhNubh)}(h:ref:`details`h]j)}(hj}h]hdetails}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj{ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj securebootuh1hhhhKchjsubh]}(hjshhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKchjMubeh}(h]h ]h"]h$]h&]uh1jhjJubah}(h]h ]h"]h$]h&]j.j/uh1jhhhK\hjFubah}(h]jEah ]h"]secureboot_sbsah$]h&]uh1jhhhK\hjghhj7}jj;sj9}jEj;subj)}(h.. _buildrequires_sbs:h]h}(h]h ]h"]h$]h&]jbuildrequires-sbsuh1jhKehjghhhhubj)}(hXn* Install all software required to build a Linux kernel. Often you will need: 'bc', 'binutils' ('ld' et al.), 'bison', 'flex', 'gcc', 'git', 'openssl', 'pahole', 'perl', and the development headers for 'libelf' and 'openssl'. The reference section shows how to quickly install those on various popular Linux distributions. [:ref:`details`] h]j)}(hhh]j)}(hXbInstall all software required to build a Linux kernel. Often you will need: 'bc', 'binutils' ('ld' et al.), 'bison', 'flex', 'gcc', 'git', 'openssl', 'pahole', 'perl', and the development headers for 'libelf' and 'openssl'. The reference section shows how to quickly install those on various popular Linux distributions. [:ref:`details`] h](h)}(hX@Install all software required to build a Linux kernel. Often you will need: 'bc', 'binutils' ('ld' et al.), 'bison', 'flex', 'gcc', 'git', 'openssl', 'pahole', 'perl', and the development headers for 'libelf' and 'openssl'. The reference section shows how to quickly install those on various popular Linux distributions.h]hXpInstall all software required to build a Linux kernel. Often you will need: ‘bc’, ‘binutils’ (‘ld’ et al.), ‘bison’, ‘flex’, ‘gcc’, ‘git’, ‘openssl’, ‘pahole’, ‘perl’, and the development headers for ‘libelf’ and ‘openssl’. The reference section shows how to quickly install those on various popular Linux distributions.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKghjubh)}(h[:ref:`details`]h](h[}(hjhhhNhNubh)}(h:ref:`details`h]j)}(hjh]hdetails}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj buildrequiresuh1hhhhKmhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKmhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]j.j/uh1jhhhKghjubah}(h]jah ]h"]buildrequires_sbsah$]h&]uh1jhhhKghjghhj7}j jsj9}jjsubj)}(h.. _diskspace_sbs:h]h}(h]h ]h"]h$]h&]j diskspace-sbsuh1jhKohjghhhhubj)}(hX* Ensure to have enough free space for building and installing Linux. For the latter 150 Megabyte in /lib/ and 100 in /boot/ are a safe bet. For storing sources and build artifacts 12 Gigabyte in your home directory should typically suffice. If you have less available, be sure to check the reference section for the step that explains adjusting your kernels build configuration: it mentions a trick that reduce the amount of required space in /home/ to around 4 Gigabyte. [:ref:`details`] h]j)}(hhh]j)}(hXEnsure to have enough free space for building and installing Linux. For the latter 150 Megabyte in /lib/ and 100 in /boot/ are a safe bet. For storing sources and build artifacts 12 Gigabyte in your home directory should typically suffice. If you have less available, be sure to check the reference section for the step that explains adjusting your kernels build configuration: it mentions a trick that reduce the amount of required space in /home/ to around 4 Gigabyte. [:ref:`details`] h](h)}(hXEnsure to have enough free space for building and installing Linux. For the latter 150 Megabyte in /lib/ and 100 in /boot/ are a safe bet. For storing sources and build artifacts 12 Gigabyte in your home directory should typically suffice. If you have less available, be sure to check the reference section for the step that explains adjusting your kernels build configuration: it mentions a trick that reduce the amount of required space in /home/ to around 4 Gigabyte.h]hXEnsure to have enough free space for building and installing Linux. For the latter 150 Megabyte in /lib/ and 100 in /boot/ are a safe bet. For storing sources and build artifacts 12 Gigabyte in your home directory should typically suffice. If you have less available, be sure to check the reference section for the step that explains adjusting your kernels build configuration: it mentions a trick that reduce the amount of required space in /home/ to around 4 Gigabyte.}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKqhj7ubh)}(h[:ref:`details`]h](h[}(hjIhhhNhNubh)}(h:ref:`details`h]j)}(hjSh]hdetails}(hjUhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjQubah}(h]h ]h"]h$]h&]refdocj refdomainj_reftyperef refexplicitrefwarnj diskspaceuh1hhhhKyhjIubh]}(hjIhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKyhj7ubeh}(h]h ]h"]h$]h&]uh1jhj4ubah}(h]h ]h"]h$]h&]j.j/uh1jhhhKqhj0ubah}(h]j/ah ]h"] diskspace_sbsah$]h&]uh1jhhhKqhjghhj7}jj%sj9}j/j%subj)}(h.. _sources_sbs:h]h}(h]h ]h"]h$]h&]j sources-sbsuh1jhK{hjghhhhubj)}(hX* Retrieve the sources of the Linux version you intend to build; then change into the directory holding them, as all further commands in this guide are meant to be executed from there. *[Note: the following paragraphs describe how to retrieve the sources by partially cloning the Linux stable git repository. This is called a shallow clone. The reference section explains two alternatives:* :ref:`packaged archives` *and* :ref:`a full git clone` *; prefer the latter, if downloading a lot of data does not bother you, as that will avoid some* :ref:`peculiar characteristics of shallow clones the reference section explains` *.]* First, execute the following command to retrieve a fresh mainline codebase:: git clone --no-checkout --depth 1 -b master \ https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git ~/linux/ cd ~/linux/ If you want to access recent mainline releases and pre-releases, deepen you clone's history to the oldest mainline version you are interested in:: git fetch --shallow-exclude=v6.0 origin In case you want to access a stable/longterm release (say v6.1.5), simply add the branch holding that series; afterwards fetch the history at least up to the mainline version that started the series (v6.1):: git remote set-branches --add origin linux-6.1.y git fetch --shallow-exclude=v6.0 origin Now checkout the code you are interested in. If you just performed the initial clone, you will be able to check out a fresh mainline codebase, which is ideal for checking whether developers already fixed an issue:: git checkout --detach origin/master If you deepened your clone, you instead of ``origin/master`` can specify the version you deepened to (``v6.0`` above); later releases like ``v6.1`` and pre-release like ``v6.2-rc1`` will work, too. Stable or longterm versions like ``v6.1.5`` work just the same, if you added the appropriate stable/longterm branch as described. [:ref:`details`] h]j)}(hhh]j)}(hXRetrieve the sources of the Linux version you intend to build; then change into the directory holding them, as all further commands in this guide are meant to be executed from there. *[Note: the following paragraphs describe how to retrieve the sources by partially cloning the Linux stable git repository. This is called a shallow clone. The reference section explains two alternatives:* :ref:`packaged archives` *and* :ref:`a full git clone` *; prefer the latter, if downloading a lot of data does not bother you, as that will avoid some* :ref:`peculiar characteristics of shallow clones the reference section explains` *.]* First, execute the following command to retrieve a fresh mainline codebase:: git clone --no-checkout --depth 1 -b master \ https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git ~/linux/ cd ~/linux/ If you want to access recent mainline releases and pre-releases, deepen you clone's history to the oldest mainline version you are interested in:: git fetch --shallow-exclude=v6.0 origin In case you want to access a stable/longterm release (say v6.1.5), simply add the branch holding that series; afterwards fetch the history at least up to the mainline version that started the series (v6.1):: git remote set-branches --add origin linux-6.1.y git fetch --shallow-exclude=v6.0 origin Now checkout the code you are interested in. If you just performed the initial clone, you will be able to check out a fresh mainline codebase, which is ideal for checking whether developers already fixed an issue:: git checkout --detach origin/master If you deepened your clone, you instead of ``origin/master`` can specify the version you deepened to (``v6.0`` above); later releases like ``v6.1`` and pre-release like ``v6.2-rc1`` will work, too. Stable or longterm versions like ``v6.1.5`` work just the same, if you added the appropriate stable/longterm branch as described. [:ref:`details`] h](h)}(hRetrieve the sources of the Linux version you intend to build; then change into the directory holding them, as all further commands in this guide are meant to be executed from there.h]hRetrieve the sources of the Linux version you intend to build; then change into the directory holding them, as all further commands in this guide are meant to be executed from there.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK}hjubh)}(hX*[Note: the following paragraphs describe how to retrieve the sources by partially cloning the Linux stable git repository. This is called a shallow clone. The reference section explains two alternatives:* :ref:`packaged archives` *and* :ref:`a full git clone` *; prefer the latter, if downloading a lot of data does not bother you, as that will avoid some* :ref:`peculiar characteristics of shallow clones the reference section explains` *.]*h](j)}(h*[Note: the following paragraphs describe how to retrieve the sources by partially cloning the Linux stable git repository. This is called a shallow clone. The reference section explains two alternatives:*h]h[Note: the following paragraphs describe how to retrieve the sources by partially cloning the Linux stable git repository. This is called a shallow clone. The reference section explains two alternatives:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }(hjhhhNhNubh)}(h):ref:`packaged archives`h]j)}(hjh]hpackaged archives}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjsources_archiveuh1hhhhKhjubh }hjsbj)}(h*and*h]hand}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }hjsbh)}(h%:ref:`a full git clone`h]j)}(hjh]ha full git clone}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj sources_fulluh1hhhhKhjubh }hjsbj)}(h`*; prefer the latter, if downloading a lot of data does not bother you, as that will avoid some*h]h^; prefer the latter, if downloading a lot of data does not bother you, as that will avoid some}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh }hjsbh)}(ha:ref:`peculiar characteristics of shallow clones the reference section explains`h]j)}(hj8h]hIpeculiar characteristics of shallow clones the reference section explains}(hj:hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj6ubah}(h]h ]h"]h$]h&]refdocj refdomainjDreftyperef refexplicitrefwarnjsources_shallowuh1hhhhKhjubh }hjsbj)}(h*.]*h]h.]}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hLFirst, execute the following command to retrieve a fresh mainline codebase::h]hKFirst, execute the following command to retrieve a fresh mainline codebase:}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj4)}(hgit clone --no-checkout --depth 1 -b master \ https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git ~/linux/ cd ~/linux/h]hgit clone --no-checkout --depth 1 -b master \ https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git ~/linux/ cd ~/linux/}hj|sbah}(h]h ]h"]h$]h&]hhuh1j3hhhKhjubh)}(hIf you want to access recent mainline releases and pre-releases, deepen you clone's history to the oldest mainline version you are interested in::h]hIf you want to access recent mainline releases and pre-releases, deepen you clone’s history to the oldest mainline version you are interested in:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj4)}(h'git fetch --shallow-exclude=v6.0 originh]h'git fetch --shallow-exclude=v6.0 origin}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhKhjubh)}(hIn case you want to access a stable/longterm release (say v6.1.5), simply add the branch holding that series; afterwards fetch the history at least up to the mainline version that started the series (v6.1)::h]hIn case you want to access a stable/longterm release (say v6.1.5), simply add the branch holding that series; afterwards fetch the history at least up to the mainline version that started the series (v6.1):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj4)}(hXgit remote set-branches --add origin linux-6.1.y git fetch --shallow-exclude=v6.0 originh]hXgit remote set-branches --add origin linux-6.1.y git fetch --shallow-exclude=v6.0 origin}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhKhjubh)}(hNow checkout the code you are interested in. If you just performed the initial clone, you will be able to check out a fresh mainline codebase, which is ideal for checking whether developers already fixed an issue::h]hNow checkout the code you are interested in. If you just performed the initial clone, you will be able to check out a fresh mainline codebase, which is ideal for checking whether developers already fixed an issue:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj4)}(h#git checkout --detach origin/masterh]h#git checkout --detach origin/master}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhKhjubh)}(hXGIf you deepened your clone, you instead of ``origin/master`` can specify the version you deepened to (``v6.0`` above); later releases like ``v6.1`` and pre-release like ``v6.2-rc1`` will work, too. Stable or longterm versions like ``v6.1.5`` work just the same, if you added the appropriate stable/longterm branch as described.h](h+If you deepened your clone, you instead of }(hjhhhNhNubjZ)}(h``origin/master``h]h origin/master}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh* can specify the version you deepened to (}(hjhhhNhNubjZ)}(h``v6.0``h]hv6.0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh above); later releases like }(hjhhhNhNubjZ)}(h``v6.1``h]hv6.1}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh and pre-release like }(hjhhhNhNubjZ)}(h ``v6.2-rc1``h]hv6.2-rc1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh2 will work, too. Stable or longterm versions like }(hjhhhNhNubjZ)}(h ``v6.1.5``h]hv6.1.5}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubhV work just the same, if you added the appropriate stable/longterm branch as described.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h[:ref:`details`]h](h[}(hjFhhhNhNubh)}(h:ref:`details`h]j)}(hjPh]hdetails}(hjRhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjNubah}(h]h ]h"]h$]h&]refdocj refdomainj\reftyperef refexplicitrefwarnjsourcesuh1hhhhKhjFubh]}(hjFhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]j.j/uh1jhhhK}hjubah}(h]jah ]h"] sources_sbsah$]h&]uh1jhhhK}hjghhj7}jjsj9}jjsubj)}(h.. _patching_sbs:h]h}(h]h ]h"]h$]h&]j patching-sbsuh1jhKhjghhhhubj)}(hX* In case you want to apply a kernel patch, do so now. Often a command like this will do the trick:: patch -p1 < ../proposed-fix.patch If the ``-p1`` is actually needed, depends on how the patch was created; in case it does not apply thus try without it. If you cloned the sources with git and anything goes sideways, run ``git reset --hard`` to undo any changes to the sources. [:ref:`details`] h]j)}(hhh]j)}(hXIn case you want to apply a kernel patch, do so now. Often a command like this will do the trick:: patch -p1 < ../proposed-fix.patch If the ``-p1`` is actually needed, depends on how the patch was created; in case it does not apply thus try without it. If you cloned the sources with git and anything goes sideways, run ``git reset --hard`` to undo any changes to the sources. [:ref:`details`] h](h)}(hbIn case you want to apply a kernel patch, do so now. Often a command like this will do the trick::h]haIn case you want to apply a kernel patch, do so now. Often a command like this will do the trick:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj4)}(h!patch -p1 < ../proposed-fix.patchh]h!patch -p1 < ../proposed-fix.patch}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhKhjubh)}(hwIf the ``-p1`` is actually needed, depends on how the patch was created; in case it does not apply thus try without it.h](hIf the }(hjhhhNhNubjZ)}(h``-p1``h]h-p1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubhi is actually needed, depends on how the patch was created; in case it does not apply thus try without it.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h{If you cloned the sources with git and anything goes sideways, run ``git reset --hard`` to undo any changes to the sources.h](hCIf you cloned the sources with git and anything goes sideways, run }(hjhhhNhNubjZ)}(h``git reset --hard``h]hgit reset --hard}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh$ to undo any changes to the sources.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h[:ref:`details`]h](h[}(hjhhhNhNubh)}(h:ref:`details`h]j)}(hj h]hdetails}(hj hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjpatchinguh1hhhhKhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]j.j/uh1jhhhKhjubah}(h]jah ]h"] patching_sbsah$]h&]uh1jhhhKhjghhj7}jAjsj9}jjsubj)}(h.. _tagging_sbs:h]h}(h]h ]h"]h$]h&]j tagging-sbsuh1jhKhjghhhhubj)}(hX>* If you patched your kernel or have one of the same version installed already, better add a unique tag to the one you are about to build:: echo "-proposed_fix" > localversion Running ``uname -r`` under your kernel later will then print something like '6.1-rc4-proposed_fix'. [:ref:`details`] .. _configuration_sbs: * Create the build configuration for your kernel based on an existing configuration. If you already prepared such a '.config' file yourself, copy it to ~/linux/ and run ``make olddefconfig``. Use the same command, if your distribution or somebody else already tailored your running kernel to your or your hardware's needs: the make target 'olddefconfig' will then try to use that kernel's .config as base. Using this make target is fine for everybody else, too -- but you often can save a lot of time by using this command instead:: yes "" | make localmodconfig This will try to pick your distribution's kernel as base, but then disable modules for any features apparently superfluous for your setup. This will reduce the compile time enormously, especially if you are running an universal kernel from a commodity Linux distribution. There is a catch: 'localmodconfig' is likely to disable kernel features you did not use since you booted your Linux -- like drivers for currently disconnected peripherals or virtualization software not currently in use. You can reduce or nearly eliminate that risk with tricks the reference section outlines; but when building a kernel just for quick testing purposes it is often negligible if such features are missing. But you should keep that aspect in mind when using a kernel built with this make target, as it might be the reason why something you only use occasionally stopped working. [:ref:`details`] h](j)}(hhh]j)}(hX1If you patched your kernel or have one of the same version installed already, better add a unique tag to the one you are about to build:: echo "-proposed_fix" > localversion Running ``uname -r`` under your kernel later will then print something like '6.1-rc4-proposed_fix'. [:ref:`details`] h](h)}(hIf you patched your kernel or have one of the same version installed already, better add a unique tag to the one you are about to build::h]hIf you patched your kernel or have one of the same version installed already, better add a unique tag to the one you are about to build:}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjXubj4)}(h#echo "-proposed_fix" > localversionh]h#echo "-proposed_fix" > localversion}hjjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhKhjXubh)}(hcRunning ``uname -r`` under your kernel later will then print something like '6.1-rc4-proposed_fix'.h](hRunning }(hjxhhhNhNubjZ)}(h ``uname -r``h]huname -r}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjxubhS under your kernel later will then print something like ‘6.1-rc4-proposed_fix’.}(hjxhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjXubh)}(h[:ref:`details`]h](h[}(hjhhhNhNubh)}(h:ref:`details`h]j)}(hjh]hdetails}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjtagginguh1hhhhKhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjXubeh}(h]h ]h"]h$]h&]uh1jhjUubah}(h]h ]h"]h$]h&]j.j/uh1jhhhKhjQubj)}(h.. _configuration_sbs:h]h}(h]h ]h"]h$]h&]jconfiguration-sbsuh1jhKhjQubj)}(hhh]j)}(hXCreate the build configuration for your kernel based on an existing configuration. If you already prepared such a '.config' file yourself, copy it to ~/linux/ and run ``make olddefconfig``. Use the same command, if your distribution or somebody else already tailored your running kernel to your or your hardware's needs: the make target 'olddefconfig' will then try to use that kernel's .config as base. Using this make target is fine for everybody else, too -- but you often can save a lot of time by using this command instead:: yes "" | make localmodconfig This will try to pick your distribution's kernel as base, but then disable modules for any features apparently superfluous for your setup. This will reduce the compile time enormously, especially if you are running an universal kernel from a commodity Linux distribution. There is a catch: 'localmodconfig' is likely to disable kernel features you did not use since you booted your Linux -- like drivers for currently disconnected peripherals or virtualization software not currently in use. You can reduce or nearly eliminate that risk with tricks the reference section outlines; but when building a kernel just for quick testing purposes it is often negligible if such features are missing. But you should keep that aspect in mind when using a kernel built with this make target, as it might be the reason why something you only use occasionally stopped working. [:ref:`details`] h](h)}(hRCreate the build configuration for your kernel based on an existing configuration.h]hRCreate the build configuration for your kernel based on an existing configuration.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hjIf you already prepared such a '.config' file yourself, copy it to ~/linux/ and run ``make olddefconfig``.h](hXIf you already prepared such a ‘.config’ file yourself, copy it to ~/linux/ and run }(hjhhhNhNubjZ)}(h``make olddefconfig``h]hmake olddefconfig}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hUse the same command, if your distribution or somebody else already tailored your running kernel to your or your hardware's needs: the make target 'olddefconfig' will then try to use that kernel's .config as base.h]hUse the same command, if your distribution or somebody else already tailored your running kernel to your or your hardware’s needs: the make target ‘olddefconfig’ will then try to use that kernel’s .config as base.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h~Using this make target is fine for everybody else, too -- but you often can save a lot of time by using this command instead::h]h}Using this make target is fine for everybody else, too -- but you often can save a lot of time by using this command instead:}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj4)}(hyes "" | make localmodconfigh]hyes "" | make localmodconfig}hj2sbah}(h]h ]h"]h$]h&]hhuh1j3hhhKhjubh)}(hXThis will try to pick your distribution's kernel as base, but then disable modules for any features apparently superfluous for your setup. This will reduce the compile time enormously, especially if you are running an universal kernel from a commodity Linux distribution.h]hXThis will try to pick your distribution’s kernel as base, but then disable modules for any features apparently superfluous for your setup. This will reduce the compile time enormously, especially if you are running an universal kernel from a commodity Linux distribution.}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hXPThere is a catch: 'localmodconfig' is likely to disable kernel features you did not use since you booted your Linux -- like drivers for currently disconnected peripherals or virtualization software not currently in use. You can reduce or nearly eliminate that risk with tricks the reference section outlines; but when building a kernel just for quick testing purposes it is often negligible if such features are missing. But you should keep that aspect in mind when using a kernel built with this make target, as it might be the reason why something you only use occasionally stopped working.h]hXTThere is a catch: ‘localmodconfig’ is likely to disable kernel features you did not use since you booted your Linux -- like drivers for currently disconnected peripherals or virtualization software not currently in use. You can reduce or nearly eliminate that risk with tricks the reference section outlines; but when building a kernel just for quick testing purposes it is often negligible if such features are missing. But you should keep that aspect in mind when using a kernel built with this make target, as it might be the reason why something you only use occasionally stopped working.}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h[:ref:`details`]h](h[}(hj\hhhNhNubh)}(h:ref:`details`h]j)}(hjfh]hdetails}(hjhhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjdubah}(h]h ]h"]h$]h&]refdocj refdomainjrreftyperef refexplicitrefwarnj configurationuh1hhhhKhj\ubh]}(hj\hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]jah ]h"]configuration_sbsah$]h&]j.j/uh1jhhhKhjQj7}jjsj9}jjsubeh}(h]jPah ]h"] tagging_sbsah$]h&]uh1jhhhKhjghhj7}jjFsj9}jPjFsubj)}(h.. _configmods_sbs:h]h}(h]h ]h"]h$]h&]jconfigmods-sbsuh1jhKhjghhhhubj)}(hX* Check if you might want to or have to adjust some kernel configuration options: * Evaluate how you want to handle debug symbols. Enable them, if you later might need to decode a stack trace found for example in a 'panic', 'Oops', 'warning', or 'BUG'; on the other hand disable them, if you are short on storage space or prefer a smaller kernel binary. See the reference section for details on how to do either. If neither applies, it will likely be fine to simply not bother with this. [:ref:`details`] * Are you running Debian? Then to avoid known problems by performing additional adjustments explained in the reference section. [:ref:`details`]. * If you want to influence the other aspects of the configuration, do so now by using make targets like 'menuconfig' or 'xconfig'. [:ref:`details`]. h](j)}(hhh]j)}(hPCheck if you might want to or have to adjust some kernel configuration options: h]h)}(hOCheck if you might want to or have to adjust some kernel configuration options:h]hOCheck if you might want to or have to adjust some kernel configuration options:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]j.j/uh1jhhhKhjubj)}(hX&* Evaluate how you want to handle debug symbols. Enable them, if you later might need to decode a stack trace found for example in a 'panic', 'Oops', 'warning', or 'BUG'; on the other hand disable them, if you are short on storage space or prefer a smaller kernel binary. See the reference section for details on how to do either. If neither applies, it will likely be fine to simply not bother with this. [:ref:`details`] * Are you running Debian? Then to avoid known problems by performing additional adjustments explained in the reference section. [:ref:`details`]. * If you want to influence the other aspects of the configuration, do so now by using make targets like 'menuconfig' or 'xconfig'. [:ref:`details`]. h]j)}(hhh](j)}(hXEvaluate how you want to handle debug symbols. Enable them, if you later might need to decode a stack trace found for example in a 'panic', 'Oops', 'warning', or 'BUG'; on the other hand disable them, if you are short on storage space or prefer a smaller kernel binary. See the reference section for details on how to do either. If neither applies, it will likely be fine to simply not bother with this. [:ref:`details`] h]h)}(hXEvaluate how you want to handle debug symbols. Enable them, if you later might need to decode a stack trace found for example in a 'panic', 'Oops', 'warning', or 'BUG'; on the other hand disable them, if you are short on storage space or prefer a smaller kernel binary. See the reference section for details on how to do either. If neither applies, it will likely be fine to simply not bother with this. [:ref:`details`]h](hXEvaluate how you want to handle debug symbols. Enable them, if you later might need to decode a stack trace found for example in a ‘panic’, ‘Oops’, ‘warning’, or ‘BUG’; on the other hand disable them, if you are short on storage space or prefer a smaller kernel binary. See the reference section for details on how to do either. If neither applies, it will likely be fine to simply not bother with this. [}(hjhhhNhNubh)}(h':ref:`details`h]j)}(hjh]hdetails}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjconfigmods_debugsymbolsuh1hhhhKhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hAre you running Debian? Then to avoid known problems by performing additional adjustments explained in the reference section. [:ref:`details`]. h]h)}(hAre you running Debian? Then to avoid known problems by performing additional adjustments explained in the reference section. [:ref:`details`].h](hAre you running Debian? Then to avoid known problems by performing additional adjustments explained in the reference section. [}(hjhhhNhNubh)}(h":ref:`details`h]j)}(hj'h]hdetails}(hj)hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj%ubah}(h]h ]h"]h$]h&]refdocj refdomainj3reftyperef refexplicitrefwarnjconfigmods_distrosuh1hhhhKhjubh].}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hIf you want to influence the other aspects of the configuration, do so now by using make targets like 'menuconfig' or 'xconfig'. [:ref:`details`]. h]h)}(hIf you want to influence the other aspects of the configuration, do so now by using make targets like 'menuconfig' or 'xconfig'. [:ref:`details`].h](hIf you want to influence the other aspects of the configuration, do so now by using make targets like ‘menuconfig’ or ‘xconfig’. [}(hjYhhhNhNubh)}(h%:ref:`details`h]j)}(hjch]hdetails}(hjehhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjaubah}(h]h ]h"]h$]h&]refdocj refdomainjoreftyperef refexplicitrefwarnjconfigmods_individualuh1hhhhKhjYubh].}(hjYhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjUubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]j.j/uh1jhhhKhjubah}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]jah ]h"]configmods_sbsah$]h&]uh1jhhhKhjghhj7}jjsj9}jjsubj)}(h.. _build_sbs:h]h}(h]h ]h"]h$]h&]j build-sbsuh1jhKhjghhhhubj)}(h* Build the image and the modules of your kernel:: make -j $(nproc --all) If you want your kernel packaged up as deb, rpm, or tar file, see the reference section for alternatives. [:ref:`details`] h]j)}(hhh]j)}(hBuild the image and the modules of your kernel:: make -j $(nproc --all) If you want your kernel packaged up as deb, rpm, or tar file, see the reference section for alternatives. [:ref:`details`] h](h)}(h0Build the image and the modules of your kernel::h]h/Build the image and the modules of your kernel:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj4)}(hmake -j $(nproc --all)h]hmake -j $(nproc --all)}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhKhjubh)}(hiIf you want your kernel packaged up as deb, rpm, or tar file, see the reference section for alternatives.h]hiIf you want your kernel packaged up as deb, rpm, or tar file, see the reference section for alternatives.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(h[:ref:`details`]h](h[}(hjhhhNhNubh)}(h:ref:`details`h]j)}(hjh]hdetails}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjbuilduh1hhhhMhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]j.j/uh1jhhhKhjubah}(h]jah ]h"] build_sbsah$]h&]uh1jhhhKhjghhj7}j( jsj9}jjsubj)}(h.. _install_sbs:h]h}(h]h ]h"]h$]h&]j install-sbsuh1jhMhjghhhhubj)}(hX)* Now install your kernel:: command -v installkernel && sudo make modules_install install Often all left for you to do afterwards is a ``reboot``, as many commodity Linux distributions will then create an initramfs (also known as initrd) and an entry for your kernel in your bootloader's configuration; but on some distributions you have to take care of these two steps manually for reasons the reference section explains. On a few distributions like Arch Linux and its derivatives the above command does nothing at all; in that case you have to manually install your kernel, as outlined in the reference section. If you are running an immutable Linux distribution, check its documentation and the web to find out how to install your own kernel there. [:ref:`details`] h]j)}(hhh]j)}(hXNow install your kernel:: command -v installkernel && sudo make modules_install install Often all left for you to do afterwards is a ``reboot``, as many commodity Linux distributions will then create an initramfs (also known as initrd) and an entry for your kernel in your bootloader's configuration; but on some distributions you have to take care of these two steps manually for reasons the reference section explains. On a few distributions like Arch Linux and its derivatives the above command does nothing at all; in that case you have to manually install your kernel, as outlined in the reference section. If you are running an immutable Linux distribution, check its documentation and the web to find out how to install your own kernel there. [:ref:`details`] h](h)}(hNow install your kernel::h]hNow install your kernel:}(hjC hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj? ubj4)}(h=command -v installkernel && sudo make modules_install installh]h=command -v installkernel && sudo make modules_install install}hjQ sbah}(h]h ]h"]h$]h&]hhuh1j3hhhMhj? ubh)}(hXLOften all left for you to do afterwards is a ``reboot``, as many commodity Linux distributions will then create an initramfs (also known as initrd) and an entry for your kernel in your bootloader's configuration; but on some distributions you have to take care of these two steps manually for reasons the reference section explains.h](h-Often all left for you to do afterwards is a }(hj_ hhhNhNubjZ)}(h ``reboot``h]hreboot}(hjg hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj_ ubhX, as many commodity Linux distributions will then create an initramfs (also known as initrd) and an entry for your kernel in your bootloader’s configuration; but on some distributions you have to take care of these two steps manually for reasons the reference section explains.}(hj_ hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM hj? ubh)}(hOn a few distributions like Arch Linux and its derivatives the above command does nothing at all; in that case you have to manually install your kernel, as outlined in the reference section.h]hOn a few distributions like Arch Linux and its derivatives the above command does nothing at all; in that case you have to manually install your kernel, as outlined in the reference section.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj? ubh)}(hIf you are running an immutable Linux distribution, check its documentation and the web to find out how to install your own kernel there.h]hIf you are running an immutable Linux distribution, check its documentation and the web to find out how to install your own kernel there.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj? ubh)}(h[:ref:`details`]h](h[}(hj hhhNhNubh)}(h:ref:`details`h]j)}(hj h]hdetails}(hj hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnjinstalluh1hhhhMhj ubh]}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj? ubeh}(h]h ]h"]h$]h&]uh1jhj< ubah}(h]h ]h"]h$]h&]j.j/uh1jhhhMhj8 ubah}(h]j7 ah ]h"] install_sbsah$]h&]uh1jhhhMhjghhj7}j j- sj9}j7 j- subj)}(h.. _another_sbs:h]h}(h]h ]h"]h$]h&]j another-sbsuh1jhMhjghhhhubj)}(hX* To later build another kernel you need similar steps, but sometimes slightly different commands. First, switch back into the sources tree:: cd ~/linux/ In case you want to build a version from a stable/longterm series you have not used yet (say 6.2.y), tell git to track it:: git remote set-branches --add origin linux-6.2.y Now fetch the latest upstream changes; you again need to specify the earliest version you care about, as git otherwise might retrieve the entire commit history:: git fetch --shallow-exclude=v6.0 origin Now switch to the version you are interested in -- but be aware the command used here will discard any modifications you performed, as they would conflict with the sources you want to checkout:: git checkout --force --detach origin/master At this point you might want to patch the sources again or set/modify a build tag, as explained earlier. Afterwards adjust the build configuration to the new codebase using olddefconfig, which will now adjust the configuration file you prepared earlier using localmodconfig (~/linux/.config) for your next kernel:: # reminder: if you want to apply patches, do it at this point # reminder: you might want to update your build tag at this point make olddefconfig Now build your kernel:: make -j $(nproc --all) Afterwards install the kernel as outlined above:: command -v installkernel && sudo make modules_install install [:ref:`details`] h]j)}(hhh]j)}(hXTo later build another kernel you need similar steps, but sometimes slightly different commands. First, switch back into the sources tree:: cd ~/linux/ In case you want to build a version from a stable/longterm series you have not used yet (say 6.2.y), tell git to track it:: git remote set-branches --add origin linux-6.2.y Now fetch the latest upstream changes; you again need to specify the earliest version you care about, as git otherwise might retrieve the entire commit history:: git fetch --shallow-exclude=v6.0 origin Now switch to the version you are interested in -- but be aware the command used here will discard any modifications you performed, as they would conflict with the sources you want to checkout:: git checkout --force --detach origin/master At this point you might want to patch the sources again or set/modify a build tag, as explained earlier. Afterwards adjust the build configuration to the new codebase using olddefconfig, which will now adjust the configuration file you prepared earlier using localmodconfig (~/linux/.config) for your next kernel:: # reminder: if you want to apply patches, do it at this point # reminder: you might want to update your build tag at this point make olddefconfig Now build your kernel:: make -j $(nproc --all) Afterwards install the kernel as outlined above:: command -v installkernel && sudo make modules_install install [:ref:`details`] h](h)}(h`To later build another kernel you need similar steps, but sometimes slightly different commands.h]h`To later build another kernel you need similar steps, but sometimes slightly different commands.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubh)}(h*First, switch back into the sources tree::h]h)First, switch back into the sources tree:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubj4)}(h cd ~/linux/h]h cd ~/linux/}hj sbah}(h]h ]h"]h$]h&]hhuh1j3hhhM hj ubh)}(h{In case you want to build a version from a stable/longterm series you have not used yet (say 6.2.y), tell git to track it::h]hzIn case you want to build a version from a stable/longterm series you have not used yet (say 6.2.y), tell git to track it:}(hj" hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM"hj ubj4)}(h0git remote set-branches --add origin linux-6.2.yh]h0git remote set-branches --add origin linux-6.2.y}hj0 sbah}(h]h ]h"]h$]h&]hhuh1j3hhhM%hj ubh)}(hNow fetch the latest upstream changes; you again need to specify the earliest version you care about, as git otherwise might retrieve the entire commit history::h]hNow fetch the latest upstream changes; you again need to specify the earliest version you care about, as git otherwise might retrieve the entire commit history:}(hj> hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM'hj ubj4)}(h'git fetch --shallow-exclude=v6.0 originh]h'git fetch --shallow-exclude=v6.0 origin}hjL sbah}(h]h ]h"]h$]h&]hhuh1j3hhhM+hj ubh)}(hNow switch to the version you are interested in -- but be aware the command used here will discard any modifications you performed, as they would conflict with the sources you want to checkout::h]hNow switch to the version you are interested in -- but be aware the command used here will discard any modifications you performed, as they would conflict with the sources you want to checkout:}(hjZ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM-hj ubj4)}(h+git checkout --force --detach origin/masterh]h+git checkout --force --detach origin/master}hjh sbah}(h]h ]h"]h$]h&]hhuh1j3hhhM1hj ubh)}(hX;At this point you might want to patch the sources again or set/modify a build tag, as explained earlier. Afterwards adjust the build configuration to the new codebase using olddefconfig, which will now adjust the configuration file you prepared earlier using localmodconfig (~/linux/.config) for your next kernel::h]hX:At this point you might want to patch the sources again or set/modify a build tag, as explained earlier. Afterwards adjust the build configuration to the new codebase using olddefconfig, which will now adjust the configuration file you prepared earlier using localmodconfig (~/linux/.config) for your next kernel:}(hjv hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM3hj ubj4)}(h# reminder: if you want to apply patches, do it at this point # reminder: you might want to update your build tag at this point make olddefconfigh]h# reminder: if you want to apply patches, do it at this point # reminder: you might want to update your build tag at this point make olddefconfig}hj sbah}(h]h ]h"]h$]h&]hhuh1j3hhhM9hj ubh)}(hNow build your kernel::h]hNow build your kernel:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM=hj ubj4)}(hmake -j $(nproc --all)h]hmake -j $(nproc --all)}hj sbah}(h]h ]h"]h$]h&]hhuh1j3hhhM?hj ubh)}(h1Afterwards install the kernel as outlined above::h]h0Afterwards install the kernel as outlined above:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMAhj ubj4)}(h=command -v installkernel && sudo make modules_install installh]h=command -v installkernel && sudo make modules_install install}hj sbah}(h]h ]h"]h$]h&]hhuh1j3hhhMChj ubh)}(h[:ref:`details`]h](h[}(hj hhhNhNubh)}(h:ref:`details`h]j)}(hj h]hdetails}(hj hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnjanotheruh1hhhhMEhj ubh]}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMEhj ubeh}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]j.j/uh1jhhhMhj ubah}(h]j ah ]h"] another_sbsah$]h&]uh1jhhhMhjghhj7}j j sj9}j j subj)}(h.. _uninstall_sbs:h]h}(h]h ]h"]h$]h&]j uninstall-sbsuh1jhMGhjghhhhubj)}(hXo* Your kernel is easy to remove later, as its parts are only stored in two places and clearly identifiable by the kernel's release name. Just ensure to not delete the kernel you are running, as that might render your system unbootable. Start by deleting the directory holding your kernel's modules, which is named after its release name -- '6.0.1-foobar' in the following example:: sudo rm -rf /lib/modules/6.0.1-foobar Now try the following command, which on some distributions will delete all other kernel files installed while also removing the kernel's entry from the bootloader configuration:: command -v kernel-install && sudo kernel-install -v remove 6.0.1-foobar If that command does not output anything or fails, see the reference section; do the same if any files named '*6.0.1-foobar*' remain in /boot/. [:ref:`details`] h]j)}(hhh]j)}(hXSYour kernel is easy to remove later, as its parts are only stored in two places and clearly identifiable by the kernel's release name. Just ensure to not delete the kernel you are running, as that might render your system unbootable. Start by deleting the directory holding your kernel's modules, which is named after its release name -- '6.0.1-foobar' in the following example:: sudo rm -rf /lib/modules/6.0.1-foobar Now try the following command, which on some distributions will delete all other kernel files installed while also removing the kernel's entry from the bootloader configuration:: command -v kernel-install && sudo kernel-install -v remove 6.0.1-foobar If that command does not output anything or fails, see the reference section; do the same if any files named '*6.0.1-foobar*' remain in /boot/. [:ref:`details`] h](h)}(hYour kernel is easy to remove later, as its parts are only stored in two places and clearly identifiable by the kernel's release name. Just ensure to not delete the kernel you are running, as that might render your system unbootable.h]hYour kernel is easy to remove later, as its parts are only stored in two places and clearly identifiable by the kernel’s release name. Just ensure to not delete the kernel you are running, as that might render your system unbootable.}(hj' hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMIhj# ubh)}(hStart by deleting the directory holding your kernel's modules, which is named after its release name -- '6.0.1-foobar' in the following example::h]hStart by deleting the directory holding your kernel’s modules, which is named after its release name -- ‘6.0.1-foobar’ in the following example:}(hj5 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMNhj# ubj4)}(h%sudo rm -rf /lib/modules/6.0.1-foobarh]h%sudo rm -rf /lib/modules/6.0.1-foobar}hjC sbah}(h]h ]h"]h$]h&]hhuh1j3hhhMQhj# ubh)}(hNow try the following command, which on some distributions will delete all other kernel files installed while also removing the kernel's entry from the bootloader configuration::h]hNow try the following command, which on some distributions will delete all other kernel files installed while also removing the kernel’s entry from the bootloader configuration:}(hjQ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMShj# ubj4)}(hGcommand -v kernel-install && sudo kernel-install -v remove 6.0.1-foobarh]hGcommand -v kernel-install && sudo kernel-install -v remove 6.0.1-foobar}hj_ sbah}(h]h ]h"]h$]h&]hhuh1j3hhhMWhj# ubh)}(hIf that command does not output anything or fails, see the reference section; do the same if any files named '*6.0.1-foobar*' remain in /boot/.h](hpIf that command does not output anything or fails, see the reference section; do the same if any files named ‘}(hjm hhhNhNubj)}(h*6.0.1-foobar*h]h 6.0.1-foobar}(hju hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjm ubh’ remain in /boot/.}(hjm hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMYhj# ubh)}(h[:ref:`details`]h](h[}(hj hhhNhNubh)}(h:ref:`details`h]j)}(hj h]hdetails}(hj hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnj uninstalluh1hhhhM\hj ubh]}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM\hj# ubeh}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]j.j/uh1jhhhMIhj ubah}(h]j ah ]h"] uninstall_sbsah$]h&]uh1jhhhMIhjghhj7}j j sj9}j j subj)}(h.. _submit_improvements_qbtl:h]h}(h]h ]h"]h$]h&]jsubmit-improvements-qbtluh1jhM^hjghhhhubh)}(hDid you run into trouble following the step-by-step guide not cleared up by the reference section below? Did you spot errors? Or do you have ideas on how to improve the guide?h]hDid you run into trouble following the step-by-step guide not cleared up by the reference section below? Did you spot errors? Or do you have ideas on how to improve the guide?}(hj hhhNhNubah}(h]j ah ]h"]submit_improvements_qbtlah$]h&]uh1hhhhM`hjghhj7}j j sj9}j j subh)}(hXpIf any of that applies, please let the developers know by sending a short note or a patch to Thorsten Leemhuis while ideally CCing the public Linux docs mailing list . Such feedback is vital to improve this text further, which is in everybody's interest, as it will enable more people to master the task described here.h](hpIf any of that applies, please let the developers know by sending a short note or a patch to Thorsten Leemhuis <}(hj hhhNhNubh reference)}(hlinux@leemhuis.infoh]hlinux@leemhuis.info}(hj hhhNhNubah}(h]h ]h"]h$]h&]refurimailto:linux@leemhuis.infouh1j hj ubh:> while ideally CCing the public Linux docs mailing list <}(hj hhhNhNubj )}(hlinux-doc@vger.kernel.orgh]hlinux-doc@vger.kernel.org}(hj hhhNhNubah}(h]h ]h"]h$]h&]refuri mailto:linux-doc@vger.kernel.orguh1j hj ubh>. Such feedback is vital to improve this text further, which is in everybody’s interest, as it will enable more people to master the task described here.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMdhjghhubeh}(h]step-by-step-guideah ]h"]step-by-step guideah$]h&]uh1hhhhhhhhK7ubh)}(hhh](h)}(h,Reference section for the step-by-step guideh]h,Reference section for the step-by-step guide}(hj3 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0 hhhhhMkubh)}(hSThis section holds additional information for each of the steps in the above guide.h]hSThis section holds additional information for each of the steps in the above guide.}(hjA hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMmhj0 hhubj)}(h .. _backup:h]h}(h]h ]h"]h$]h&]jbackupuh1jhMphj0 hhhhubh)}(hhh](h)}(hPrepare for emergenciesh]hPrepare for emergencies}(hj] hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjZ hhhhhMsubj)}(hb*Create a fresh backup and put system repair and restore tools at hand* [:ref:`... `] h]h)}(ha*Create a fresh backup and put system repair and restore tools at hand* [:ref:`... `]h](j)}(hG*Create a fresh backup and put system repair and restore tools at hand*h]hECreate a fresh backup and put system repair and restore tools at hand}(hjs hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjo ubh [}(hjo hhhNhNubh)}(h:ref:`... `h]j)}(hj h]h...}(hj hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnj backup_sbsuh1hhhhMuhjo ubh]}(hjo hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMuhjk ubah}(h]h ]h"]h$]h&]uh1jhhhMuhjZ hhubh)}(hX*Remember, you are dealing with computers, which sometimes do unexpected things -- especially if you fiddle with crucial parts like the kernel of an operating system. That's what you are about to do in this process. Hence, better prepare for something going sideways, even if that should not happen.h]hX,Remember, you are dealing with computers, which sometimes do unexpected things -- especially if you fiddle with crucial parts like the kernel of an operating system. That’s what you are about to do in this process. Hence, better prepare for something going sideways, even if that should not happen.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMxhjZ hhubh)}(h0[:ref:`back to step-by-step guide `]h](h[}(hj hhhNhNubh)}(h.:ref:`back to step-by-step guide `h]j)}(hj h]hback to step-by-step guide}(hj hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnj backup_sbsuh1hhhhM}hj ubh]}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM}hjZ hhubj)}(h.. _secureboot:h]h}(h]h ]h"]h$]h&]j securebootuh1jhMhjZ hhhhubeh}(h](prepare-for-emergenciesjY eh ]h"](prepare for emergenciesbackupeh$]h&]uh1hhj0 hhhhhMsj7}j jO sj9}jY jO subh)}(hhh](h)}(h(Dealing with techniques like Secure Booth]h(Dealing with techniques like Secure Boot}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubj)}(h*On platforms with 'Secure Boot' or similar techniques, prepare everything to ensure the system will permit your self-compiled kernel to boot later.* [:ref:`... `] h]h)}(h*On platforms with 'Secure Boot' or similar techniques, prepare everything to ensure the system will permit your self-compiled kernel to boot later.* [:ref:`... `]h](j)}(h*On platforms with 'Secure Boot' or similar techniques, prepare everything to ensure the system will permit your self-compiled kernel to boot later.*h]hOn platforms with ‘Secure Boot’ or similar techniques, prepare everything to ensure the system will permit your self-compiled kernel to boot later.}(hj$ hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh [}(hj hhhNhNubh)}(h:ref:`... `h]j)}(hj8 h]h...}(hj: hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj6 ubah}(h]h ]h"]h$]h&]refdocj refdomainjD reftyperef refexplicitrefwarnjsecureboot_sbsuh1hhhhMhj ubh]}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhhhMhj hhubh)}(hMany modern systems allow only certain operating systems to start; they thus by default will reject booting self-compiled kernels.h]hMany modern systems allow only certain operating systems to start; they thus by default will reject booting self-compiled kernels.}(hjf hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hXaYou ideally deal with this by making your platform trust your self-built kernels with the help of a certificate and signing. How to do that is not described here, as it requires various steps that would take the text too far away from its purpose; 'Documentation/admin-guide/module-signing.rst' and various web sides already explain this in more detail.h]hXeYou ideally deal with this by making your platform trust your self-built kernels with the help of a certificate and signing. How to do that is not described here, as it requires various steps that would take the text too far away from its purpose; ‘Documentation/admin-guide/module-signing.rst’ and various web sides already explain this in more detail.}(hjt hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hTemporarily disabling solutions like Secure Boot is another way to make your own Linux boot. On commodity x86 systems it is possible to do this in the BIOS Setup utility; the steps to do so are not described here, as they greatly vary between machines.h]hTemporarily disabling solutions like Secure Boot is another way to make your own Linux boot. On commodity x86 systems it is possible to do this in the BIOS Setup utility; the steps to do so are not described here, as they greatly vary between machines.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hX6On mainstream x86 Linux distributions there is a third and universal option: disable all Secure Boot restrictions for your Linux environment. You can initiate this process by running ``mokutil --disable-validation``; this will tell you to create a one-time password, which is safe to write down. Now restart; right after your BIOS performed all self-tests the bootloader Shim will show a blue box with a message 'Press any key to perform MOK management'. Hit some key before the countdown exposes. This will open a menu and choose 'Change Secure Boot state' there. Shim's 'MokManager' will now ask you to enter three randomly chosen characters from the one-time password specified earlier. Once you provided them, confirm that you really want to disable the validation. Afterwards, permit MokManager to reboot the machine.h](hOn mainstream x86 Linux distributions there is a third and universal option: disable all Secure Boot restrictions for your Linux environment. You can initiate this process by running }(hj hhhNhNubjZ)}(h ``mokutil --disable-validation``h]hmokutil --disable-validation}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj ubhXm; this will tell you to create a one-time password, which is safe to write down. Now restart; right after your BIOS performed all self-tests the bootloader Shim will show a blue box with a message ‘Press any key to perform MOK management’. Hit some key before the countdown exposes. This will open a menu and choose ‘Change Secure Boot state’ there. Shim’s ‘MokManager’ will now ask you to enter three randomly chosen characters from the one-time password specified earlier. Once you provided them, confirm that you really want to disable the validation. Afterwards, permit MokManager to reboot the machine.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(h4[:ref:`back to step-by-step guide `]h](h[}(hj hhhNhNubh)}(h2:ref:`back to step-by-step guide `h]j)}(hj h]hback to step-by-step guide}(hj hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnjsecureboot_sbsuh1hhhhMhj ubh]}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubj)}(h.. _buildrequires:h]h}(h]h ]h"]h$]h&]j buildrequiresuh1jhMhj hhhhubeh}(h]((dealing-with-techniques-like-secure-bootj eh ]h"]((dealing with techniques like secure boot securebooteh$]h&]uh1hhj0 hhhhhMj7}j j sj9}j j subh)}(hhh](h)}(hInstall build requirementsh]hInstall build requirements}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubj)}(hY*Install all software required to build a Linux kernel.* [:ref:`...`] h]h)}(hX*Install all software required to build a Linux kernel.* [:ref:`...`]h](j)}(h8*Install all software required to build a Linux kernel.*h]h6Install all software required to build a Linux kernel.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh [}(hj hhhNhNubh)}(h:ref:`...`h]j)}(hj%h]h...}(hj'hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&]refdocj refdomainj1reftyperef refexplicitrefwarnjbuildrequires_sbsuh1hhhhMhj ubh]}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhhhMhj hhubh)}(hThe kernel is pretty stand-alone, but besides tools like the compiler you will sometimes need a few libraries to build one. How to install everything needed depends on your Linux distribution and the configuration of the kernel you are about to build.h]hThe kernel is pretty stand-alone, but besides tools like the compiler you will sometimes need a few libraries to build one. How to install everything needed depends on your Linux distribution and the configuration of the kernel you are about to build.}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hQHere are a few examples what you typically need on some mainstream distributions:h]hQHere are a few examples what you typically need on some mainstream distributions:}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubj)}(hX* Debian, Ubuntu, and derivatives:: sudo apt install bc binutils bison dwarves flex gcc git make openssl \ pahole perl-base libssl-dev libelf-dev * Fedora and derivatives:: sudo dnf install binutils /usr/include/{libelf.h,openssl/pkcs7.h} \ /usr/bin/{bc,bison,flex,gcc,git,openssl,make,perl,pahole} * openSUSE and derivatives:: sudo zypper install bc binutils bison dwarves flex gcc git make perl-base \ openssl openssl-devel libelf-dev h]j)}(hhh](j)}(hDebian, Ubuntu, and derivatives:: sudo apt install bc binutils bison dwarves flex gcc git make openssl \ pahole perl-base libssl-dev libelf-dev h](h)}(h!Debian, Ubuntu, and derivatives::h]h Debian, Ubuntu, and derivatives:}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjvubj4)}(hosudo apt install bc binutils bison dwarves flex gcc git make openssl \ pahole perl-base libssl-dev libelf-devh]hosudo apt install bc binutils bison dwarves flex gcc git make openssl \ pahole perl-base libssl-dev libelf-dev}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhMhjvubeh}(h]h ]h"]h$]h&]uh1jhjsubj)}(hFedora and derivatives:: sudo dnf install binutils /usr/include/{libelf.h,openssl/pkcs7.h} \ /usr/bin/{bc,bison,flex,gcc,git,openssl,make,perl,pahole} h](h)}(hFedora and derivatives::h]hFedora and derivatives:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj4)}(hsudo dnf install binutils /usr/include/{libelf.h,openssl/pkcs7.h} \ /usr/bin/{bc,bison,flex,gcc,git,openssl,make,perl,pahole}h]hsudo dnf install binutils /usr/include/{libelf.h,openssl/pkcs7.h} \ /usr/bin/{bc,bison,flex,gcc,git,openssl,make,perl,pahole}}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhMhjubeh}(h]h ]h"]h$]h&]uh1jhjsubj)}(hopenSUSE and derivatives:: sudo zypper install bc binutils bison dwarves flex gcc git make perl-base \ openssl openssl-devel libelf-dev h](h)}(hopenSUSE and derivatives::h]hopenSUSE and derivatives:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj4)}(hnsudo zypper install bc binutils bison dwarves flex gcc git make perl-base \ openssl openssl-devel libelf-devh]hnsudo zypper install bc binutils bison dwarves flex gcc git make perl-base \ openssl openssl-devel libelf-dev}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhMhjubeh}(h]h ]h"]h$]h&]uh1jhjsubeh}(h]h ]h"]h$]h&]j.j/uh1jhhhMhjoubah}(h]h ]h"]h$]h&]uh1jhhhMhj hhubh)}(hIn case you wonder why these lists include openssl and its development headers: they are needed for the Secure Boot support, which many distributions enable in their kernel configuration for x86 machines.h]hIn case you wonder why these lists include openssl and its development headers: they are needed for the Secure Boot support, which many distributions enable in their kernel configuration for x86 machines.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hlSometimes you will need tools for compression formats like bzip2, gzip, lz4, lzma, lzo, xz, or zstd as well.h]hlSometimes you will need tools for compression formats like bzip2, gzip, lz4, lzma, lzo, xz, or zstd as well.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hXUYou might need additional libraries and their development headers in case you perform tasks not covered in this guide. For example, zlib will be needed when building kernel tools from the tools/ directory; adjusting the build configuration with make targets like 'menuconfig' or 'xconfig' will require development headers for ncurses or Qt5.h]hX]You might need additional libraries and their development headers in case you perform tasks not covered in this guide. For example, zlib will be needed when building kernel tools from the tools/ directory; adjusting the build configuration with make targets like ‘menuconfig’ or ‘xconfig’ will require development headers for ncurses or Qt5.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(h7[:ref:`back to step-by-step guide `]h](h[}(hjhhhNhNubh)}(h5:ref:`back to step-by-step guide `h]j)}(hj(h]hback to step-by-step guide}(hj*hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj&ubah}(h]h ]h"]h$]h&]refdocj refdomainj4reftyperef refexplicitrefwarnjbuildrequires_sbsuh1hhhhMhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubj)}(h.. _diskspace:h]h}(h]h ]h"]h$]h&]j diskspaceuh1jhMhj hhhhubeh}(h](install-build-requirementsj eh ]h"](install build requirements buildrequireseh$]h&]uh1hhj0 hhhhhMj7}jaj sj9}j j subh)}(hhh](h)}(hSpace requirementsh]hSpace requirements}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhjfhhhhhMubj)}(hc*Ensure to have enough free space for building and installing Linux.* [:ref:`... `] h]h)}(hb*Ensure to have enough free space for building and installing Linux.* [:ref:`... `]h](j)}(hE*Ensure to have enough free space for building and installing Linux.*h]hCEnsure to have enough free space for building and installing Linux.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj{ubh [}(hj{hhhNhNubh)}(h:ref:`... `h]j)}(hjh]h...}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj diskspace_sbsuh1hhhhMhj{ubh]}(hj{hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjwubah}(h]h ]h"]h$]h&]uh1jhhhMhjfhhubh)}(hvThe numbers mentioned are rough estimates with a big extra charge to be on the safe side, so often you will need less.h]hvThe numbers mentioned are rough estimates with a big extra charge to be on the safe side, so often you will need less.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjfhhubh)}(hIf you have space constraints, remember to read the reference section when you reach the :ref:`section about configuration adjustments' `, as ensuring debug symbols are disabled will reduce the consumed disk space by quite a few gigabytes.h](hYIf you have space constraints, remember to read the reference section when you reach the }(hjhhhNhNubh)}(h<:ref:`section about configuration adjustments' `h]j)}(hjh]h*section about configuration adjustments’}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj configmodsuh1hhhhMhjubhf, as ensuring debug symbols are disabled will reduce the consumed disk space by quite a few gigabytes.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjfhhubh)}(h3[:ref:`back to step-by-step guide `]h](h[}(hjhhhNhNubh)}(h1:ref:`back to step-by-step guide `h]j)}(hj h]hback to step-by-step guide}(hj hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj diskspace_sbsuh1hhhhMhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjfhhubj)}(h .. _sources:h]h}(h]h ]h"]h$]h&]jsourcesuh1jhMhjfhhhhubeh}(h](space-requirementsjZeh ]h"](space requirements diskspaceeh$]h&]uh1hhj0 hhhhhMj7}jDjPsj9}jZjPsubh)}(hhh](h)}(hDownload the sourcesh]hDownload the sources}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjIhhhhhMubj)}(h[*Retrieve the sources of the Linux version you intend to build.* [:ref:`...`] h]h)}(hZ*Retrieve the sources of the Linux version you intend to build.* [:ref:`...`]h](j)}(h@*Retrieve the sources of the Linux version you intend to build.*h]h>Retrieve the sources of the Linux version you intend to build.}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^ubh [}(hj^hhhNhNubh)}(h:ref:`...`h]j)}(hjvh]h...}(hjxhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj sources_sbsuh1hhhhMhj^ubh]}(hj^hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjZubah}(h]h ]h"]h$]h&]uh1jhhhMhjIhhubh)}(hXThe step-by-step guide outlines how to retrieve Linux' sources using a shallow git clone. There is :ref:`more to tell about this method` and two alternate ways worth describing: :ref:`packaged archives` and :ref:`a full git clone`. And the aspects ':ref:`wouldn't it be wiser to use a proper pre-release than the latest mainline code `' and ':ref:`how to get an even fresher mainline codebase `' need elaboration, too.h](heThe step-by-step guide outlines how to retrieve Linux’ sources using a shallow git clone. There is }(hjhhhNhNubh)}(h6:ref:`more to tell about this method`h]j)}(hjh]hmore to tell about this method}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjsources_shallowuh1hhhhMhjubh* and two alternate ways worth describing: }(hjhhhNhNubh)}(h):ref:`packaged archives`h]j)}(hjh]hpackaged archives}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjsources_archiveuh1hhhhMhjubh and }(hjhhhNhNubh)}(h%:ref:`a full git clone`h]j)}(hjh]ha full git clone}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj sources_fulluh1hhhhMhjubh. And the aspects ‘}(hjhhhNhNubh)}(hh:ref:`wouldn't it be wiser to use a proper pre-release than the latest mainline code `h]j)}(hjh]hPwouldn’t it be wiser to use a proper pre-release than the latest mainline code}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainj&reftyperef refexplicitrefwarnjsources_snapshotuh1hhhhMhjubh ’ and ‘}(hjhhhNhNubh)}(hE:ref:`how to get an even fresher mainline codebase `h]j)}(hj>h]h,how to get an even fresher mainline codebase}(hj@hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&]refdocj refdomainjJreftyperef refexplicitrefwarnjsources_fresheruh1hhhhMhjubh’ need elaboration, too.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjIhhubh)}(hX1Note, to keep things simple the commands used in this guide store the build artifacts in the source tree. If you prefer to separate them, simply add something like ``O=~/linux-builddir/`` to all make calls; also adjust the path in all commands that add files or modify any generated (like your '.config').h](hNote, to keep things simple the commands used in this guide store the build artifacts in the source tree. If you prefer to separate them, simply add something like }(hjfhhhNhNubjZ)}(h``O=~/linux-builddir/``h]hO=~/linux-builddir/}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjfubhz to all make calls; also adjust the path in all commands that add files or modify any generated (like your ‘.config’).}(hjfhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjIhhubh)}(h1[:ref:`back to step-by-step guide `]h](h[}(hjhhhNhNubh)}(h/:ref:`back to step-by-step guide `h]j)}(hjh]hback to step-by-step guide}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj sources_sbsuh1hhhhMhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjIhhubj)}(h.. _sources_shallow:h]h}(h]h ]h"]h$]h&]jsources-shallowuh1jhMhjIhhhhubh)}(hhh](h)}(h,Noteworthy characteristics of shallow clonesh]h,Noteworthy characteristics of shallow clones}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hThe step-by-step guide uses a shallow clone, as it is the best solution for most of this document's target audience. There are a few aspects of this approach worth mentioning:h]hThe step-by-step guide uses a shallow clone, as it is the best solution for most of this document’s target audience. There are a few aspects of this approach worth mentioning:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(hX* This document in most places uses ``git fetch`` with ``--shallow-exclude=`` to specify the earliest version you care about (or to be precise: its git tag). You alternatively can use the parameter ``--shallow-since=`` to specify an absolute (say ``'2023-07-15'``) or relative (``'12 months'``) date to define the depth of the history you want to download. As a second alternative, you can also specify a certain depth explicitly with a parameter like ``--depth=1``, unless you add branches for stable/longterm kernels. * When running ``git fetch``, remember to always specify the oldest version, the time you care about, or an explicit depth as shown in the step-by-step guide. Otherwise you will risk downloading nearly the entire git history, which will consume quite a bit of time and bandwidth while also stressing the servers. Note, you do not have to use the same version or date all the time. But when you change it over time, git will deepen or flatten the history to the specified point. That allows you to retrieve versions you initially thought you did not need -- or it will discard the sources of older versions, for example in case you want to free up some disk space. The latter will happen automatically when using ``--shallow-since=`` or ``--depth=``. * Be warned, when deepening your clone you might encounter an error like 'fatal: error in object: unshallow cafecaca0c0dacafecaca0c0dacafecaca0c0da'. In that case run ``git repack -d`` and try again`` * In case you want to revert changes from a certain version (say Linux 6.3) or perform a bisection (v6.2..v6.3), better tell ``git fetch`` to retrieve objects up to three versions earlier (e.g. 6.0): ``git describe`` will then be able to describe most commits just like it would in a full git clone. h]j)}(hhh](j)}(hXThis document in most places uses ``git fetch`` with ``--shallow-exclude=`` to specify the earliest version you care about (or to be precise: its git tag). You alternatively can use the parameter ``--shallow-since=`` to specify an absolute (say ``'2023-07-15'``) or relative (``'12 months'``) date to define the depth of the history you want to download. As a second alternative, you can also specify a certain depth explicitly with a parameter like ``--depth=1``, unless you add branches for stable/longterm kernels. h]h)}(hXThis document in most places uses ``git fetch`` with ``--shallow-exclude=`` to specify the earliest version you care about (or to be precise: its git tag). You alternatively can use the parameter ``--shallow-since=`` to specify an absolute (say ``'2023-07-15'``) or relative (``'12 months'``) date to define the depth of the history you want to download. As a second alternative, you can also specify a certain depth explicitly with a parameter like ``--depth=1``, unless you add branches for stable/longterm kernels.h](h"This document in most places uses }(hjhhhNhNubjZ)}(h ``git fetch``h]h git fetch}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh with }(hjhhhNhNubjZ)}(h``--shallow-exclude=``h]h--shallow-exclude=}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubhy to specify the earliest version you care about (or to be precise: its git tag). You alternatively can use the parameter }(hjhhhNhNubjZ)}(h``--shallow-since=``h]h--shallow-since=}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh to specify an absolute (say }(hjhhhNhNubjZ)}(h``'2023-07-15'``h]h '2023-07-15'}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh) or relative (}(hjhhhNhNubjZ)}(h``'12 months'``h]h '12 months'}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh) date to define the depth of the history you want to download. As a second alternative, you can also specify a certain depth explicitly with a parameter like }(hjhhhNhNubjZ)}(h ``--depth=1``h]h --depth=1}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh6, unless you add branches for stable/longterm kernels.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hXWhen running ``git fetch``, remember to always specify the oldest version, the time you care about, or an explicit depth as shown in the step-by-step guide. Otherwise you will risk downloading nearly the entire git history, which will consume quite a bit of time and bandwidth while also stressing the servers. Note, you do not have to use the same version or date all the time. But when you change it over time, git will deepen or flatten the history to the specified point. That allows you to retrieve versions you initially thought you did not need -- or it will discard the sources of older versions, for example in case you want to free up some disk space. The latter will happen automatically when using ``--shallow-since=`` or ``--depth=``. h](h)}(hX6When running ``git fetch``, remember to always specify the oldest version, the time you care about, or an explicit depth as shown in the step-by-step guide. Otherwise you will risk downloading nearly the entire git history, which will consume quite a bit of time and bandwidth while also stressing the servers.h](h When running }(hjqhhhNhNubjZ)}(h ``git fetch``h]h git fetch}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjqubhX, remember to always specify the oldest version, the time you care about, or an explicit depth as shown in the step-by-step guide. Otherwise you will risk downloading nearly the entire git history, which will consume quite a bit of time and bandwidth while also stressing the servers.}(hjqhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM hjmubh)}(hXNote, you do not have to use the same version or date all the time. But when you change it over time, git will deepen or flatten the history to the specified point. That allows you to retrieve versions you initially thought you did not need -- or it will discard the sources of older versions, for example in case you want to free up some disk space. The latter will happen automatically when using ``--shallow-since=`` or ``--depth=``.h](hXNote, you do not have to use the same version or date all the time. But when you change it over time, git will deepen or flatten the history to the specified point. That allows you to retrieve versions you initially thought you did not need -- or it will discard the sources of older versions, for example in case you want to free up some disk space. The latter will happen automatically when using }(hjhhhNhNubjZ)}(h``--shallow-since=``h]h--shallow-since=}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh or }(hjhhhNhNubjZ)}(h ``--depth=``h]h--depth=}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjmubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hBe warned, when deepening your clone you might encounter an error like 'fatal: error in object: unshallow cafecaca0c0dacafecaca0c0dacafecaca0c0da'. In that case run ``git repack -d`` and try again`` h]h)}(hBe warned, when deepening your clone you might encounter an error like 'fatal: error in object: unshallow cafecaca0c0dacafecaca0c0dacafecaca0c0da'. In that case run ``git repack -d`` and try again``h](hBe warned, when deepening your clone you might encounter an error like ‘fatal: error in object: unshallow cafecaca0c0dacafecaca0c0dacafecaca0c0da’. In that case run }(hjhhhNhNubjZ)}(h``git repack -d``h]h git repack -d}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh and try again``}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hX*In case you want to revert changes from a certain version (say Linux 6.3) or perform a bisection (v6.2..v6.3), better tell ``git fetch`` to retrieve objects up to three versions earlier (e.g. 6.0): ``git describe`` will then be able to describe most commits just like it would in a full git clone. h]h)}(hX)In case you want to revert changes from a certain version (say Linux 6.3) or perform a bisection (v6.2..v6.3), better tell ``git fetch`` to retrieve objects up to three versions earlier (e.g. 6.0): ``git describe`` will then be able to describe most commits just like it would in a full git clone.h](h{In case you want to revert changes from a certain version (say Linux 6.3) or perform a bisection (v6.2..v6.3), better tell }(hjhhhNhNubjZ)}(h ``git fetch``h]h git fetch}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh> to retrieve objects up to three versions earlier (e.g. 6.0): }(hjhhhNhNubjZ)}(h``git describe``h]h git describe}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubhS will then be able to describe most commits just like it would in a full git clone.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]j.j/uh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubh)}(hZ[:ref:`back to step-by-step guide `] [:ref:`back to section intro `]h](h[}(hj;hhhNhNubh)}(h/:ref:`back to step-by-step guide `h]j)}(hjEh]hback to step-by-step guide}(hjGhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjCubah}(h]h ]h"]h$]h&]refdocj refdomainjQreftyperef refexplicitrefwarnj sources_sbsuh1hhhhM$hj;ubh] [}(hj;hhhNhNubh)}(h&:ref:`back to section intro `h]j)}(hjih]hback to section intro}(hjkhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjgubah}(h]h ]h"]h$]h&]refdocj refdomainjureftyperef refexplicitrefwarnjsourcesuh1hhhhM$hj;ubh]}(hj;hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM$hjhhubj)}(h.. _sources_archive:h]h}(h]h ]h"]h$]h&]jsources-archiveuh1jhM&hjhhhhubeh}(h](,noteworthy-characteristics-of-shallow-clonesjeh ]h"](,noteworthy characteristics of shallow clonessources_shalloweh$]h&]uh1hhjIhhhhhMj7}jjsj9}jjsubh)}(hhh](h)}(h0Downloading the sources using a packages archiveh]h0Downloading the sources using a packages archive}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM)ubh)}(hX}People new to compiling Linux often assume downloading an archive via the front-page of https://kernel.org is the best approach to retrieve Linux' sources. It actually can be, if you are certain to build just one particular kernel version without changing any code. Thing is: you might be sure this will be the case, but in practice it often will turn out to be a wrong assumption.h](hXPeople new to compiling Linux often assume downloading an archive via the front-page of }(hjhhhNhNubj )}(hhttps://kernel.orgh]hhttps://kernel.org}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j hjubhX is the best approach to retrieve Linux’ sources. It actually can be, if you are certain to build just one particular kernel version without changing any code. Thing is: you might be sure this will be the case, but in practice it often will turn out to be a wrong assumption.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM+hjhhubh)}(hXThat's because when reporting or debugging an issue developers will often ask to give another version a try. They also might suggest temporarily undoing a commit with ``git revert`` or might provide various patches to try. Sometimes reporters will also be asked to use ``git bisect`` to find the change causing a problem. These things rely on git or are a lot easier and quicker to handle with it.h](hThat’s because when reporting or debugging an issue developers will often ask to give another version a try. They also might suggest temporarily undoing a commit with }(hjhhhNhNubjZ)}(h``git revert``h]h git revert}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubhX or might provide various patches to try. Sometimes reporters will also be asked to use }(hjhhhNhNubjZ)}(h``git bisect``h]h git bisect}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubhr to find the change causing a problem. These things rely on git or are a lot easier and quicker to handle with it.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM1hjhhubh)}(hX5A shallow clone also does not add any significant overhead. For example, when you use ``git clone --depth=1`` to create a shallow clone of the latest mainline codebase git will only retrieve a little more data than downloading the latest mainline pre-release (aka 'rc') via the front-page of kernel.org would.h](hVA shallow clone also does not add any significant overhead. For example, when you use }(hj hhhNhNubjZ)}(h``git clone --depth=1``h]hgit clone --depth=1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj ubh to create a shallow clone of the latest mainline codebase git will only retrieve a little more data than downloading the latest mainline pre-release (aka ‘rc’) via the front-page of kernel.org would.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM7hjhhubh)}(hXA shallow clone therefore is often the better choice. If you nevertheless want to use a packaged source archive, download one via kernel.org; afterwards extract its content to some directory and change to the subdirectory created during extraction. The rest of the step-by-step guide will work just fine, apart from things that rely on git -- but this mainly concerns the section on successive builds of other versions.h]hXA shallow clone therefore is often the better choice. If you nevertheless want to use a packaged source archive, download one via kernel.org; afterwards extract its content to some directory and change to the subdirectory created during extraction. The rest of the step-by-step guide will work just fine, apart from things that rely on git -- but this mainly concerns the section on successive builds of other versions.}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM<hjhhubh)}(hZ[:ref:`back to step-by-step guide `] [:ref:`back to section intro `]h](h[}(hj9hhhNhNubh)}(h/:ref:`back to step-by-step guide `h]j)}(hjCh]hback to step-by-step guide}(hjEhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]refdocj refdomainjOreftyperef refexplicitrefwarnj sources_sbsuh1hhhhMChj9ubh] [}(hj9hhhNhNubh)}(h&:ref:`back to section intro `h]j)}(hjgh]hback to section intro}(hjihhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjeubah}(h]h ]h"]h$]h&]refdocj refdomainjsreftyperef refexplicitrefwarnjsourcesuh1hhhhMChj9ubh]}(hj9hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMChjhhubj)}(h.. _sources_full:h]h}(h]h ]h"]h$]h&]j sources-fulluh1jhMEhjhhhhubeh}(h](0downloading-the-sources-using-a-packages-archivejeh ]h"](0downloading the sources using a packages archivesources_archiveeh$]h&]uh1hhjIhhhhhM)j7}jjsj9}jjsubh)}(hhh](h)}(h.Downloading the sources using a full git cloneh]h.Downloading the sources using a full git clone}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMHubh)}(hXIf downloading and storing a lot of data (~4,4 Gigabyte as of early 2023) is nothing that bothers you, instead of a shallow clone perform a full git clone instead. You then will avoid the specialties mentioned above and will have all versions and individual commits at hand at any time::h]hXIf downloading and storing a lot of data (~4,4 Gigabyte as of early 2023) is nothing that bothers you, instead of a shallow clone perform a full git clone instead. You then will avoid the specialties mentioned above and will have all versions and individual commits at hand at any time:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMJhjhhubj4)}(hX^curl -L \ https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/clone.bundle \ -o linux-stable.git.bundle git clone linux-stable.git.bundle ~/linux/ rm linux-stable.git.bundle cd ~/linux/ git remote set-url origin \ https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git git fetch origin git checkout --detach origin/masterh]hX^curl -L \ https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/clone.bundle \ -o linux-stable.git.bundle git clone linux-stable.git.bundle ~/linux/ rm linux-stable.git.bundle cd ~/linux/ git remote set-url origin \ https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git git fetch origin git checkout --detach origin/master}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhMOhjhhubh)}(hZ[:ref:`back to step-by-step guide `] [:ref:`back to section intro `]h](h[}(hjhhhNhNubh)}(h/:ref:`back to step-by-step guide `h]j)}(hjh]hback to step-by-step guide}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj sources_sbsuh1hhhhMZhjubh] [}(hjhhhNhNubh)}(h&:ref:`back to section intro `h]j)}(hjh]hback to section intro}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnjsourcesuh1hhhhMZhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMZhjhhubj)}(h.. _sources_snapshot:h]h}(h]h ]h"]h$]h&]jsources-snapshotuh1jhM\hjhhhhubeh}(h](.downloading-the-sources-using-a-full-git-clonejeh ]h"](.downloading the sources using a full git clone sources_fulleh$]h&]uh1hhjIhhhhhMHj7}j9jsj9}jjsubh)}(hhh](h)}(h-Proper pre-releases (RCs) vs. latest mainlineh]h-Proper pre-releases (RCs) vs. latest mainline}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hhhhhM_ubh)}(hXoWhen cloning the sources using git and checking out origin/master, you often will retrieve a codebase that is somewhere between the latest and the next release or pre-release. This almost always is the code you want when giving mainline a shot: pre-releases like v6.1-rc5 are in no way special, as they do not get any significant extra testing before being published.h]hXoWhen cloning the sources using git and checking out origin/master, you often will retrieve a codebase that is somewhere between the latest and the next release or pre-release. This almost always is the code you want when giving mainline a shot: pre-releases like v6.1-rc5 are in no way special, as they do not get any significant extra testing before being published.}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMahj>hhubh)}(hX~There is one exception: you might want to stick to the latest mainline release (say v6.1) before its successor's first pre-release (v6.2-rc1) is out. That is because compiler errors and other problems are more likely to occur during this time, as mainline then is in its 'merge window': a usually two week long phase, in which the bulk of the changes for the next release is merged.h]hXThere is one exception: you might want to stick to the latest mainline release (say v6.1) before its successor’s first pre-release (v6.2-rc1) is out. That is because compiler errors and other problems are more likely to occur during this time, as mainline then is in its ‘merge window’: a usually two week long phase, in which the bulk of the changes for the next release is merged.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMghj>hhubh)}(hZ[:ref:`back to step-by-step guide `] [:ref:`back to section intro `]h](h[}(hjkhhhNhNubh)}(h/:ref:`back to step-by-step guide `h]j)}(hjuh]hback to step-by-step guide}(hjwhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjsubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj sources_sbsuh1hhhhMmhjkubh] [}(hjkhhhNhNubh)}(h&:ref:`back to section intro `h]j)}(hjh]hback to section intro}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjsourcesuh1hhhhMmhjkubh]}(hjkhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMmhj>hhubj)}(h.. _sources_fresher:h]h}(h]h ]h"]h$]h&]jsources-fresheruh1jhMohj>hhhhubeh}(h](*proper-pre-releases-rcs-vs-latest-mainlinej2eh ]h"](-proper pre-releases (rcs) vs. latest mainlinesources_snapshoteh$]h&]uh1hhjIhhhhhM_j7}jj(sj9}j2j(subh)}(hhh](h)}(hAvoiding the mainline lagh]hAvoiding the mainline lag}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMrubh)}(hX The explanations for both the shallow clone and the full clone both retrieve the code from the Linux stable git repository. That makes things simpler for this document's audience, as it allows easy access to both mainline and stable/longterm releases. This approach has just one downside:h]hX"The explanations for both the shallow clone and the full clone both retrieve the code from the Linux stable git repository. That makes things simpler for this document’s audience, as it allows easy access to both mainline and stable/longterm releases. This approach has just one downside:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMthjhhubh)}(hX<Changes merged into the mainline repository are only synced to the master branch of the Linux stable repository every few hours. This lag most of the time is not something to worry about; but in case you really need the latest code, just add the mainline repo as additional remote and checkout the code from there::h]hX;Changes merged into the mainline repository are only synced to the master branch of the Linux stable repository every few hours. This lag most of the time is not something to worry about; but in case you really need the latest code, just add the mainline repo as additional remote and checkout the code from there:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMyhjhhubj4)}(hgit remote add mainline \ https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git git fetch mainline git checkout --detach mainline/masterh]hgit remote add mainline \ https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git git fetch mainline git checkout --detach mainline/master}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhM~hjhhubh)}(hWhen doing this with a shallow clone, remember to call ``git fetch`` with one of the parameters described earlier to limit the depth.h](h7When doing this with a shallow clone, remember to call }(hjhhhNhNubjZ)}(h ``git fetch``h]h git fetch}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubhA with one of the parameters described earlier to limit the depth.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hZ[:ref:`back to step-by-step guide `] [:ref:`back to section intro `]h](h[}(hj2hhhNhNubh)}(h/:ref:`back to step-by-step guide `h]j)}(hj<h]hback to step-by-step guide}(hj>hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj:ubah}(h]h ]h"]h$]h&]refdocj refdomainjHreftyperef refexplicitrefwarnj sources_sbsuh1hhhhMhj2ubh] [}(hj2hhhNhNubh)}(h&:ref:`back to section intro `h]j)}(hj`h]hback to section intro}(hjbhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj^ubah}(h]h ]h"]h$]h&]refdocj refdomainjlreftyperef refexplicitrefwarnjsourcesuh1hhhhMhj2ubh]}(hj2hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(h .. _patching:h]h}(h]h ]h"]h$]h&]jpatchinguh1jhMhjhhhhubeh}(h](avoiding-the-mainline-lagjeh ]h"](avoiding the mainline lagsources_freshereh$]h&]uh1hhjIhhhhhMrj7}jjsj9}jjsubeh}(h](download-the-sourcesj=eh ]h"](download the sourcessourceseh$]h&]uh1hhj0 hhhhhMj7}jj3sj9}j=j3subh)}(hhh](h)}(hPatch the sources (optional)h]hPatch the sources (optional)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(hR*In case you want to apply a kernel patch, do so now.* [:ref:`...`] h]h)}(hQ*In case you want to apply a kernel patch, do so now.* [:ref:`...`]h](j)}(h6*In case you want to apply a kernel patch, do so now.*h]h4In case you want to apply a kernel patch, do so now.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh [}(hjhhhNhNubh)}(h:ref:`...`h]j)}(hjh]h...}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj patching_sbsuh1hhhhMhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubh)}(hThis is the point where you might want to patch your kernel -- for example when a developer proposed a fix and asked you to check if it helps. The step-by-step guide already explains everything crucial here.h]hThis is the point where you might want to patch your kernel -- for example when a developer proposed a fix and asked you to check if it helps. The step-by-step guide already explains everything crucial here.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(h2[:ref:`back to step-by-step guide `]h](h[}(hjhhhNhNubh)}(h0:ref:`back to step-by-step guide `h]j)}(hjh]hback to step-by-step guide}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainj(reftyperef refexplicitrefwarnj patching_sbsuh1hhhhMhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(h .. _tagging:h]h}(h]h ]h"]h$]h&]jtagginguh1jhMhjhhhhubeh}(h](patch-the-sources-optionaljeh ]h"](patch the sources (optional)patchingeh$]h&]uh1hhj0 hhhhhMj7}jUjsj9}jjsubh)}(hhh](h)}(h0Tagging this kernel build (optional, often wise)h]h0Tagging this kernel build (optional, often wise)}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjZhhhhhMubj)}(h*If you patched your kernel or already have that kernel version installed, better tag your kernel by extending its release name:* [:ref:`...`] h]h)}(h*If you patched your kernel or already have that kernel version installed, better tag your kernel by extending its release name:* [:ref:`...`]h](j)}(h*If you patched your kernel or already have that kernel version installed, better tag your kernel by extending its release name:*h]hIf you patched your kernel or already have that kernel version installed, better tag your kernel by extending its release name:}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjoubh [}(hjohhhNhNubh)}(h:ref:`...`h]j)}(hjh]h...}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj tagging_sbsuh1hhhhMhjoubh]}(hjohhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjkubah}(h]h ]h"]h$]h&]uh1jhhhMhjZhhubh)}(hTagging your kernel will help avoid confusion later, especially when you patched your kernel. Adding an individual tag will also ensure the kernel's image and its modules are installed in parallel to any existing kernels.h]hTagging your kernel will help avoid confusion later, especially when you patched your kernel. Adding an individual tag will also ensure the kernel’s image and its modules are installed in parallel to any existing kernels.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjZhhubh)}(hXFThere are various ways to add such a tag. The step-by-step guide realizes one by creating a 'localversion' file in your build directory from which the kernel build scripts will automatically pick up the tag. You can later change that file to use a different tag in subsequent builds or simply remove that file to dump the tag.h]hXJThere are various ways to add such a tag. The step-by-step guide realizes one by creating a ‘localversion’ file in your build directory from which the kernel build scripts will automatically pick up the tag. You can later change that file to use a different tag in subsequent builds or simply remove that file to dump the tag.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjZhhubh)}(h1[:ref:`back to step-by-step guide `] h](h[}(hjhhhNhNubh)}(h/:ref:`back to step-by-step guide `h]j)}(hjh]hback to step-by-step guide}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnj tagging_sbsuh1hhhhMhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjZhhubj)}(h.. _configuration:h]h}(h]h ]h"]h$]h&]j configurationuh1jhMhjZhhhhubeh}(h](-tagging-this-kernel-build-optional-often-wisejNeh ]h"](0tagging this kernel build (optional, often wise)taggingeh$]h&]uh1hhj0 hhhhhMj7}jjDsj9}jNjDsubh)}(hhh](h)}(h.Define the build configuration for your kernelh]h.Define the build configuration for your kernel}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(hv*Create the build configuration for your kernel based on an existing configuration.* [:ref:`... `] h]h)}(hu*Create the build configuration for your kernel based on an existing configuration.* [:ref:`... `]h](j)}(hT*Create the build configuration for your kernel based on an existing configuration.*h]hRCreate the build configuration for your kernel based on an existing configuration.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.ubh [}(hj.hhhNhNubh)}(h:ref:`... `h]j)}(hjFh]h...}(hjHhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjDubah}(h]h ]h"]h$]h&]refdocj refdomainjRreftyperef refexplicitrefwarnjconfiguration_sbsuh1hhhhMhj.ubh]}(hj.hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj*ubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubh)}(hQThere are various aspects for this steps that require a more careful explanation:h]hQThere are various aspects for this steps that require a more careful explanation:}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hhh](h)}(h6Pitfalls when using another configuration file as baseh]h6Pitfalls when using another configuration file as base}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hdMake targets like localmodconfig and olddefconfig share a few common snares you want to be aware of:h]hdMake targets like localmodconfig and olddefconfig share a few common snares you want to be aware of:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(hXk* These targets will reuse a kernel build configuration in your build directory (e.g. '~/linux/.config'), if one exists. In case you want to start from scratch you thus need to delete it. * The make targets try to find the configuration for your running kernel automatically, but might choose poorly. A line like '# using defaults found in /boot/config-6.0.7-250.fc36.x86_64' or 'using config: '/boot/config-6.0.7-250.fc36.x86_64' tells you which file they picked. If that is not the intended one, simply store it as '~/linux/.config' before using these make targets. * Unexpected things might happen if you try to use a config file prepared for one kernel (say v6.0) on an older generation (say v5.15). In that case you might want to use a configuration as base which your distribution utilized when they used that or an slightly older kernel version. h]j)}(hhh](j)}(hThese targets will reuse a kernel build configuration in your build directory (e.g. '~/linux/.config'), if one exists. In case you want to start from scratch you thus need to delete it. h]h)}(hThese targets will reuse a kernel build configuration in your build directory (e.g. '~/linux/.config'), if one exists. In case you want to start from scratch you thus need to delete it.h]hThese targets will reuse a kernel build configuration in your build directory (e.g. ‘~/linux/.config’), if one exists. In case you want to start from scratch you thus need to delete it.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hXzThe make targets try to find the configuration for your running kernel automatically, but might choose poorly. A line like '# using defaults found in /boot/config-6.0.7-250.fc36.x86_64' or 'using config: '/boot/config-6.0.7-250.fc36.x86_64' tells you which file they picked. If that is not the intended one, simply store it as '~/linux/.config' before using these make targets. h]h)}(hXyThe make targets try to find the configuration for your running kernel automatically, but might choose poorly. A line like '# using defaults found in /boot/config-6.0.7-250.fc36.x86_64' or 'using config: '/boot/config-6.0.7-250.fc36.x86_64' tells you which file they picked. If that is not the intended one, simply store it as '~/linux/.config' before using these make targets.h]hXThe make targets try to find the configuration for your running kernel automatically, but might choose poorly. A line like ‘# using defaults found in /boot/config-6.0.7-250.fc36.x86_64’ or ‘using config: ‘/boot/config-6.0.7-250.fc36.x86_64’ tells you which file they picked. If that is not the intended one, simply store it as ‘~/linux/.config’ before using these make targets.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hXUnexpected things might happen if you try to use a config file prepared for one kernel (say v6.0) on an older generation (say v5.15). In that case you might want to use a configuration as base which your distribution utilized when they used that or an slightly older kernel version. h]h)}(hXUnexpected things might happen if you try to use a config file prepared for one kernel (say v6.0) on an older generation (say v5.15). In that case you might want to use a configuration as base which your distribution utilized when they used that or an slightly older kernel version.h]hXUnexpected things might happen if you try to use a config file prepared for one kernel (say v6.0) on an older generation (say v5.15). In that case you might want to use a configuration as base which your distribution utilized when they used that or an slightly older kernel version.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]j.j/uh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubeh}(h]6pitfalls-when-using-another-configuration-file-as-baseah ]h"]6pitfalls when using another configuration file as baseah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(hInfluencing the configurationh]hInfluencing the configuration}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hThe make target olddefconfig and the ``yes "" |`` used when utilizing localmodconfig will set any undefined build options to their default value. This among others will disable many kernel features that were introduced after your base kernel was released.h](h%The make target olddefconfig and the }(hjhhhNhNubjZ)}(h ``yes "" |``h]hyes "" |}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh used when utilizing localmodconfig will set any undefined build options to their default value. This among others will disable many kernel features that were introduced after your base kernel was released.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXDIf you want to set these configurations options manually, use ``oldconfig`` instead of ``olddefconfig`` or omit the ``yes "" |`` when utilizing localmodconfig. Then for each undefined configuration option you will be asked how to proceed. In case you are unsure what to answer, simply hit 'enter' to apply the default value.h](h>If you want to set these configurations options manually, use }(hj5hhhNhNubjZ)}(h ``oldconfig``h]h oldconfig}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj5ubh instead of }(hj5hhhNhNubjZ)}(h``olddefconfig``h]h olddefconfig}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj5ubh or omit the }(hj5hhhNhNubjZ)}(h ``yes "" |``h]hyes "" |}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj5ubh when utilizing localmodconfig. Then for each undefined configuration option you will be asked how to proceed. In case you are unsure what to answer, simply hit ‘enter’ to apply the default value.}(hj5hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]influencing-the-configurationah ]h"]influencing the configurationah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(h%Big pitfall when using localmodconfigh]h%Big pitfall when using localmodconfig}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hXAs explained briefly in the step-by-step guide already: with localmodconfig it can easily happen that your self-built kernel will lack modules for tasks you did not perform before utilizing this make target. That's because those tasks require kernel modules that are normally autoloaded when you perform that task for the first time; if you didn't perform that task at least once before using localmodconfig, the latter will thus assume these modules are superfluous and disable them.h]hXAs explained briefly in the step-by-step guide already: with localmodconfig it can easily happen that your self-built kernel will lack modules for tasks you did not perform before utilizing this make target. That’s because those tasks require kernel modules that are normally autoloaded when you perform that task for the first time; if you didn’t perform that task at least once before using localmodconfig, the latter will thus assume these modules are superfluous and disable them.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXYou can try to avoid this by performing typical tasks that often will autoload additional kernel modules: start a VM, establish VPN connections, loop-mount a CD/DVD ISO, mount network shares (CIFS, NFS, ...), and connect all external devices (2FA keys, headsets, webcams, ...) as well as storage devices with file systems you otherwise do not utilize (btrfs, ext4, FAT, NTFS, XFS, ...). But it is hard to think of everything that might be needed -- even kernel developers often forget one thing or another at this point.h]hXYou can try to avoid this by performing typical tasks that often will autoload additional kernel modules: start a VM, establish VPN connections, loop-mount a CD/DVD ISO, mount network shares (CIFS, NFS, ...), and connect all external devices (2FA keys, headsets, webcams, ...) as well as storage devices with file systems you otherwise do not utilize (btrfs, ext4, FAT, NTFS, XFS, ...). But it is hard to think of everything that might be needed -- even kernel developers often forget one thing or another at this point.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXDo not let that risk bother you, especially when compiling a kernel only for testing purposes: everything typically crucial will be there. And if you forget something important you can turn on a missing feature later and quickly run the commands to compile and install a better kernel.h]hXDo not let that risk bother you, especially when compiling a kernel only for testing purposes: everything typically crucial will be there. And if you forget something important you can turn on a missing feature later and quickly run the commands to compile and install a better kernel.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXuBut if you plan to build and use self-built kernels regularly, you might want to reduce the risk by recording which modules your system loads over the course of a few weeks. You can automate this with `modprobed-db `_. Afterwards use ``LSMOD=`` to point localmodconfig to the list of modules modprobed-db noticed being used::h](hBut if you plan to build and use self-built kernels regularly, you might want to reduce the risk by recording which modules your system loads over the course of a few weeks. You can automate this with }(hjhhhNhNubj )}(h:`modprobed-db `_h]h modprobed-db}(hjhhhNhNubah}(h]h ]h"]h$]h&]name modprobed-dbrefuri(https://github.com/graysky2/modprobed-dbuh1j hjubj)}(h+ h]h}(h] modprobed-dbah ]h"] modprobed-dbah$]h&]refurijuh1j referencedKhjubh. Afterwards use }(hjhhhNhNubjZ)}(h``LSMOD=``h]h LSMOD=}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubhP to point localmodconfig to the list of modules modprobed-db noticed being used:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj4)}(hAyes "" | make LSMOD="${HOME}"/.config/modprobed.db localmodconfigh]hAyes "" | make LSMOD="${HOME}"/.config/modprobed.db localmodconfig}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhMhjhhubeh}(h]%big-pitfall-when-using-localmodconfigah ]h"]%big pitfall when using localmodconfigah$]h&]uh1hhjhhhhhMubh)}(hhh](h)}(h#Remote building with localmodconfigh]h#Remote building with localmodconfig}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hXIf you want to use localmodconfig to build a kernel for another machine, run ``lsmod > lsmod_foo-machine`` on it and transfer that file to your build host. Now point the build scripts to the file like this: ``yes "" | make LSMOD=~/lsmod_foo-machine localmodconfig``. Note, in this case you likely want to copy a base kernel configuration from the other machine over as well and place it as .config in your build directory.h](hMIf you want to use localmodconfig to build a kernel for another machine, run }(hj'hhhNhNubjZ)}(h``lsmod > lsmod_foo-machine``h]hlsmod > lsmod_foo-machine}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj'ubhe on it and transfer that file to your build host. Now point the build scripts to the file like this: }(hj'hhhNhNubjZ)}(h:``yes "" | make LSMOD=~/lsmod_foo-machine localmodconfig``h]h6yes "" | make LSMOD=~/lsmod_foo-machine localmodconfig}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj'ubh. Note, in this case you likely want to copy a base kernel configuration from the other machine over as well and place it as .config in your build directory.}(hj'hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(h7[:ref:`back to step-by-step guide `]h](h[}(hjYhhhNhNubh)}(h5:ref:`back to step-by-step guide `h]j)}(hjch]hback to step-by-step guide}(hjehhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjaubah}(h]h ]h"]h$]h&]refdocj refdomainjoreftyperef refexplicitrefwarnjconfiguration_sbsuh1hhhhMhjYubh]}(hjYhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(h.. _configmods:h]h}(h]h ]h"]h$]h&]j configmodsuh1jhMhjhhhhubeh}(h]#remote-building-with-localmodconfigah ]h"]#remote building with localmodconfigah$]h&]uh1hhjhhhhhMubeh}(h](.define-the-build-configuration-for-your-kernelj eh ]h"](.define the build configuration for your kernel configurationeh$]h&]uh1hhj0 hhhhhMj7}jjsj9}j jsubh)}(hhh](h)}(hAdjust build configurationh]hAdjust build configuration}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM ubj)}(hR*Check if you might want to or have to adjust some kernel configuration options:* h]h)}(hQ*Check if you might want to or have to adjust some kernel configuration options:*h]j)}(hjh]hOCheck if you might want to or have to adjust some kernel configuration options:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1jhhhM hjhhubh)}(hiDepending on your needs you at this point might want or have to adjust some kernel configuration options.h]hiDepending on your needs you at this point might want or have to adjust some kernel configuration options.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(h.. _configmods_debugsymbols:h]h}(h]h ]h"]h$]h&]jconfigmods-debugsymbolsuh1jhMhjhhhhubh)}(hhh](h)}(h Debug symbolsh]h Debug symbols}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubj)}(hN*Evaluate how you want to handle debug symbols.* [:ref:`...`] h]h)}(hM*Evaluate how you want to handle debug symbols.* [:ref:`...`]h](j)}(h0*Evaluate how you want to handle debug symbols.*h]h.Evaluate how you want to handle debug symbols.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh [}(hj hhhNhNubh)}(h:ref:`...`h]j)}(hj!h]h...}(hj#hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainj-reftyperef refexplicitrefwarnjconfigmods_sbsuh1hhhhMhj ubh]}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjhhubh)}(hMost users do not need to care about this, it's often fine to leave everything as it is; but you should take a closer look at this, if you might need to decode a stack trace or want to reduce space consumption.h]hMost users do not need to care about this, it’s often fine to leave everything as it is; but you should take a closer look at this, if you might need to decode a stack trace or want to reduce space consumption.}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXXHaving debug symbols available can be important when your kernel throws a 'panic', 'Oops', 'warning', or 'BUG' later when running, as then you will be able to find the exact place where the problem occurred in the code. But collecting and embedding the needed debug information takes time and consumes quite a bit of space: in late 2022 the build artifacts for a typical x86 kernel configured with localmodconfig consumed around 5 Gigabyte of space with debug symbols, but less than 1 when they were disabled. The resulting kernel image and the modules are bigger as well, which increases load times.h]hXhHaving debug symbols available can be important when your kernel throws a ‘panic’, ‘Oops’, ‘warning’, or ‘BUG’ later when running, as then you will be able to find the exact place where the problem occurred in the code. But collecting and embedding the needed debug information takes time and consumes quite a bit of space: in late 2022 the build artifacts for a typical x86 kernel configured with localmodconfig consumed around 5 Gigabyte of space with debug symbols, but less than 1 when they were disabled. The resulting kernel image and the modules are bigger as well, which increases load times.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hHence, if you want a small kernel and are unlikely to decode a stack trace later, you might want to disable debug symbols to avoid above downsides::h]hHence, if you want a small kernel and are unlikely to decode a stack trace later, you might want to disable debug symbols to avoid above downsides:}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM&hjhhubj4)}(h./scripts/config --file .config -d DEBUG_INFO \ -d DEBUG_INFO_DWARF_TOOLCHAIN_DEFAULT -d DEBUG_INFO_DWARF4 \ -d DEBUG_INFO_DWARF5 -e CONFIG_DEBUG_INFO_NONE make olddefconfigh]h./scripts/config --file .config -d DEBUG_INFO \ -d DEBUG_INFO_DWARF_TOOLCHAIN_DEFAULT -d DEBUG_INFO_DWARF4 \ -d DEBUG_INFO_DWARF5 -e CONFIG_DEBUG_INFO_NONE make olddefconfig}hjysbah}(h]h ]h"]h$]h&]hhuh1j3hhhM)hjhhubh)}(hYou on the other hand definitely want to enable them, if there is a decent chance that you need to decode a stack trace later (as explained by 'Decode failure messages' in Documentation/admin-guide/tainted-kernels.rst in more detail)::h]hYou on the other hand definitely want to enable them, if there is a decent chance that you need to decode a stack trace later (as explained by ‘Decode failure messages’ in Documentation/admin-guide/tainted-kernels.rst in more detail):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM.hjhhubj4)}(h./scripts/config --file .config -d DEBUG_INFO_NONE -e DEBUG_KERNEL -e DEBUG_INFO -e DEBUG_INFO_DWARF_TOOLCHAIN_DEFAULT -e KALLSYMS -e KALLSYMS_ALL make olddefconfigh]h./scripts/config --file .config -d DEBUG_INFO_NONE -e DEBUG_KERNEL -e DEBUG_INFO -e DEBUG_INFO_DWARF_TOOLCHAIN_DEFAULT -e KALLSYMS -e KALLSYMS_ALL make olddefconfig}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhM3hjhhubh)}(hNote, many mainstream distributions enable debug symbols in their kernel configurations -- make targets like localmodconfig and olddefconfig thus will often pick that setting up.h]hNote, many mainstream distributions enable debug symbols in their kernel configurations -- make targets like localmodconfig and olddefconfig thus will often pick that setting up.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM7hjhhubh)}(h4[:ref:`back to step-by-step guide `]h](h[}(hjhhhNhNubh)}(h2:ref:`back to step-by-step guide `h]j)}(hjh]hback to step-by-step guide}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjconfigmods_sbsuh1hhhhM;hjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM;hjhhubj)}(h.. _configmods_distros:h]h}(h]h ]h"]h$]h&]jconfigmods-distrosuh1jhM=hjhhhhubeh}(h]( debug-symbolsjeh ]h"]( debug symbolsconfigmods_debugsymbolseh$]h&]uh1hhjhhhhhMj7}jjsj9}jjsubh)}(hhh](h)}(hDistro specific adjustmentsh]hDistro specific adjustments}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM@ubj)}(h0*Are you running* [:ref:`... `] h]h)}(h/*Are you running* [:ref:`... `]h](j)}(h*Are you running*h]hAre you running}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh [}(hjhhhNhNubh)}(h:ref:`... `h]j)}(hj&h]h...}(hj(hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj$ubah}(h]h ]h"]h$]h&]refdocj refdomainj2reftyperef refexplicitrefwarnjconfigmods_sbsuh1hhhhMBhjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMBhj ubah}(h]h ]h"]h$]h&]uh1jhhhMBhjhhubh)}(hThe following sections help you to avoid build problems that are known to occur when following this guide on a few commodity distributions.h]hThe following sections help you to avoid build problems that are known to occur when following this guide on a few commodity distributions.}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMDhjhhubh)}(h **Debian:**h]hstrong)}(hjdh]hDebian:}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1jfhjbubah}(h]h ]h"]h$]h&]uh1hhhhMGhjhhubj)}(hX* Remove a stale reference to a certificate file that would cause your build to fail:: ./scripts/config --file .config --set-str SYSTEM_TRUSTED_KEYS '' Alternatively, download the needed certificate and make that configuration option point to it, as `the Debian handbook explains in more detail `_ -- or generate your own, as explained in Documentation/admin-guide/module-signing.rst. h]j)}(hhh]j)}(hXRemove a stale reference to a certificate file that would cause your build to fail:: ./scripts/config --file .config --set-str SYSTEM_TRUSTED_KEYS '' Alternatively, download the needed certificate and make that configuration option point to it, as `the Debian handbook explains in more detail `_ -- or generate your own, as explained in Documentation/admin-guide/module-signing.rst. h](h)}(hTRemove a stale reference to a certificate file that would cause your build to fail::h]hSRemove a stale reference to a certificate file that would cause your build to fail:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMIhjubj4)}(h@./scripts/config --file .config --set-str SYSTEM_TRUSTED_KEYS ''h]h@./scripts/config --file .config --set-str SYSTEM_TRUSTED_KEYS ''}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhMLhjubh)}(hX1Alternatively, download the needed certificate and make that configuration option point to it, as `the Debian handbook explains in more detail `_ -- or generate your own, as explained in Documentation/admin-guide/module-signing.rst.h](hbAlternatively, download the needed certificate and make that configuration option point to it, as }(hjhhhNhNubj )}(hx`the Debian handbook explains in more detail `_h]h+the Debian handbook explains in more detail}(hjhhhNhNubah}(h]h ]h"]h$]h&]name+the Debian handbook explains in more detailjGhttps://debian-handbook.info/browse/stable/sect.kernel-compilation.htmluh1j hjubj)}(hJ h]h}(h]+the-debian-handbook-explains-in-more-detailah ]h"]+the debian handbook explains in more detailah$]h&]refurijuh1jjKhjubhW -- or generate your own, as explained in Documentation/admin-guide/module-signing.rst.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMNhjubeh}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]j.j/uh1jhhhMIhj{ubah}(h]h ]h"]h$]h&]uh1jhhhMIhjhhubh)}(h4[:ref:`back to step-by-step guide `]h](h[}(hjhhhNhNubh)}(h2:ref:`back to step-by-step guide `h]j)}(hjh]hback to step-by-step guide}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjconfigmods_sbsuh1hhhhMThjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMThjhhubj)}(h.. _configmods_individual:h]h}(h]h ]h"]h$]h&]jconfigmods-individualuh1jhMVhjhhhhubeh}(h](distro-specific-adjustmentsjeh ]h"](distro specific adjustmentsconfigmods_distroseh$]h&]uh1hhjhhhhhM@j7}j'jsj9}jjsubh)}(hhh](h)}(hIndividual adjustmentsh]hIndividual adjustments}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hhhhhMYubj)}(hk*If you want to influence the other aspects of the configuration, do so now* [:ref:`... `] h]h)}(hj*If you want to influence the other aspects of the configuration, do so now* [:ref:`... `]h](j)}(hL*If you want to influence the other aspects of the configuration, do so now*h]hJIf you want to influence the other aspects of the configuration, do so now}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubh [}(hjAhhhNhNubh)}(h:ref:`... `h]j)}(hjYh]h...}(hj[hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjWubah}(h]h ]h"]h$]h&]refdocj refdomainjereftyperef refexplicitrefwarnjconfigmods_sbsuh1hhhhM[hjAubh]}(hjAhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM[hj=ubah}(h]h ]h"]h$]h&]uh1jhhhM[hj,hhubh)}(hXYou at this point can use a command like ``make menuconfig`` to enable or disable certain features using a text-based user interface; to use a graphical configuration utilize, use the make target ``xconfig`` or ``gconfig`` instead. All of them require development libraries from toolkits they are based on (ncurses, Qt5, Gtk2); an error message will tell you if something required is missing.h](h)You at this point can use a command like }(hjhhhNhNubjZ)}(h``make menuconfig``h]hmake menuconfig}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh to enable or disable certain features using a text-based user interface; to use a graphical configuration utilize, use the make target }(hjhhhNhNubjZ)}(h ``xconfig``h]hxconfig}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh or }(hjhhhNhNubjZ)}(h ``gconfig``h]hgconfig}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh instead. All of them require development libraries from toolkits they are based on (ncurses, Qt5, Gtk2); an error message will tell you if something required is missing.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM^hj,hhubh)}(h4[:ref:`back to step-by-step guide `]h](h[}(hjhhhNhNubh)}(h2:ref:`back to step-by-step guide `h]j)}(hjh]hback to step-by-step guide}(hjhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftyperef refexplicitrefwarnjconfigmods_sbsuh1hhhhMehjubh]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMehj,hhubj)}(h .. _build:h]h}(h]h ]h"]h$]h&]jbuilduh1jhMghj,hhhhubeh}(h](individual-adjustmentsj eh ]h"](individual adjustmentsconfigmods_individualeh$]h&]uh1hhjhhhhhMYj7}jjsj9}j jsubeh}(h](adjust-build-configurationjeh ]h"](adjust build configuration configmodseh$]h&]uh1hhj0 hhhhhM j7}jjsj9}jjsubh)}(hhh](h)}(hBuild your kernelh]hBuild your kernel}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMjubj)}(hJ*Build the image and the modules of your kernel* [:ref:`... `] h]h)}(hI*Build the image and the modules of your kernel* [:ref:`... `]h](j)}(h0*Build the image and the modules of your kernel*h]h.Build the image and the modules of your kernel}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubh [}(hj3hhhNhNubh)}(h:ref:`... `h]j)}(hjKh]h...}(hjMhhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjIubah}(h]h ]h"]h$]h&]refdocj refdomainjWreftyperef refexplicitrefwarnj build_sbsuh1hhhhMlhj3ubh]}(hj3hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMlhj/ubah}(h]h ]h"]h$]h&]uh1jhhhMlhjhhubh)}(hA lot can go wrong at this stage, but the instructions below will help you help yourself. Another subsection explains how to directly package your kernel up as deb, rpm or tar file.h]hA lot can go wrong at this stage, but the instructions below will help you help yourself. Another subsection explains how to directly package your kernel up as deb, rpm or tar file.}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMnhjhhubh)}(hhh](h)}(hDealing with build errorsh]hDealing with build errors}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMsubh)}(hXWhen a build error occurs, it might be caused by some aspect of your machine's setup that often can be fixed quickly; other times though the problem lies in the code and can only be fixed by a developer. A close examination of the failure messages coupled with some research on the internet will often tell you which of the two it is. To perform such an investigation, restart the build process like this::h]hXWhen a build error occurs, it might be caused by some aspect of your machine’s setup that often can be fixed quickly; other times though the problem lies in the code and can only be fixed by a developer. A close examination of the failure messages coupled with some research on the internet will often tell you which of the two it is. To perform such an investigation, restart the build process like this:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMuhjhhubj4)}(hmake V=1h]hmake V=1}hjsbah}(h]h ]h"]h$]h&]hhuh1j3hhhM|hjhhubh)}(hX,The ``V=1`` activates verbose output, which might be needed to see the actual error. To make it easier to spot, this command also omits the ``-j $(nproc --all)`` used earlier to utilize every CPU core in the system for the job -- but this parallelism also results in some clutter when failures occur.h](hThe }(hjhhhNhNubjZ)}(h``V=1``h]hV=1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh activates verbose output, which might be needed to see the actual error. To make it easier to spot, this command also omits the }(hjhhhNhNubjZ)}(h``-j $(nproc --all)``h]h-j $(nproc --all)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh used earlier to utilize every CPU core in the system for the job -- but this parallelism also results in some clutter when failures occur.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM~hjhhubh)}(hXAfter a few seconds the build process should run into the error again. Now try to find the most crucial line describing the problem. Then search the internet for the most important and non-generic section of that line (say 4 to 8 words); avoid or remove anything that looks remotely system-specific, like your username or local path names like ``/home/username/linux/``. First try your regular internet search engine with that string, afterwards search Linux kernel mailing lists via `lore.kernel.org/all/ `_.h](hXXAfter a few seconds the build process should run into the error again. Now try to find the most crucial line describing the problem. Then search the internet for the most important and non-generic section of that line (say 4 to 8 words); avoid or remove anything that looks remotely system-specific, like your username or local path names like }(hjhhhNhNubjZ)}(h``/home/username/linux/``h]h/home/username/linux/}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubhs. First try your regular internet search engine with that string, afterwards search Linux kernel mailing lists via }(hjhhhNhNubj )}(h6`lore.kernel.org/all/ `_h]hlore.kernel.org/all/}(hjhhhNhNubah}(h]h ]h"]h$]h&]namelore.kernel.org/all/jhttps://lore.kernel.org/all/uh1j hjubj)}(h h]h}(h]lore-kernel-org-allah ]h"]lore.kernel.org/all/ah$]h&]refurijuh1jjKhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hX;This most of the time will find something that will explain what is wrong; quite often one of the hits will provide a solution for your problem, too. If you do not find anything that matches your problem, try again from a different angle by modifying your search terms or using another line from the error messages.h]hX;This most of the time will find something that will explain what is wrong; quite often one of the hits will provide a solution for your problem, too. If you do not find anything that matches your problem, try again from a different angle by modifying your search terms or using another line from the error messages.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hX%In the end, most trouble you are to run into has likely been encountered and reported by others already. That includes issues where the cause is not your system, but lies the code. If you run into one of those, you might thus find a solution (e.g. a patch) or workaround for your problem, too.h]hX%In the end, most trouble you are to run into has likely been encountered and reported by others already. That includes issues where the cause is not your system, but lies the code. If you run into one of those, you might thus find a solution (e.g. a patch) or workaround for your problem, too.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]dealing-with-build-errorsah ]h"]dealing with build errorsah$]h&]uh1hhjhhhhhMsubh)}(hhh](h)}(hPackage your kernel uph]hPackage your kernel up}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjLhhhhhMubh)}(hX+The step-by-step guide uses the default make targets (e.g. 'bzImage' and 'modules' on x86) to build the image and the modules of your kernel, which later steps of the guide then install. You instead can also directly build everything and directly package it up by using one of the following targets:h]hX3The step-by-step guide uses the default make targets (e.g. ‘bzImage’ and ‘modules’ on x86) to build the image and the modules of your kernel, which later steps of the guide then install. You instead can also directly build everything and directly package it up by using one of the following targets:}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjLhhubj)}(h* ``make -j $(nproc --all) bindeb-pkg`` to generate a deb package * ``make -j $(nproc --all) binrpm-pkg`` to generate a rpm package * ``make -j $(nproc --all) tarbz2-pkg`` to generate a bz2 compressed tarball h]j)}(hhh](j)}(h@``make -j $(nproc --all) bindeb-pkg`` to generate a deb package h]h)}(h?``make -j $(nproc --all) bindeb-pkg`` to generate a deb packageh](jZ)}(h%``make -j $(nproc --all) bindeb-pkg``h]h!make -j $(nproc --all) bindeb-pkg}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjvubh to generate a deb package}(hjvhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjrubah}(h]h ]h"]h$]h&]uh1jhjoubj)}(h@``make -j $(nproc --all) binrpm-pkg`` to generate a rpm package h]h)}(h?``make -j $(nproc --all) binrpm-pkg`` to generate a rpm packageh](jZ)}(h%``make -j $(nproc --all) binrpm-pkg``h]h!make -j $(nproc --all) binrpm-pkg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh to generate a rpm package}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjoubj)}(hK``make -j $(nproc --all) tarbz2-pkg`` to generate a bz2 compressed tarball h]h)}(hJ``make -j $(nproc --all) tarbz2-pkg`` to generate a bz2 compressed tarballh](jZ)}(h%``make -j $(nproc --all) tarbz2-pkg``h]h!make -j $(nproc --all) tarbz2-pkg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh% to generate a bz2 compressed tarball}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjoubeh}(h]h ]h"]h$]h&]j.j/uh1jhhhMhjkubah}(h]h ]h"]h$]h&]uh1jhhhMhjLhhubh)}(hThis is just a selection of available make targets for this purpose, see ``make help`` for others. You can also use these targets after running ``make -j $(nproc --all)``, as they will pick up everything already built.h](hIThis is just a selection of available make targets for this purpose, see }(hjhhhNhNubjZ)}(h ``make help``h]h make help}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh: for others. You can also use these targets after running }(hjhhhNhNubjZ)}(h``make -j $(nproc --all)``h]hmake -j $(nproc --all)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhjubh0, as they will pick up everything already built.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjLhhubh)}(hX/If you employ the targets to generate deb or rpm packages, ignore the step-by-step guide's instructions on installing and removing your kernel; instead install and remove the packages using the package utility for the format (e.g. dpkg and rpm) or a package management utility build on top of them (apt, aptitude, dnf/yum, zypper, ...). Be aware that the packages generated using these two make targets are designed to work on various distributions utilizing those formats, they thus will sometimes behave differently than your distribution's kernel packages.h]hX3If you employ the targets to generate deb or rpm packages, ignore the step-by-step guide’s instructions on installing and removing your kernel; instead install and remove the packages using the package utility for the format (e.g. dpkg and rpm) or a package management utility build on top of them (apt, aptitude, dnf/yum, zypper, ...). Be aware that the packages generated using these two make targets are designed to work on various distributions utilizing those formats, they thus will sometimes behave differently than your distribution’s kernel packages.}(hj" hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjLhhubh)}(h/[:ref:`back to step-by-step guide `]h](h[}(hj0 hhhNhNubh)}(h-:ref:`back to step-by-step guide `h]j)}(hj: h]hback to step-by-step guide}(hj< hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj8 ubah}(h]h ]h"]h$]h&]refdocj refdomainjF reftyperef refexplicitrefwarnj build_sbsuh1hhhhMhj0 ubh]}(hj0 hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjLhhubj)}(h .. _install:h]h}(h]h ]h"]h$]h&]jinstalluh1jhMhjLhhhhubeh}(h]package-your-kernel-upah ]h"]package your kernel upah$]h&]uh1hhjhhhhhMubeh}(h](build-your-kerneljeh ]h"](build your kernelbuildeh$]h&]uh1hhj0 hhhhhMjj7}j{ jsj9}jjsubh)}(hhh](h)}(hInstall your kernelh]hInstall your kernel}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubj)}(h5*Now install your kernel* [:ref:`... `] h]h)}(h4*Now install your kernel* [:ref:`... `]h](j)}(h*Now install your kernel*h]hNow install your kernel}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj ubh [}(hj hhhNhNubh)}(h:ref:`... `h]j)}(hj h]h...}(hj hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnj install_sbsuh1hhhhMhj ubh]}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhhhMhj hhubh)}(hXWhat you need to do after executing the command in the step-by-step guide depends on the existence and the implementation of an ``installkernel`` executable. Many commodity Linux distributions ship such a kernel installer in ``/sbin/`` that does everything needed, hence there is nothing left for you except rebooting. But some distributions contain an installkernel that does only part of the job -- and a few lack it completely and leave all the work to you.h](hWhat you need to do after executing the command in the step-by-step guide depends on the existence and the implementation of an }(hj hhhNhNubjZ)}(h``installkernel``h]h installkernel}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj ubhP executable. Many commodity Linux distributions ship such a kernel installer in }(hj hhhNhNubjZ)}(h ``/sbin/``h]h/sbin/}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj ubh that does everything needed, hence there is nothing left for you except rebooting. But some distributions contain an installkernel that does only part of the job -- and a few lack it completely and leave all the work to you.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hXIf ``installkernel`` is found, the kernel's build system will delegate the actual installation of your kernel's image and related files to this executable. On almost all Linux distributions it will store the image as '/boot/vmlinuz- ' and put a 'System.map-' alongside it. Your kernel will thus be installed in parallel to any existing ones, unless you already have one with exactly the same release name.h](hIf }(hj !hhhNhNubjZ)}(h``installkernel``h]h installkernel}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj !ubhX is found, the kernel’s build system will delegate the actual installation of your kernel’s image and related files to this executable. On almost all Linux distributions it will store the image as ‘/boot/vmlinuz- ’ and put a ‘System.map-’ alongside it. Your kernel will thus be installed in parallel to any existing ones, unless you already have one with exactly the same release name.}(hj !hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hXInstallkernel on many distributions will afterwards generate an 'initramfs' (often also called 'initrd'), which commodity distributions rely on for booting; hence be sure to keep the order of the two make targets used in the step-by-step guide, as things will go sideways if you install your kernel's image before its modules. Often installkernel will then add your kernel to the bootloader configuration, too. You have to take care of one or both of these tasks yourself, if your distributions installkernel doesn't handle them.h]hXInstallkernel on many distributions will afterwards generate an ‘initramfs’ (often also called ‘initrd’), which commodity distributions rely on for booting; hence be sure to keep the order of the two make targets used in the step-by-step guide, as things will go sideways if you install your kernel’s image before its modules. Often installkernel will then add your kernel to the bootloader configuration, too. You have to take care of one or both of these tasks yourself, if your distributions installkernel doesn’t handle them.}(hj-!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hA few distributions like Arch Linux and its derivatives totally lack an installkernel executable. On those just install the modules using the kernel's build system and then install the image and the System.map file manually::h]hA few distributions like Arch Linux and its derivatives totally lack an installkernel executable. On those just install the modules using the kernel’s build system and then install the image and the System.map file manually:}(hj;!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubj4)}(hsudo make modules_install sudo install -m 0600 $(make -s image_name) /boot/vmlinuz-$(make -s kernelrelease) sudo install -m 0600 System.map /boot/System.map-$(make -s kernelrelease)h]hsudo make modules_install sudo install -m 0600 $(make -s image_name) /boot/vmlinuz-$(make -s kernelrelease) sudo install -m 0600 System.map /boot/System.map-$(make -s kernelrelease)}hjI!sbah}(h]h ]h"]h$]h&]hhuh1j3hhhMhj hhubh)}(hIf your distribution boots with the help of an initramfs, now generate one for your kernel using the tools your distribution provides for this process. Afterwards add your kernel to your bootloader configuration and reboot.h]hIf your distribution boots with the help of an initramfs, now generate one for your kernel using the tools your distribution provides for this process. Afterwards add your kernel to your bootloader configuration and reboot.}(hjW!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(h1[:ref:`back to step-by-step guide `]h](h[}(hje!hhhNhNubh)}(h/:ref:`back to step-by-step guide `h]j)}(hjo!h]hback to step-by-step guide}(hjq!hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjm!ubah}(h]h ]h"]h$]h&]refdocj refdomainj{!reftyperef refexplicitrefwarnj install_sbsuh1hhhhMhje!ubh]}(hje!hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubj)}(h .. _another:h]h}(h]h ]h"]h$]h&]janotheruh1jhMhj hhhhubeh}(h](install-your-kerneljl eh ]h"](install your kernelinstalleh$]h&]uh1hhj0 hhhhhMj7}j!jb sj9}jl jb subh)}(hhh](h)}(hAnother round laterh]hAnother round later}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!hhhhhMubj)}(hw*To later build another kernel you need similar, but sometimes slightly different commands* [:ref:`... `] h]h)}(hv*To later build another kernel you need similar, but sometimes slightly different commands* [:ref:`... `]h](j)}(h[*To later build another kernel you need similar, but sometimes slightly different commands*h]hYTo later build another kernel you need similar, but sometimes slightly different commands}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!ubh [}(hj!hhhNhNubh)}(h:ref:`... `h]j)}(hj!h]h...}(hj!hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj!ubah}(h]h ]h"]h$]h&]refdocj refdomainj!reftyperef refexplicitrefwarnj another_sbsuh1hhhhMhj!ubh]}(hj!hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj!ubah}(h]h ]h"]h$]h&]uh1jhhhMhj!hhubh)}(hXThe process to build later kernels is similar, but at some points slightly different. You for example do not want to use 'localmodconfig' for succeeding kernel builds, as you already created a trimmed down configuration you want to use from now on. Hence instead just use ``oldconfig`` or ``olddefconfig`` to adjust your build configurations to the needs of the kernel version you are about to build.h](hXThe process to build later kernels is similar, but at some points slightly different. You for example do not want to use ‘localmodconfig’ for succeeding kernel builds, as you already created a trimmed down configuration you want to use from now on. Hence instead just use }(hj"hhhNhNubjZ)}(h ``oldconfig``h]h oldconfig}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj"ubh or }(hj"hhhNhNubjZ)}(h``olddefconfig``h]h olddefconfig}(hj""hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj"ubh_ to adjust your build configurations to the needs of the kernel version you are about to build.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj!hhubh)}(hXIf you created a shallow-clone with git, remember what the :ref:`section that explained the setup described in more detail `: you need to use a slightly different ``git fetch`` command and when switching to another series need to add an additional remote branch.h](h;If you created a shallow-clone with git, remember what the }(hj:"hhhNhNubh)}(hJ:ref:`section that explained the setup described in more detail `h]j)}(hjD"h]h9section that explained the setup described in more detail}(hjF"hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjB"ubah}(h]h ]h"]h$]h&]refdocj refdomainjP"reftyperef refexplicitrefwarnjsourcesuh1hhhhMhj:"ubh': you need to use a slightly different }(hj:"hhhNhNubjZ)}(h ``git fetch``h]h git fetch}(hjf"hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj:"ubhV command and when switching to another series need to add an additional remote branch.}(hj:"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj!hhubh)}(h1[:ref:`back to step-by-step guide `]h](h[}(hj~"hhhNhNubh)}(h/:ref:`back to step-by-step guide `h]j)}(hj"h]hback to step-by-step guide}(hj"hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&]refdocj refdomainj"reftyperef refexplicitrefwarnj another_sbsuh1hhhhMhj~"ubh]}(hj~"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj!hhubj)}(h.. _uninstall:h]h}(h]h ]h"]h$]h&]j uninstalluh1jhMhj!hhhhubeh}(h](another-round-laterj!eh ]h"](another round lateranothereh$]h&]uh1hhj0 hhhhhMj7}j"j!sj9}j!j!subh)}(hhh](h)}(hUninstall the kernel laterh]hUninstall the kernel later}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"hhhhhMubj)}(h*All parts of your installed kernel are identifiable by its release name and thus easy to remove later.* [:ref:`... `] h]h)}(h*All parts of your installed kernel are identifiable by its release name and thus easy to remove later.* [:ref:`... `]h](j)}(hh*All parts of your installed kernel are identifiable by its release name and thus easy to remove later.*h]hfAll parts of your installed kernel are identifiable by its release name and thus easy to remove later.}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubh [}(hj"hhhNhNubh)}(h:ref:`... `h]j)}(hj"h]h...}(hj"hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj"ubah}(h]h ]h"]h$]h&]refdocj refdomainj"reftyperef refexplicitrefwarnj uninstall_sbsuh1hhhhMhj"ubh]}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj"ubah}(h]h ]h"]h$]h&]uh1jhhhMhj"hhubh)}(hXDo not worry installing your kernel manually and thus bypassing your distribution's packaging system will totally mess up your machine: all parts of your kernel are easy to remove later, as files are stored in two places only and normally identifiable by the kernel's release name.h]hXDo not worry installing your kernel manually and thus bypassing your distribution’s packaging system will totally mess up your machine: all parts of your kernel are easy to remove later, as files are stored in two places only and normally identifiable by the kernel’s release name.}(hj!#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj"hhubh)}(hXOne of the two places is a directory in /lib/modules/, which holds the modules for each installed kernel. This directory is named after the kernel's release name; hence, to remove all modules for one of your kernels, simply remove its modules directory in /lib/modules/.h]hXOne of the two places is a directory in /lib/modules/, which holds the modules for each installed kernel. This directory is named after the kernel’s release name; hence, to remove all modules for one of your kernels, simply remove its modules directory in /lib/modules/.}(hj/#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj"hhubh)}(hXThe other place is /boot/, where typically one to five files will be placed during installation of a kernel. All of them usually contain the release name in their file name, but how many files and their name depends somewhat on your distribution's installkernel executable (:ref:`see above `) and its initramfs generator. On some distributions the ``kernel-install`` command mentioned in the step-by-step guide will remove all of these files for you -- and the entry for your kernel in the bootloader configuration at the same time, too. On others you have to take care of these steps yourself. The following command should interactively remove the two main files of a kernel with the release name '6.0.1-foobar'::h](hXThe other place is /boot/, where typically one to five files will be placed during installation of a kernel. All of them usually contain the release name in their file name, but how many files and their name depends somewhat on your distribution’s installkernel executable (}(hj=#hhhNhNubh)}(h:ref:`see above `h]j)}(hjG#h]h see above}(hjI#hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjE#ubah}(h]h ]h"]h$]h&]refdocj refdomainjS#reftyperef refexplicitrefwarnjinstalluh1hhhhMhj=#ubh9) and its initramfs generator. On some distributions the }(hj=#hhhNhNubjZ)}(h``kernel-install``h]hkernel-install}(hji#hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj=#ubhX_ command mentioned in the step-by-step guide will remove all of these files for you -- and the entry for your kernel in the bootloader configuration at the same time, too. On others you have to take care of these steps yourself. The following command should interactively remove the two main files of a kernel with the release name ‘6.0.1-foobar’:}(hj=#hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj"hhubj4)}(h-rm -i /boot/{System.map,vmlinuz}-6.0.1-foobarh]h-rm -i /boot/{System.map,vmlinuz}-6.0.1-foobar}hj#sbah}(h]h ]h"]h$]h&]hhuh1j3hhhMhj"hhubh)}(hX?Now remove the belonging initramfs, which often will be called something like ``/boot/initramfs-6.0.1-foobar.img`` or ``/boot/initrd.img-6.0.1-foobar``. Afterwards check for other files in /boot/ that have '6.0.1-foobar' in their name and delete them as well. Now remove the kernel from your bootloader's configuration.h](hNNow remove the belonging initramfs, which often will be called something like }(hj#hhhNhNubjZ)}(h$``/boot/initramfs-6.0.1-foobar.img``h]h /boot/initramfs-6.0.1-foobar.img}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj#ubh or }(hj#hhhNhNubjZ)}(h!``/boot/initrd.img-6.0.1-foobar``h]h/boot/initrd.img-6.0.1-foobar}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jYhj#ubh. Afterwards check for other files in /boot/ that have ‘6.0.1-foobar’ in their name and delete them as well. Now remove the kernel from your bootloader’s configuration.}(hj#hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj"hhubh)}(hNote, be very careful with wildcards like '*' when deleting files or directories for kernels manually: you might accidentally remove files of a 6.0.11 kernel when all you want is to remove 6.0 or 6.0.1.h]hNote, be very careful with wildcards like ‘*’ when deleting files or directories for kernels manually: you might accidentally remove files of a 6.0.11 kernel when all you want is to remove 6.0 or 6.0.1.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj"hhubh)}(h3[:ref:`back to step-by-step guide `]h](h[}(hj#hhhNhNubh)}(h1:ref:`back to step-by-step guide `h]j)}(hj#h]hback to step-by-step guide}(hj#hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhj#ubah}(h]h ]h"]h$]h&]refdocj refdomainj#reftyperef refexplicitrefwarnj uninstall_sbsuh1hhhhMhj#ubh]}(hj#hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj"hhubj)}(h.. _faq:h]h}(h]h ]h"]h$]h&]jfaquh1jhMhj"hhhhubeh}(h](uninstall-the-kernel-laterj"eh ]h"](uninstall the kernel later uninstalleh$]h&]uh1hhj0 hhhhhMj7}j$j"sj9}j"j"subeh}(h],reference-section-for-the-step-by-step-guideah ]h"],reference section for the step-by-step guideah$]h&]uh1hhhhhhhhMkubh)}(hhh](h)}(hFAQh]hFAQ}(hj"$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$hhhhhM"ubh)}(hhh](h)}(h-Why does this 'how-to' not work on my system?h]h1Why does this ‘how-to’ not work on my system?}(hj3$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0$hhhhhM%ubh)}(hX{As initially stated, this guide is 'designed to cover everything typically needed [to build a kernel] on mainstream Linux distributions running on commodity PC or server hardware'. The outlined approach despite this should work on many other setups as well. But trying to cover every possible use-case in one guide would defeat its purpose, as without such a focus you would need dozens or hundreds of constructs along the lines of 'in case you are having , you at this point have to do '. Each of which would make the text longer, more complicated, and harder to follow.h]hXAs initially stated, this guide is ‘designed to cover everything typically needed [to build a kernel] on mainstream Linux distributions running on commodity PC or server hardware’. The outlined approach despite this should work on many other setups as well. But trying to cover every possible use-case in one guide would defeat its purpose, as without such a focus you would need dozens or hundreds of constructs along the lines of ‘in case you are having , you at this point have to do ’. Each of which would make the text longer, more complicated, and harder to follow.}(hjA$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM'hj0$hhubh)}(hThat being said: this of course is a balancing act. Hence, if you think an additional use-case is worth describing, suggest it to the maintainers of this document, as :ref:`described above `.h](hThat being said: this of course is a balancing act. Hence, if you think an additional use-case is worth describing, suggest it to the maintainers of this document, as }(hjO$hhhNhNubh)}(h1:ref:`described above `>h]j)}(hjY$h]hdescribed above}(hj[$hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1jhjW$ubah}(h]h ]h"]h$]h&]refdocj refdomainje$reftyperef refexplicitrefwarnjsubmit_improvements_qbtluh1hhhhM1hjO$ubh.}(hjO$hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM1hj0$hhubh)}(hend-of-contenth]hend-of-content}hj$sbah}(h]h ]h"]h$]h&]hhuh1hhj0$hhhhhM7ubh)}(hXThis document is maintained by Thorsten Leemhuis . If you spot a typo or small mistake, feel free to let him know directly and he'll fix it. You are free to do the same in a mostly informal way if you want to contribute changes to the text -- but for copyright reasons please CC linux-doc@vger.kernel.org and 'sign-off' your contribution as Documentation/process/submitting-patches.rst explains in the section 'Sign your work - the Developer's Certificate of Origin'.h]hXThis document is maintained by Thorsten Leemhuis . If you spot a typo or small mistake, feel free to let him know directly and he'll fix it. You are free to do the same in a mostly informal way if you want to contribute changes to the text -- but for copyright reasons please CC linux-doc@vger.kernel.org and 'sign-off' your contribution as Documentation/process/submitting-patches.rst explains in the section 'Sign your work - the Developer's Certificate of Origin'.}hj$sbah}(h]h ]h"]h$]h&]hhuh1hhj0$hhhhhM?ubh)}(hXvThis text is available under GPL-2.0+ or CC-BY-4.0, as stated at the top of the file. If you want to distribute this text under CC-BY-4.0 only, please use 'The Linux kernel development community' for author attribution and link this as source: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/Documentation/admin-guide/quickly-build-trimmed-linux.rsth]hXvThis text is available under GPL-2.0+ or CC-BY-4.0, as stated at the top of the file. If you want to distribute this text under CC-BY-4.0 only, please use 'The Linux kernel development community' for author attribution and link this as source: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/Documentation/admin-guide/quickly-build-trimmed-linux.rst}hj$sbah}(h]h ]h"]h$]h&]hhuh1hhj0$hhhhhMEubh)}(hXNote: Only the content of this RST file as found in the Linux kernel sources is available under CC-BY-4.0, as versions of this text that were processed (for example by the kernel's build system) might contain content taken from files which use a more restrictive license.h]hXNote: Only the content of this RST file as found in the Linux kernel sources is available under CC-BY-4.0, as versions of this text that were processed (for example by the kernel's build system) might contain content taken from files which use a more restrictive license.}hj$sbah}(h]h ]h"]h$]h&]hhuh1hhj0$hhhhhMKubeh}(h]*why-does-this-how-to-not-work-on-my-systemah ]h"]-why does this 'how-to' not work on my system?ah$]h&]uh1hhj$hhhhhM%ubeh}(h](j $id1eh ]h"]faqah$]faqah&]uh1hhhhhhhhM"jKj7}j$j$sj9}j $j$subeh}(h]+how-to-quickly-build-a-trimmed-linux-kernelah ]h"]+how to quickly build a trimmed linux kernelah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj$error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehnj _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}(j]jajE]j;aj]jaj/]j%aj]jaj]jajP]jFaj]jaj]jaj]jaj7 ]j- aj ]j aj ]j aj ]j ajY ]jO aj ]j aj ]j ajZ]jPaj=]j3aj]jaj]jaj]jaj2]j(aj]jaj]jajN]jDaj ]jaj]jaj]jaj]jaj ]jaj]jajl ]jb aj!]j!aj"]j"aj $]j$aunameids}(j$j$jdjaj- j* j4jjjEj jjj/jjjAjjjPjjjjj( jj j7 j j j j j j j$j$j jY j j j j j j jaj j`j]jDjZjCj@jj=jjjjjjjjjjj9jj8j5jj2jjjjjjjUjjTjQjjNjjjj jjjjj~j{jjjjjjjjjjjjjjj'jj&j#jjjj j j j{ jjz jw jIjFjjjr jo j!jl j!j!j"j!j"j"j$j"j$j$j$j $j$j$u nametypes}(j$jdj- j4jj jjjAjjjj( j j j j j$j j j j jaj`jDjCjjjjjjj9j8jjjjjUjTjjjjjj~jjjjjjjj'j&jjj j{ jz jIjjr j!j!j"j"j$j$j$j$uh}(j$hjahj* jgjjjEjFjjj/j0jjjjjPjQjjjjjjj7 j8 j j j j j j j$j0 jY jZ j jZ j j j j j j j]j jZjfj@jfj=jIjjIjjjjjjjjjjj5jj2j>jj>jjjjjjjQjjNjZjjZj jjjjjj{jjjjjjjjjjjjjjjjjj#jjjj j,j j,jjjw jjFjjjjo jLjl j j!j j!j!j"j!j"j"j$j"j $j$j$j$j$j0$u footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}j%KsRparse_messages]hsystem_message)}(hhh]h)}(h&Duplicate implicit target name: "faq".h]h*Duplicate implicit target name: “faq”.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%ubah}(h]h ]h"]h$]h&]j$alevelKtypeINFOsourcehnjlineM"uh1j}%hj$hhhhhM"ubatransform_messages](j~%)}(hhh]h)}(hhh]h0Hyperlink target "backup-sbs" is not referenced.}hj%sbah}(h]h ]h"]h$]h&]uh1hhj%ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineKSuh1j}%ubj~%)}(hhh]h)}(hhh]h4Hyperlink target "secureboot-sbs" is not referenced.}hj%sbah}(h]h ]h"]h$]h&]uh1hhj%ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineKZuh1j}%ubj~%)}(hhh]h)}(hhh]h7Hyperlink target "buildrequires-sbs" is not referenced.}hj%sbah}(h]h ]h"]h$]h&]uh1hhj%ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineKeuh1j}%ubj~%)}(hhh]h)}(hhh]h3Hyperlink target "diskspace-sbs" is not referenced.}hj%sbah}(h]h ]h"]h$]h&]uh1hhj%ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineKouh1j}%ubj~%)}(hhh]h)}(hhh]h1Hyperlink target "sources-sbs" is not referenced.}hj&sbah}(h]h ]h"]h$]h&]uh1hhj&ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineK{uh1j}%ubj~%)}(hhh]h)}(hhh]h2Hyperlink target "patching-sbs" is not referenced.}hj"&sbah}(h]h ]h"]h$]h&]uh1hhj&ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineKuh1j}%ubj~%)}(hhh]h)}(hhh]h1Hyperlink target "tagging-sbs" is not referenced.}hj<&sbah}(h]h ]h"]h$]h&]uh1hhj9&ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineKuh1j}%ubj~%)}(hhh]h)}(hhh]h7Hyperlink target "configuration-sbs" is not referenced.}hjV&sbah}(h]h ]h"]h$]h&]uh1hhjS&ubah}(h]h ]h"]h$]h&]levelKtypej%lineKČsourcehuh1j}%ubj~%)}(hhh]h)}(hhh]h4Hyperlink target "configmods-sbs" is not referenced.}hjp&sbah}(h]h ]h"]h$]h&]uh1hhjm&ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineKuh1j}%ubj~%)}(hhh]h)}(hhh]h/Hyperlink target "build-sbs" is not referenced.}hj&sbah}(h]h ]h"]h$]h&]uh1hhj&ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineKuh1j}%ubj~%)}(hhh]h)}(hhh]h1Hyperlink target "install-sbs" is not referenced.}hj&sbah}(h]h ]h"]h$]h&]uh1hhj&ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h1Hyperlink target "another-sbs" is not referenced.}hj&sbah}(h]h ]h"]h$]h&]uh1hhj&ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h3Hyperlink target "uninstall-sbs" is not referenced.}hj&sbah}(h]h ]h"]h$]h&]uh1hhj&ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMGuh1j}%ubj~%)}(hhh]h)}(hhh]h>Hyperlink target "submit-improvements-qbtl" is not referenced.}hj&sbah}(h]h ]h"]h$]h&]uh1hhj&ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineM^uh1j}%ubj~%)}(hhh]h)}(hhh]h,Hyperlink target "backup" is not referenced.}hj 'sbah}(h]h ]h"]h$]h&]uh1hhj 'ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMpuh1j}%ubj~%)}(hhh]h)}(hhh]h0Hyperlink target "secureboot" is not referenced.}hj&'sbah}(h]h ]h"]h$]h&]uh1hhj#'ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h3Hyperlink target "buildrequires" is not referenced.}hj@'sbah}(h]h ]h"]h$]h&]uh1hhj='ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h/Hyperlink target "diskspace" is not referenced.}hjZ'sbah}(h]h ]h"]h$]h&]uh1hhjW'ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h-Hyperlink target "sources" is not referenced.}hjt'sbah}(h]h ]h"]h$]h&]uh1hhjq'ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h5Hyperlink target "sources-shallow" is not referenced.}hj'sbah}(h]h ]h"]h$]h&]uh1hhj'ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h5Hyperlink target "sources-archive" is not referenced.}hj'sbah}(h]h ]h"]h$]h&]uh1hhj'ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineM&uh1j}%ubj~%)}(hhh]h)}(hhh]h2Hyperlink target "sources-full" is not referenced.}hj'sbah}(h]h ]h"]h$]h&]uh1hhj'ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMEuh1j}%ubj~%)}(hhh]h)}(hhh]h6Hyperlink target "sources-snapshot" is not referenced.}hj'sbah}(h]h ]h"]h$]h&]uh1hhj'ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineM\uh1j}%ubj~%)}(hhh]h)}(hhh]h5Hyperlink target "sources-fresher" is not referenced.}hj'sbah}(h]h ]h"]h$]h&]uh1hhj'ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMouh1j}%ubj~%)}(hhh]h)}(hhh]h.Hyperlink target "patching" is not referenced.}hj(sbah}(h]h ]h"]h$]h&]uh1hhj (ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h-Hyperlink target "tagging" is not referenced.}hj*(sbah}(h]h ]h"]h$]h&]uh1hhj'(ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h3Hyperlink target "configuration" is not referenced.}hjD(sbah}(h]h ]h"]h$]h&]uh1hhjA(ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h0Hyperlink target "configmods" is not referenced.}hj^(sbah}(h]h ]h"]h$]h&]uh1hhj[(ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h=Hyperlink target "configmods-debugsymbols" is not referenced.}hjx(sbah}(h]h ]h"]h$]h&]uh1hhju(ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h8Hyperlink target "configmods-distros" is not referenced.}hj(sbah}(h]h ]h"]h$]h&]uh1hhj(ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineM=uh1j}%ubj~%)}(hhh]h)}(hhh]h;Hyperlink target "configmods-individual" is not referenced.}hj(sbah}(h]h ]h"]h$]h&]uh1hhj(ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMVuh1j}%ubj~%)}(hhh]h)}(hhh]h+Hyperlink target "build" is not referenced.}hj(sbah}(h]h ]h"]h$]h&]uh1hhj(ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMguh1j}%ubj~%)}(hhh]h)}(hhh]h-Hyperlink target "install" is not referenced.}hj(sbah}(h]h ]h"]h$]h&]uh1hhj(ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h-Hyperlink target "another" is not referenced.}hj(sbah}(h]h ]h"]h$]h&]uh1hhj(ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h/Hyperlink target "uninstall" is not referenced.}hj)sbah}(h]h ]h"]h$]h&]uh1hhj)ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ubj~%)}(hhh]h)}(hhh]h)Hyperlink target "faq" is not referenced.}hj.)sbah}(h]h ]h"]h$]h&]uh1hhj+)ubah}(h]h ]h"]h$]h&]levelKtypej%sourcehnjlineMuh1j}%ube transformerN include_log] decorationNhhub.