Linux Certif

Toute la documentation sur la certification Linux LPI

make-kpkg

NOM

make-kpkg - construit des paquets Debian du noyau à partir des sources du noyau Linux

SYNOPSIS

make-kpkg [options] [cible[cible ...]]

DESCRIPTION

This manual page explains the Debian make-kpkg utility, which is used to create the kernel related Debian packages. This utility needs to be run from a top level Linux kernel source directory, which has been previously configured (unless you are using the configure target). Normally, if kernel-package does not find a .config file in the current directory, it tries very hard to get an appropriate one (usually a config file already tailored for Debian kernels for that architecture), and then calls make oldconfig to let the user answer any new questions. Typically, you run this command as root, or under fakeroot, or tell make-kpkg how to become root, like so:

      make-kpkg --rootcmd fakeroot kernel_image

Le paquet Debian sera créé dans le répertoire père des sources du noyau depuis lequel la commande a été lancée.

De plus, sachez que certaines versions de gcc ne fonctionnent pas très bien avec les sources du noyau (gcc 2.95 rencontre des problèmes de compilation du noyau si on n'utilise pas l'option de compilation «-fno-strict-aliasing »). Ce problème a été réglé pour les noyaux récents (les séries 2.2 et 2.4) (je crois que, pour les noyaux plus anciens, vous risquez d'avoir à modifier le makefile). Vous pouvez indiquer la version de gcc à utiliser pour la compilation du noyau en définissant les variables CC et HOSTCC du Makefile (le Makefile du premier niveau). Cela se fait tout simplement grâce à :

  % MAKEFLAGS="CC=gcc-2.95" make-kpkg ...

(Consultez le Makefile de premier niveau afin de connaître les variables qui peuvent être définies).

WARNING: Do NOT set the -j option in MAKEFLAGS directly, this shall cause the build to fail. Use CONCURRENCY_LEVEL as specified below.

OPTIONS

Affiche un message d'aide.

--revision numéro

Changes the Debian revision number for the packages produced to the argument number. This has certain constraints: the --revision option only has an effect during the configure phase. So, if you want to re-run make-kpkg with a different revision number, you have to make sure you start with a clean slate. Secondly, the version may contain only alphanumerics and the characters ~ + . (tilde, full stop and plus) and must contain a digit. (Look at the Policy manual for details). Optionally, you may prepend the revision with a digit followed by a colon (:). The default is 10.00.Custom unless the environment variable DEBIAN_REVISION_MANDATORY is set, in which case an error is generated if the revision is not set on the command line or the configuration file.

--append-to-version toto

--append_to_version toto

Cet argument (toto) est ajouté à la valeur de la variable EXTRAVERSION du Makefile du noyau. Puisqu'EXTRAVERSION est un des composants du numéro de version du noyau, il est aussi ajouté au nom du paquet Debian, et en tant que tel, doit répondre aux contraintes de la charte concernant les noms de paquets. Ce qui veut dire qu'il ne doit contenir que des caractères alphanumériques minuscules et les caractères -, + et . (trait d'union, plus et point). Les lettres majuscules ne sont pas autorisées par la Charte pour un nouveau paquet. Si la variable d'environnement IGNORE_UPPERCASE_VERSION est définie, make-kpkg écrira le numéro de version défini dans le Makefile ou dans le fichier localversion en minuscules. Cet argument a priorité sur la variable d'environnement APPEND_TO_VERSION. Notez bien que vous devez lancer make-kpkg clean après avoir configuré le noyau avec make (x|menu)?config, puisque celui-ci génère le fichier include/linux/version.h sans la valeur append_to_version (toto). Ce fichier ne sera pas modifié par le lancement de make-kpkg (make-kpkg crée version.h s'il n'existe pas, mais ne le modifie pas s'il existe), et donc le noyau final n'aura pas la valeur append_to_version dans son numéro de version, et ira chercher les modules et les symboles aux mauvais endroits. Le plus simple est soit de supprimer include/linux/version.h après la configuration et avant la compilation, soit de lancer make-kpkg clean après la configuration, et avant la compilation. Notez aussi qu'une fois que vous avez utilisé --append_to_version toto pour la configuration ou la construction du kernel-image, vous devez aussi utiliser la même option lors de lancements ultérieurs de make-kpkg (par exemple, pour construire des modules indépendants, ou autres). make-kpkg ne se souvient pas de l'argument toto à chacun des lancements de la commande (ce comportement est différent de --revision, qui est lui persistant lors des différents lancements). Si vous en avez assez de voir make-kpkg se plaindre de l'utilisation de --append_to_version alors qu'il y a déjà un fichier créé précédemment , vous pouvez définir la variable d'environnement VERSION_H_OK ce qui fera cesser cet avertissement.

--added-modules toto

--added_modules toto

Cet argument se présente sous la forme d'une liste de modules additionnels séparés par des virgules (modules non inclus dans l'arborescence principale du noyau) que vous souhaitez construire lorsque vous invoquez les cibles modules_truc. Vous devez indiquer le chemin complet des répertoires contenant les modules, ou simplement le nom du module s'il peut être trouvé dans MODULE_LOC, qui pointe par défaut sur /usr/src/modules. Le comportement par défaut compile tous les modules qui sont dans MODULE_LOC, quand les cibles modules_truc sont demandées.

