tazwok annotate doc/developer.txt @ rev 362

Fixed new-tree option to make new receipt in clean_wok instend of WOK.
author Christopher Rogers <slaxemulator@gmail.com>
date Thu Feb 24 08:50:48 2011 +0000 (2011-02-24)
parents 560d6f33e8ce
children
rev   line source
pankso@5 1 Tazwok - Documentation développeur. 2007
pankso@5 2 ===============================================================================
pankso@5 3
pankso@5 4
pankso@5 5 Ce document décrit le fonctionnement général de Tazwok, il est principalement
pankso@5 6 déstiné aux personnes désirant devenir développeur SliTaz/Tazwok. Ce documents
pankso@5 7 réunit aussi divers notes utiles, des idées et des astuces. Les discussions
pankso@5 8 au sujet de Tazwok peuvent se faire sur la Mailing list de SliTaz, toutes les
pankso@5 9 informations d'inscription sont sur le site Web : http://www.slitaz.org/
pankso@5 10
pankso@5 11
pankso@5 12 Intoduction
pankso@5 13 -----------
pankso@5 14 L'idée est d'utiliser un répertoire (wok) contenant tous les paquets
pankso@5 15 disponibles, chaque paquet contient au minimum une recette (receipt) servant
pankso@5 16 à télécharger, désarchiver, compiler et générer le paquet binaire. Pour
pankso@5 17 fonctionner, Tazwok a aussi besoin d'un répertoire pour stocker les sources
pankso@5 18 téléchargées ($SOURCES_REPOSITORY) et d'un répertoire pour les paquets générés
pankso@22 19 ($PACKAGES_REPOSITORY), ces valeurs peuvent être configurées via le fichier :
pankso@22 20 /etc/tazwok.conf.
pankso@5 21
pankso@5 22
pankso@5 23 Coding style
pankso@5 24 ------------
pankso@5 25 Tazwok est écrit en script SHell, compatible avec ash du projet Busybox qui
pankso@5 26 est le SHell par défaut sur SliTaz. Le code est identé avec des tabulations,
pankso@5 27 cela donne un script plus léger (en terme de octect). Les commentaires se
pankso@5 28 mettent en English et devraient aider a s'y retouver. On peut créer de
pankso@22 29 nouvelles fonctions si nécessaire et ajouter des commandes qu'il faut et tout
pankso@5 30 de suite documenter (voir même avant pour en discuter sur la liste).
pankso@5 31
pankso@5 32
pankso@5 33 BUGS et améliorations
pankso@5 34 ---------------------
pankso@5 35 Si vous découvez un bug dans le code, ou des commandes qui pourraient être
pankso@5 36 plus courtes et mieux pensées, n'hésitez pas à vous inscrire sur la liste de
pankso@22 37 SliTaz ou à envoyer directement un mail au mainteneur actuel de Tazwok (voir
pankso@5 38 le fichier AUTHORS contenu dans les sources).
pankso@5 39
pankso@5 40
pankso@5 41 Cookbook et Tazwok
pankso@5 42 ------------------
pankso@5 43 Tazwok a été inspiré des techniques utilisées dans le Cookbook de SliTaz, les
pankso@5 44 régles de compilation et celles pour généer le paquet sont largement décrites
pankso@5 45 dans le livre. Pour plus d'infos : http://www.slitaz.org/doc/cookbook/
pankso@5 46
pankso@5 47
pankso@5 48 Wok
pankso@5 49 ---
pankso@5 50 Le wok est téléchargeable depuis le miroir de SliTaz, c'est une archive
pankso@5 51 contenant toutes les recettes et fichiers nécessaire à la compilation et
pankso@5 52 génération des paquets. Le wok principalement utilisé est celui de la version
pankso@5 53 Cooking (en cuisson), il contient les dernières recettes et fichiers. Pour
pankso@5 54 installer un wok, on peut télécharger l'archive, désarchiver et configurer
pankso@22 55 Tazwok pour qu'il trouve les fichiers du wok ou cloner le dépôt Mercurial.
pankso@22 56 Toute les infos d'utilisation du wok sont décrites sur la page Forge du site :
pankso@5 57
pankso@22 58 http://www.slitaz.org/devel/forge.html
pankso@5 59
pankso@5 60
pankso@5 61 Cooklists - Liste de cuisson
pankso@5 62 ----------------------------
pankso@22 63 Pour compiler plusieurs paquets en une seule commande, on peut utiliser des
gokhlayeh@332 64 listes de cuisson. Voir le manuel, commande cooklist.
pankso@5 65
pankso@5 66
pankso@5 67 Structure d'un paquet dans le wok - $WOK/$PACKAGE/*
pankso@5 68 ---------------------------------------------------
pankso@5 69 La structure des paquets dans le wok devraient être respectée si l'on veut que
pankso@5 70 Tazwok trouve les bons fichiers et répertoires. Contenu possible d'un paquet :
pankso@5 71
pankso@5 72 * stuff/ : Le matériel utilisé pour configurer, compiler et générer
pankso@5 73 le paquet (patche(s), Makefile, pseudo fs, etc).
pankso@5 74 * taz/ : Répertoire contenant l'arbre du paquet Tazpkg généré, le paquet
pankso@5 75 compressé est stocké dans le répertoire spécifié par $PACKAGES_REPOSITORY.
pankso@5 76 * receipt : La recette de cuisine (voir receipt.txt).
pankso@5 77 * description.txt : La description du paquet (en option) est copiée
pankso@5 78 à la racine du paquet Tazpkg. Une fois installé, 'tazpkg' sait
pankso@5 79 traiter ce fichier via la commande 'tazpkg desc pkgname'.
pankso@5 80
pankso@5 81
pankso@5 82 Structure d'un paquet tazpkg - $WOK/$PACKAGE/taz/$PACKAGE-$VERSION/*
pankso@5 83 ----------------------------
pankso@5 84
pankso@5 85 * fs/ : Pseudo système de fichiers contenant tous les fichiers
pankso@5 86 à installer.
pankso@5 87 * receipt : La recette de cuisine (voir receipt.txt).
pankso@5 88 * files.list : Liste des fichiers contenus dans le paquet.
pankso@5 89 * description.txt : La description du paquet (en option).
pankso@5 90
pankso@5 91
pankso@5 92 ===============================================================================
pankso@5 93 http://www.slitaz.org/