Table of Contents
Wok & Outils
Vue d'ensemble
Tazwok est utilisé pour compiler et générer des paquets (cook pour cuire) via les instructions trouvées dans les recettes. Il place les dossiers compilés dans un répertoire et fait appel à Tazpkg pour empaqueter le répertoire. La recette provenant d'un wok a une « moitié inférieure » différente de celle d'un Tazpkg ; Tazwok a des règles pour la compilation et l'empaquetage (qu'il redirige à Tazpkg), tandis que Tazpkg est seulement concerné par l'empaquetage.
Tazwok est l'un des nombreux petits utilitaires que le projet SliTaz utilise pour reconstruire automatiquement la distribution à partir des sources. Le projet propose également une archive d'outils contenant divers petits utilitaires, des exemples et des fichiers de configuration. Le générateur de distribution Tazlito est conçu pour les utilisateurs et les développeurs ; il peut récupérer et reconstruire une image ISO du LiveCD et générer une saveur de distribution à partir d'une liste des paquets, un fichier de configuration et une description. Les utilitaires sont tous distribués sous forme d'archive source et sont installés par défaut sur SliTaz.
Wok Structure et Organisation
Le wok est une structure de répertoires qui comporte tous les paquets disponibles. Chaque répertoire contient au moins une recette à télécharger, décompresser, compiler et générer un paquet. Tazwok doit également créer un répertoire pour stocker les sources téléchargés ($SOURCES_REPOSITORY, usuellement /home/slitaz/src) et un dépôt des paquets produits ($PACKAGES_REPOSITORY, usuellement /home/slitaz/packages); ces valeurs peuvent être configurées dans le fichier /etc/tazwok.conf.
Il y a plus d'un Wok sur Mercurial repositories:
- wok-undigest: contributions en attente de test / correction de bogues pour inclusion dans le Wok instable
- wok: paquets pour instable, version Cooking
- wok-stable: paquets pour la version stable de SliTaz
Au départ, toutes les contributions sont commises dans le dépôt undigest. Lorsque le paquet a passé des essais satisfaisants en ce qui concerne la génération automatique, il peut être déplacé dans le wok.
Préparation
Le coin du développeur fournit des informations précieuses. Assurez-vous svp de l'avoir lu et compris avant de continuer.
Pour commencer à utiliser le Wok, il faut que Tazwok soit installé sur votre système et que les principaux outils de développement le soient aussi (binutils, compilateur, librairies-dev, make). Sur Slitaz il suffit d'installer le meta-paquet slitaz-toolchain :
# tazpkg recharge # tazpkg get-install slitaz-toolchain
Pour accéder aux dépôts SliTaz, vous devrez installer le paquet mercurial:
# tazpkg get-install mercurial
Plus d'informations sur l'utilisation de Mercurial VCS est disponible à partir de son site Web ou du livre Hg Book(anglais).
Cloner le Wok
Si vous devez produire un paquet pour inclusion dans les dépôts de SliTaz, il est nécessaire d'obtenir d'abord le wok actuel en utilisant Mercurial. C'est ce qu'on appelle cloner le Wok, une procédure qui télécharge le Wok entier et tout son historique dans un répertoire de travail. Si vous souhaitez seulement utiliser Tazwok pour construire des paquets pour un usage personnel, ce n'est pas nécessaire . Voir plutôt la section Wok personnel ci-dessous.
La destination habituelle pour un clone du Wok est /home/slitaz/wok:
$ hg clone http://hg.slitaz.org/wok/ /home/slitaz/wok
Ce téléchargement peut prendre un certain temps, vous obtiendrez la structure complète du répertoire wok Cooking utilisable comme répertoire de travail.
Créer un Wok personnel
Si vos paquets sont uniquement pour un usage personnel et ne sont pas destinés à être inclus dans les dépôts de SliTaz, un wok peut être créé de toute pièce.
# tazwok gen-clean-wok
Compiler et générer des paquets
Avant de compiler votre premier paquet, Tazwok doit savoir où est votre répertoire de travail. Par défaut, le chemin est /home/slitaz/wok mais vous pouvez le changer ou renommer le wok que vous voulez télécharger. Pour afficher et vérifier les chemins qui seront employés par Tazwok, le nombre de paquets dans le wok, vous pouvez demander des statistiques à Tazwok:
# tazwok stats
Le processus de génération d'un paquet SliTaz de la source peut se résumer ainsi: configurer, compiler et strip.
Lorsque vous générez votre premier paquet, il est conseillé de rester simple et de construire le paquet sans changer sa recette ou la recherche des dépendances. M4 est un candidat idéal pour votre première cuisine:
# tazwok cook m4
Quand Tazwok a fini de construire M4, son paquet est placé dans le répertoire spécifié par le fichier de configuration (/home/slitaz/packages par défaut). Si tout va bien, vous pouvez installer le paquet sur le système hôte ou l'utiliser pour générer une distribution LiveCD via Tazlito!
Lorsque vous êtes familier avec les recettes et le processus de compilation, vous pouvez utiliser la commande suivante pour créer un nouveau paquet (et un wok, si vous n'en avez pas) avant d'écrire interactivement sa recette:
# tazwok new-tree <packageName> --interactive
Assurez-vous de lire la documentation sur les options offertes par les recettes et les Conseils Tazwok pour éviter les frustrations !
Cuisson de paquets multiples avec la liste de cuisson
Tazwok peut compiler plusieurs paquets en une seule commande. Ceci est réalisé avec une liste de cuisson, un fichier texte d'un paquet par la ligne. Tazwok accepte une liste de cuisson avec la commande cook-list, par exemple, pour cuire la liste mespaquets:
# tazwok cook-list mespaquets.cooklist
Options de compilation des paquets
Vous êtes libre d'utiliser les options de compilation que vous désirez, il faut juste respecter le FSH, la documentation dans /usr/share/doc par exemple et suivre les standards de Freedesktop (.desktop entre autres).
Paquet-Spécifique
Les options spécifiques à chaque paquet sont de votre choix, on peut par exemple désactiver le support XML pour avoir un binaire PHP plus petit et se débarrasser de libxml2, mais dans le cas de PHP le gain de place ne vaut pas le coup par rapport aux pertes de fonctionnalités. Si vous avez des doutes, regardez des recettes existantes et leurs options de compilation dans compile_rules.
Optimisation
Les paquets SliTaz officiels sont optimisés pour i486, les options d'optimisation passées en arguments à configure sont spécifiées dans le fichier de configuration de Tazwok (/etc/tazwok.conf) et peuvent être appelées par la variable $CONFIGURE_ARGS. Si vous voulez compiler un paquet avec des arguments différents, vous pouvez modifier le fichier de configuration de Tazwok :
CONFIGURE_ARGS="--build=i486-pc-linux-gnu --host=i486-pc-linux-gnu"
Fichiers à inclure ou exclure des paquets
En général, les paquets de base ne contiennent pas de manuel man, info, doc ou librairies statiques. Il faut créer un paquet-doc ou paquet-dev. À noter que SliTaz ne propose pas la commande man ou info, donc pas de manuel ou fichier GNU info et que la création de paquets contenant la doc est vraiment en option, surtout si la documentation est en anglais. En revanche, écrire de la documentation au sujet du paquet dans le Handbook est plus qu'apprécié car elle est largement disponible et peut être facilement mise à jour et améliorée.
À propos des fichiers de configuration, quand c'est possible, le but est de proposer des fichiers de configuration de base permettant de faire fonctionner directement le paquet. Les cas particuliers existent, comme dans le cas du serveur Web LightTPD, le paquet SliTaz fournit des fichiers de configuration fait maison et le script de démarrage du démon situé dans /etc/init.d, le tout documenté dans le Handbook. Pour un nouveau paquet, vous êtes libre de choisir sa configuration par défaut en fonction de ce qui vous semble le plus simple pour l'utilisateur final. Sur SliTaz vous disposez aussi d'un répertoire /usr/share/examples destiné à des exemples de configuration ou autres types d'exemples utiles.
Catégories des paquets
Les catégories des paquets existent à titre d'information et ne sont pas encore vraiment figées. L'idée est de classer les paquets pour l'interface web dont les pages sont générées chaque nuit depuis le wok en récupérant les données dans les recettes des paquets. Dans l'immédiat, les paquets de développement sont dans 'development', Xorg et compagnie dans 'x-window' et la plupart des nouveautés dans 'extra'.
Structure d'un paquet dans le wok
La structure des paquets dans le wok devrait toujours être respectée si l'on veut que Tazwok trouve les bons fichiers et répertoires. Contenu possible d'un paquet (le répertoire taz/ est créé lors de la cuisson) :
- stuff/ : le matériel utilisé pour configurer, compiler et générer le paquet (patche(s), Makefile, pseudo fs, etc).
- receipt : la recette de cuisine (voir Recettes).
- description.txt : (en option) la description du paquet est copiée à la racine du paquet Tazpkg. Une fois installé, 'tazpkg' sait traiter ce fichier via la commande 'tazpkg desc pkgname'.
- taz/ : répertoire contenant l'arbre du paquet Tazpkg généré, le paquet compressé est stocké dans le répertoire spécifié par $PACKAGES_REPOSITORY du fichier de configuration de Tazwok.
Tazwok fera appel à automatiquement Tazpkg pour empaqueter le répertoiretaz. Il transmet également les instructions d'empaquetage trouvées dans la recette.
Structure d'un paquet tazpkg
Les paquets SliTaz sont des archives cpio contenant un système de fichiers compressé avec gzip et des fichiers :
- fs/ : pseudo système de fichiers contenant tous les fichiers à installer.
- receipt : la recette.
- files.list : liste des fichiers contenus dans le paquet.
- description.txt : la description du paquet (en option).