--arch truc

Pratique pour définir l'architecture quand vous utilisez la compilation croisée. Si vous ne faites pas de compilation croisée, l'architecture est automatiquement déterminée. On peut obtenir le même résultat en réglant la variable d'environnement KPKG_ARCH. Cette valeur doit correspondre au contenu de DEB_HOST_ARCH_CPU lorsque dpkg-architecture est exécuté sur la machine cible, et elle peut correspondre à une autre architecture dans le cas d'un ensemble multiarchitecture (comme i386/amd64).

--cross-compile truc

--cross_compile truc

This is useful for setting the target string when you are cross compiling. Use the dummy target "-" if you are building for other arches of a multiarch set, like i386/amd64. The same effect can be achieved by setting the environment variable. Please note that this does not in any way set the compiler the kernel build process shall use; if the default compiler that the build process comes up with is not the one desired, please explicitly specify the compiler that should be used. CROSS_COMPILE

--subarch truc

Certaines architectures (comme Alpha, ou m68k) ont besoin de noyaux différents pour chacune des sous-architectures. Cette option offre un moyen de le spécifier en tant qu'argument de make-kpkg. Notez bien qu'une gestion de ces sous-architectures doit être présente dans les sources du noyaux afin que cette option serve à quelque chose. On peut obtenir le même résultat en réglant la variable d'environnement KPKG_SUBARCH

--arch-in-name

--arch_in_name

Cette option rallonge le nom du paquet de l'image du noyau en intégrant la sous-architecture dans le nom de l'image ; ainsi on peut écrire des scripts pour créer de multiples sous-architectures, l'une après l'autre. On peut faire la même chose en réglant la variable d'environnement ARCH_IN_NAME. Notez bien que seul le nom du paquet est changé, pas l'emplacement des modules, etc.

--pgpsign nom

Définit la chaîne utilisée pour signer le fichier des modifications (changes) pour les modules externes rangés dans /usr/src/modules/ et qui utilisent PGP. Cette option prendra le pas sur le comportement par défaut et sur les préférences générales qui se trouvent dans le fichier /etc/kernel-pkg.conf ou ~/.kernel-pkg.conf.

--config cible

Modifie le type de configuration utilisée, par défaut oldconfig. Cible doit prendre une des valeurs suivantes oldconfig, config, menuconfig, gconfig, xconfig, randconfig,, defconfig, allmodconfig, allyesconfig, allnoconfig; old, menu, g, ou x.

Note however that make-kpkg scans the config file at start up for some options, notably the fact that modules are enabled or not, so toggling the status during the delayed configuration results in an error. If needed, create the configuration file as close to the desired one before calling make-kpkg with this switch.

--targets

Affiche la liste des cibles connues. Voir la section Cibles plus loin.

--noexec

Passe l'option -n au processus make afin que les commandes soient simplement affichées à l'écran mais pas réellement exécutées. C'est très pratique pour le débogage.

