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