Difference between revisions of "Kernels/Arch Build System"

From ArchWiki
Jump to: navigation, search
m (added ja)
(26 intermediate revisions by 12 users not shown)
Line 1: Line 1:
[[Category:Kernel (English)]]
+
[[Category:Kernel]]
{{i18n|Kernel Compilation/Arch Build System}}
+
[[de:Eigenen Kernel erstellen]]
 +
[[it:Kernels/Compilation/Arch Build System]]
 +
[[ja:Kernels/Compilation/Arch Build System]]
 +
[[ru:Custom Kernel Compilation with ABS]]
 +
[[zh-CN:Kernels/Compilation/Arch Build System]]
 
The [[Arch Build System]] can be used to build a custom kernel based on the official {{Pkg|linux}} package. This compilation method can automate the entire process, and is based on a very well tested package. You can edit the PKGBUILD to use a custom kernel configuration or add additional patches.
 
The [[Arch Build System]] can be used to build a custom kernel based on the official {{Pkg|linux}} package. This compilation method can automate the entire process, and is based on a very well tested package. You can edit the PKGBUILD to use a custom kernel configuration or add additional patches.
  
==Install ABS==
+
==Getting the Ingredients==
  
 
{{bc|# pacman -S abs base-devel}}
 
{{bc|# pacman -S abs base-devel}}
  
To get the whole tree run:
+
First of all, you need a clean kernel to start your customization from. Fetch the kernel package files from ABS:
  
{{bc|# abs}}
+
{{bc|1=$ ABSROOT=. abs core/linux}}
  
See [[Arch Build System]] for more information.
+
If you have some problem with the firewall blocking the rsync port, you can try with -t, which uses the tarball to sync.
  
==Getting the Ingredients==
+
{{bc|1=$ ABSROOT=. abs core/linux -t}}
First of all, you need a clean kernel to start your customization from. In this article I will assume that you use the official kernel package. So create a folder you want to work in and get the kernel package files from ABS (after syncing):
+
 
+
{{ic|cp /var/abs/core/linux/* <working_dir>/}}
+
  
 
Then, get any other file you need (e.g. custom configuration files, patches, etc.) from the respective sources.
 
Then, get any other file you need (e.g. custom configuration files, patches, etc.) from the respective sources.
  
 
==Modifying the PKGBUILD==
 
==Modifying the PKGBUILD==
Modify the PKGBUILD of the official linux package.
+
Modify {{ic|pkgbase}} for your custom package name, e.g.:
 +
  pkgbase=linux-custom
  
===Changing pkgname===
+
If you dont want to build -headers or -docs package, remove them from {{ic|pkgname}} at the bottom of the file, e.g.:
The first lines will look like this:
+
  pkgname=("${pkgbase}")
{{hc|PKGBUILD|2=
+
# $Id: PKGBUILD 130991 2011-07-09 12:23:51Z thomas $
+
# Maintainer: Tobias Powalowski <tpowa@archlinux.org>
+
# Maintainer: Thomas Baechler <thomas@archlinux.org>
+
  
pkgbase=linux
+
===Changing build()===
pkgname=('linux' 'linux-headers' 'linux-docs') # Build stock -ARCH kernel
+
If you need to change a few config options you can use the default one and append your options the config file:
# pkgname=linux-custom      # Build kernel with a different name
+
$ echo '
_kernelname=${pkgname#linux}
+
CONFIG_DEBUG_INFO=y
...
+
CONFIG_FOO=n
}}
+
' >> config.x86_64
  
As you see, there is a commented line for building a kernel with a different name. All you need to do here is to uncomment that line, change the suffix '-custom' to your needs, and comment the standard line. And if you want two kernels (ARCH and test) you need disable section conflicts. Files linux.install and linux.preset must be linux-custom.install and linux-custom.preset. For instance, your file could become:
+
Or you can use GUI tool to tweak the options. Uncomment one of the possibilities shown in the build() function of the PKGBUILD, e.g.:
{{hc|PKGBUILD|2=
+
...
+
#pkgname=('linux' 'linux-headers' 'linux-docs') # Build stock -ARCH kernel
+
pkgname=linux-test      # Build kernel with a different name
+
...
+
#provides=('kernel26')
+
#conflicts=('kernel26')
+
#replaces=('kernel26')
+
}}
+
 
+
{{Note|This assumes that you do not need to recompile linux-headers, -manpages or -docs. If you do, change all three strings accordingly.}}
+
 
+
Now, all the variables of your package will be changed according to the new name. For instance, after installing the package the modules will be located at {{ic|/lib/modules/<kernel_release>-test/}}.
+
 
+
===Changing build()===
+
You probably need a custom .config file for your kernel. You can uncomment one of the possibilities shown in the build() function of the PKGBUILD, e.g.:
+
 
{{hc|PKGBUILD|
 
{{hc|PKGBUILD|
 
...
 
...
Line 65: Line 47:
 
...
 
...
 
}}
 
}}
 +
  
 
If you have already a kernel config file, I suggest to uncomment one interactive config tool, such as nconfig, and load your config from there. This avoids problems with kernel naming I have met with other methods.
 
If you have already a kernel config file, I suggest to uncomment one interactive config tool, such as nconfig, and load your config from there. This avoids problems with kernel naming I have met with other methods.
  
 
{{Note|If you uncomment ''return 1'', you can change to the kernel source directory after makepkg finishes extraction and then make nconfig. This lets you configure the kernel over multiple sessions. When you're ready to compile, copy the .config file over top of either config or config.x86_64 (depending on your architecture), comment ''return 1'' and use '''makepkg -i'''. But not use this for custom patch, put you patch commands after these lines. If you do patch manually bztar unpack and replace your patch.}}
 
{{Note|If you uncomment ''return 1'', you can change to the kernel source directory after makepkg finishes extraction and then make nconfig. This lets you configure the kernel over multiple sessions. When you're ready to compile, copy the .config file over top of either config or config.x86_64 (depending on your architecture), comment ''return 1'' and use '''makepkg -i'''. But not use this for custom patch, put you patch commands after these lines. If you do patch manually bztar unpack and replace your patch.}}
 
===Changing the package_linux() function===
 
Now, you have to write a custom function to tell your system how to install the package. This is most easily done by changing the name of the package_linux() function to package_linux-test(), and adapting the instructions to your needs. If you have no particular needs, your package_linux-test() should look like this:
 
{{hc|PKGBUILD|2=
 
...
 
package_linux-test() {
 
pkgdesc="The Linux Kernel and modules"
 
...
 
}
 
}}
 
  
 
==Compiling==
 
==Compiling==
Line 85: Line 58:
 
You can now proceed to compile you kernel by the usual command
 
You can now proceed to compile you kernel by the usual command
 
{{ic|makepkg}}
 
{{ic|makepkg}}
If you have chosen an inteactive program for configuring the kernel parameters (like menuconfig), you need to be there during the compilation.
+
If you have chosen an interactive program for configuring the kernel parameters (like menuconfig), you need to be there during the compilation.
  
 
{{Note|A kernel needs some time to be compiled. 1h is not unusual.}}
 
{{Note|A kernel needs some time to be compiled. 1h is not unusual.}}
Line 94: Line 67:
  
 
==Boot Loader==
 
==Boot Loader==
Now, the folders and files for your custom kernel have been created, e.g. {{ic|/boot/vmlinuz-linux-test}}. To test your kernel, update your bootloader (/boot/grub/menu.lst for GRUB) and add new entries ('default' and 'fallback') for your custom kernel. That way, you can have both the stock kernel and the custom one in parallel.
+
Now, the folders and files for your custom kernel have been created, e.g. {{ic|/boot/vmlinuz-linux-test}}. To test your kernel, update your bootloader (/boot/grub/menu.lst for GRUB) and add new entries ('default' and 'fallback') for your custom kernel. That way, you can have both the stock kernel and the custom one to choose from.

Revision as of 15:50, 22 June 2013

The Arch Build System can be used to build a custom kernel based on the official linux package. This compilation method can automate the entire process, and is based on a very well tested package. You can edit the PKGBUILD to use a custom kernel configuration or add additional patches.

Getting the Ingredients

# pacman -S abs base-devel

First of all, you need a clean kernel to start your customization from. Fetch the kernel package files from ABS:

$ ABSROOT=. abs core/linux

If you have some problem with the firewall blocking the rsync port, you can try with -t, which uses the tarball to sync.

$ ABSROOT=. abs core/linux -t

Then, get any other file you need (e.g. custom configuration files, patches, etc.) from the respective sources.

Modifying the PKGBUILD

Modify pkgbase for your custom package name, e.g.:

 pkgbase=linux-custom

If you dont want to build -headers or -docs package, remove them from pkgname at the bottom of the file, e.g.:

 pkgname=("${pkgbase}")

Changing build()

If you need to change a few config options you can use the default one and append your options the config file:

$ echo '
CONFIG_DEBUG_INFO=y
CONFIG_FOO=n
' >> config.x86_64

Or you can use GUI tool to tweak the options. Uncomment one of the possibilities shown in the build() function of the PKGBUILD, e.g.:

PKGBUILD
...
  # load configuration
  # Configure the kernel. Replace the line below with one of your choice.
  #make menuconfig # CLI menu for configuration
  make nconfig # new CLI menu for configuration
  #make xconfig # X-based configuration
  #make oldconfig # using old config from previous kernel version
  # ... or manually edit .config
...


If you have already a kernel config file, I suggest to uncomment one interactive config tool, such as nconfig, and load your config from there. This avoids problems with kernel naming I have met with other methods.

Note: If you uncomment return 1, you can change to the kernel source directory after makepkg finishes extraction and then make nconfig. This lets you configure the kernel over multiple sessions. When you're ready to compile, copy the .config file over top of either config or config.x86_64 (depending on your architecture), comment return 1 and use makepkg -i. But not use this for custom patch, put you patch commands after these lines. If you do patch manually bztar unpack and replace your patch.

Compiling

Tip: Running compilation jobs simultaneously can reduce compilation time significantly on multi-core systems.

You can now proceed to compile you kernel by the usual command makepkg If you have chosen an interactive program for configuring the kernel parameters (like menuconfig), you need to be there during the compilation.

Note: A kernel needs some time to be compiled. 1h is not unusual.

Installing

After the makepkg, you can have a look at the linux.install file. You will see that some variables have changed. Now, you only have to install the package as usual with pacman (or equivalent program):

# pacman -U <kernel_package>

Boot Loader

Now, the folders and files for your custom kernel have been created, e.g. /boot/vmlinuz-linux-test. To test your kernel, update your bootloader (/boot/grub/menu.lst for GRUB) and add new entries ('default' and 'fallback') for your custom kernel. That way, you can have both the stock kernel and the custom one to choose from.