--verbose

Appelle make avec l'option -V=1, ce qui appelle les commandes Make du niveau supérieur, pratique pour voir ce qui est en train de se passer.

--initrd

If make-kpkg is generating a kernel-image package, arrange to convey to the hook scripts run from the post installation maintainer scripts that this image requires an initrd, and that the initrd generation hook scripts should not short circuit early. Without this option, the example initramfs hook scripts bundled in with kernel-package will take no action on installation. The same effect can be achieved by setting the environment variable INITRD to any non empty value. Please note that unless there are hook scripts in /etc/kenel or added into the hook script parameter of /etc/kernel-img.conf. no initrd will be created (the bundled in example scripts are just examples -- user action is required before anything happens).

--overlay-dir /path/to/directory

The specified directory should contain files that will be placed in the ./debian directory of the kernel sources, in preparation to building the debian packages. The files will replace anything in /usr/share/kernel-package that would normally be placed there, and it is up to the user to make sure that the files in the overlay directory are compatible with make-kpkg. If you break make-kpkg with an overlay file, you get to keep the pieces. The same effect can be achieved by setting the environment variable KPKG_OVERLAY_DIR.

Please note that overlay-dir/Control and overlay-dir/changelog are special, and variable substitution is performed on these files. Use /usr/share/kernel-package/Control and /usr/share/kernel-package/changelog files as templates.

If a overlay-dir/post-install executable (or executable script) exists, it shall be run immediately after ./debian is populated. The script shall be executed in the ./debian directory. This can be used, For instance, to delete files the user does not want, or to take actions other than simple replacement.

--zimage

Génère un noyau en zImage plutôt qu'en bzImage (comportement par défaut). C'est utile pour ceux qui ont des problèmes avec les noyaux bzImage.

--bzimage

Génère un noyau en bzImage. C'est utile pour ceux qui veulent un noyau bzImage sur les systèmes où le réglage par défaut est zImage.

--rootcmd commande

The command that provides a means of gaining super user access (for example, `sudo' or `fakeroot') as needed by dpkg-buildpackage's -r option. This option does not work for three of the targets, namely, binary, binary-indep, and binary-arch. For those targets the entire make-kpkg command must be run as (fake)root.

--stem truc

Call the packages foo-* instead of kernel-*. This is useful in helping transition from calling the packages kernel-* to linux-* packages, in preparation for non-linux kernels in the distribution. The default is linux. The stem, since it is the initial part of a package name must consist only of lower case letters (`a-z'), digits (`0-9'), plus (`+') and minus (`-') signs, and periods (`.'). It must be at least two characters long and must start with an alphanumeric character.

--us

Cette option est transmise à dpkg-buildpackage et demande de ne pas signer la source. Elle n'a de sens que pour la cible buildpackage.

--uc

Cette option est transmise à dpkg-buildpackage, et demande de ne pas signer le changelog. Elle n'a de sens que pour la cible buildpackage.

Les options peuvent être raccourcies en la plus petite chaîne de caractères non équivoque et peuvent être invoquées indifféremment avec les préfixes - ou -- ; Vous pouvez mettre un espace ou un symbole = entre une option et sa valeur. Vous pouvez aussi utiliser la forme option=valeur ; Pour plus d'informations sur ces variantes et d'autres qui sont reconnues, consultez la page de manuel Getopt::Long (3perl).

CONCURRENCY_LEVEL

Si elle est définie, cette variable d'environnement régle le niveau de profondeur (NdT : concurrency) utilisé par make pour compiler le noyau et l'ensemble des modules. Elle utilise le drapeau -j dans le make qui est dans la cible build de make-kpkg. Elle doit être un (petit) entier, si vous la définissez. Vous pouvez obtenir le nombre actuel de CPU grâce à la commande :
 "grep -c '^processor' /proc/cpuinfo" ATTENTION : NE définissez PAS l'option dans MAKEFLAGS directement, cela entraînerait l'échec de la construction.

CIBLES

clean

Efface tous les fichiers créés dans le répertoire des sources du noyau par la cible build, et lance un make distclean. (Consultez le Makefile du noyau Linux pour plus d'informations). Notez que malgré l'attention que nous portons aux réglages du noyau courant contenus dans le fichier .config, le fichier include/linux/autoconf.h ne sera pas gardé. Cette cible ne doit pas être combinée avec une autre, puisque make-kpkg lit toutes les données avant de lancer une quelconque cible, donc les autres cibles seront exécutées avec les anciennes données, ce qui n'est sûrement pas ce que vous désirez.

buildpackage

Cette cible lance les cibles clean, et binary, et génère le paquet complet grâce à dpkg-buildpackage

binary

This target produces all four Debian kernel packages by running the targets binary-indep and binary-arch. However, this requires make-kpkg to be run as root (or fakeroot), since --rootcmd will not work.

binary-indep

This target produces the arch independent packages by running the targets kernel_source, kernel_manual and kernel_doc. However, this also requires make-kpkg to be run as root (or fakeroot), since --rootcmd will not work.

binary-arch

This target produces the arch dependent packages by running the targets kernel_headers and However, this also requires make-kpkg to be run as root (or fakeroot), since --rootcmd will not work. kernel_image.

kernel_source

Cette cible génère un paquet Debian des sources du noyau Linux. Si la variable d'environnement SOURCE_CLEAN_HOOK pointe sur un exécutable, alors cet exécutable sera lancé, juste avant de faire le paquet, sur le répertoire (racine) temporaire des sources du noyau, ./debian/tmp-source/usr/src/kernel-source-X.X.XX, de façon à ce qu'on puisse lancer toute commande appropriée (supprimer des arborescences liées à des architectures, ôter les répertoires de contrôle de version, find . -type d -name CVS -prune -exec rm -rf {} \; etc). Cela ne concerne que les sources du noyau qui sont en cours d'empaquetage. Si cette action porte sur le répertoire courant et ses répertoires fils, l'arborescence originale qui contient les sources reste, elle, inchangée. Les variables d'environnement HEADER_CLEAN_HOOK et DOC_CLEAN_HOOK sont semblables. Elles doivent pointer sur des exécutables ; ces exécutables seront appliqués sur le répertoire (racine) temporaire des en-têtes du noyau et de la documentation juste avant la génération des paquets respectifs, de façon à ce que vous puissiez lancer toute action qui vous semble adéquate. De même, ne sont touchées que les sources qui sont en cours d'empaquetage.

kernel_debug

This target produces a Debian package containing the debugging symbols for the modules contained in the corresponding image package. The basic idea here is to keep the space in /lib/modules/<kver> under control, since this could be on a root partition with space restrictions.

kernel_headers

Cette cible génère le paquet Debian des fichiers d'en-têtes contenus dans le noyau Linux.

kernel_manual

Cette cible génère le paquet Debian contenant les pages de manuel de la section 9 fournies dans le noyau Linux. Notez bien que ce n'est pas vraiment une cible indépendante, puisque son appel déclenchera l'appel de la cible kernel_doc, et créera un paquet kernel-doc en même temps.

kernel_doc

Cette cible génère un paquet Debian contenant la documentation contenue dans le noyau Linux. Elle peut être appelée indépendamment de la cible kernel_manual, mais l'inverse n'est pas possible.

kernel_image

Cette cible génère un paquet Debian contenant un noyau Linux, et tous les modules définis dans le fichier de configuration du noyau .config. S'il n'y a pas de fichier .config dans les répertoires des sources du noyau, une configuration par défaut est utilisée, identique à celle utilisée pour créer les disquettes de démarrage Debian.

Si le fichier ./debian/post-install existe, et qu'il s'agit d'un exécutable, il est lancé juste avant la création du paquet de l'image du noyau. De même, notez que si des scripts existent dans le répertoire ./debian/image.d/ , run-parts sera lancé sur ce répertoire juste avant la création du paquet de l'image du noyau. L'emplacement de la racine de l'image pour le paquet en cours de construction peut être défini par la variable d'environnement IMAGE_TOP, et la version du noyau est définie grâce à la variable d'environnement version pour tous ces scripts.

Consultez la documentation à propos des variables de type « hook » (points d'entrée) dans kernel-img.conf(5). Ces variables peuvent indiquer des scripts qui ajoutent ou suppriment une ligne dans le menu du grub à l'installation ou à la suppression de l'image du noyau. Un exemple de script pour ajouter des lignes au menu du grub est fourni dans le répertoire /usr/share/doc/kernel-package/.

En dehors de ces variables de type « hook » que l'administrateur peut définir, il existe un ensemble de répertoires dans lesquels des paquets, ou l'administrateur, peuvent déposer des scripts. Ces répertoires sont /etc/kernel/preinst.d/, /etc/kernel/postinst.d/, /etc/kernel/prerm.d/, /etc/kernel/postrm.d/, et /etc/kernel/preinst.d/<VERSION>/, /etc/kernel/postinst.d/<VERSION>/, /etc/kernel/prerm.d/<VERSION>/, /etc/kernel/postrm.d/<VERSION>/. Si ces répertoires existent, le paquet kernel-image lancera le programme run-parts sur ceux-ci, en passant en argument la version en cours d'installation ou de suppression, durant la phase correspondante (installation ou suppression). Avant d'appeler ces scripts, la variable d'environnement STEM peut être réglée avec le contenu de l'argument --stem (ou à sa valeur par défaut, linux). Ces scripts peuvent être appelés avec deux arguments, le premier étant la version de l'image du noyau, et le second étant l'endroit où est rangé l'image proprement dite. Puisque debconf est lancé avant que le script ne soit appelé, ce dernier ne devra pas générer de message de diagnostic sur la sortie standard -- En effet, au moment où la post-installation appelle db_stop, debconf ne rétablit pas la sortie standard, tous les messages en sa direction disparaissent.

À l'installation, vous aurez la possibilité de lancer le chargeur de démarrage LILO (ou des équivalents tels que loadlin, SILO, QUIK, VMELILO, ZIPL, yaboot, PALO ou GRUB ), en créant un fichier de configuration pour ces programmes de démarrage, si nécessaire. À ce moment, vous aurez aussi la possibilité de mettre ce nouveau noyau sur une disquette, en formatant la disquette si nécessaire. En cas de suppression, le paquet vérifie la version du noyau en cours d'exécution, et refuse alors d'effacer le noyau en cours d'utilisation. Grub mérite une mention particulière ici, puisque grub n'a pas besoin d'être relancé après l'installation d'une image de noyau, et qu'une modification automatisée du contenu du menu est suffisante pour l'installation ou la suppression d'une image d'un noyau.

build

Cette cible, utilisée par la cible kernel_image ci-dessus, compile le noyau Linux.

modules

Cette cible vous permet de générer tous les modules et paquets additionnels qui dépendent fortement de la version du noyau pour laquelle ils ont été compilés, en même temps que vous construisez votre image du noyau. Cette cible s'attend à trouver les modules et paquets sous /usr/src/modules, et, pour chacun de ces répertoires, se déplacera dans MODULE_LOC/x (MODULE_LOC étant par défaut /usr/src/modules ), et lancera la règle kdist du fichier debian.rules qui s'y trouve. Cette cible créera le(s) paquet(s) Debian de(s) module(s), ainsi qu'un fichier tar compressé et un fichier diff compressé, les md5sums correspondants, générés par dpkg-genchanges, seront enregistrés dans un fichier des modifications (changes). Ce fichier sera signé avec la même identité que celle utilisée pour signer le paquet du noyau. Cette option est utilisée par les responsables qui déploient les paquets dans les archives de Debian.

modules_config

Cette cible permet de configurer tous les paquets de MODULE_LOC qui pointent par défaut sur /usr/src/modules. À utiliser si vous avez besoin de modifier manuellement certains points de la configuration, ou si vous voulez compiler manuellement tous les modules additionnels. À n'utiliser que si vous disposez déjà d'un répertoire ./debian.

modules_image

Cette cible vous permet de construire tous les paquets de MODULE_LOC qui pointent par défaut sur /usr/src/modules, mais elle ne crée pas les fichiers sources ou diffs, ni ne crée ni ne signe un fichier des modifications (un fichier « changes »). C'est la seule option liée aux modules dont vous aurez besoin si vous voulez juste compiler les modules additionnels pour leur installation sur une ou plusieurs machines. Utilisée en général en conjonction avec kernel_image, notamment si vous invoquez aussi l'option append_to_version (afin d'éviter de faux messages d'avertissement). À n'utiliser que si vous disposez déjà d'un répertoire ./debian.

modules_clean

Cette cible vous permet de nettoyer tous les paquets de MODULE_LOC qui pointent par défaut sur /usr/src/modules, ce qui devrait être suffisant pour défaire tout ce qu'ont pu faire toutes les autres cibles modules_truc. À n'utiliser que si vous disposez déjà d'un répertoire ./debian.

configure

Cette cible lance configure (en fait config_target, défini par --config qui pointe par défaut sur oldconfig ) assez tôt, de sorte que vous puissiez éditer les fichiers créés par make config dans le répertoire des sources du noyau, sans que make-kpkg ne les écrase ensuite.

debian

This target creates the ./debian directory, and optionally patches the source. This target is called by the configure target. You may use this target to have the sources patched, and then manually run the configuration step to update the configuration file, with any new configuration options the patches may have introduced.

libc-kheaders

C'est une cible spéciale pour les responsables de libc-dev, qui peuvent s'en servir pour créer les paquets d'en-têtes dont la libc a besoin. Notez qu'il est dangereux de créer un paquet de libc-kheaders d'en-têtes différentes de celles avec lesquelles la libc a été compilée. C'est une cause connue d'arrêts brutaux du système. Consultez /usr/share/kernel-package/README.headers pour plus d'informations. Créer et installer votre propre paquet libc-kheaders peut endommager votre système, à moins que vous ne soyez sûr de ce vous faites. Vous êtes prévenus.

VARIABLES D'ENVIRONNEMENT

KPKG_DEBUG, if set, causes make-kpkg to spit out debugging messages about some shell functions executed internally. This is probably of not interest to anyone not debugging make-kpkg. The following variables (documented above) also affect make-kpkg: DEBIAN_REVISION_MANDATORY APPEND_TO_VERSION VERSION_H_OK KPKG_ARCH CROSS_COMPILE KPKG_SUBARCH KPKG_OVERLAY_DIR ARCH_IN_NAME INITRD SOURCE_CLEAN_HOOK MODULE_LOC CONCURRENCY_LEVEL IGNORE_UPPERCASE_VERSION

FICHIERS

Outre les options de lancement, le fichier debian.rules lancé par make-kpkg recherche également un fichier de configuration propre à l'utilisateur ~/.kernel-pkg.conf. En cas d'absence de ce fichier, il recherche un réglage par défaut pour tout le système dans le fichier /etc/kernel-pkg.conf. La configuration par défaut permet le remplacement pour tout le système du nom complet et du courriel de la personne responsable de la maintenance des paquets du noyau sur le site, mais les fichiers /etc/kernel-pkg.conf (ou ~/.kernel-pkg.conf) sont en fait des bribes de Makefile, et toute directive valide peut y être incluse. Note: La prudence est de mise avec ce fichier, puisque vous pouvez changer complètement le comportement du make en modifiant son contenu. Consultez le fichier /usr/share/doc/kernel-package/Problems.gz pour connaître la liste des problèmes recensés lors de la compilation des images du noyau. Un tutoriel exhaustif et une documentation sont aussi disponibles dans /usr/share/doc/kernel-package/README.gz et leurs lectures sont recommandées avant l'utilisation de cet utilitaire.

VOIR AUSSI

kernel-pkg.conf(5), kernel-img.conf(5), Getopt::Long(3perl), dpkg-deb(1), dpkg-source(1), make(1), The Programmers manual, The GNU Make manual, and the extensive documentation in the directory /usr/share/doc/kernel-package

AUTEUR

Cette page a été écrite par Manoj Srivastava, <srivasta@debian.org>, pour le système Debian GNU/Linux.