SliTaz Repositories

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/developer.txt	Wed Dec 12 18:53:19 2007 +0100
     1.3 @@ -0,0 +1,100 @@
     1.4 +Tazwok - Documentation développeur.                                        2007
     1.5 +===============================================================================
     1.6 +
     1.7 +
     1.8 +Ce document décrit le fonctionnement général de Tazwok, il est principalement
     1.9 +déstiné aux personnes désirant devenir développeur SliTaz/Tazwok. Ce documents
    1.10 +réunit aussi divers notes utiles, des idées et des astuces. Les discussions
    1.11 +au sujet de Tazwok peuvent se faire sur la Mailing list de SliTaz, toutes les
    1.12 +informations d'inscription sont sur le site Web : http://www.slitaz.org/
    1.13 +
    1.14 +
    1.15 +Intoduction
    1.16 +-----------
    1.17 +L'idée est d'utiliser un répertoire (wok) contenant tous les paquets
    1.18 +disponibles, chaque paquet contient au minimum une recette (receipt) servant
    1.19 +à télécharger, désarchiver, compiler et générer le paquet binaire. Pour
    1.20 +fonctionner, Tazwok a aussi besoin d'un répertoire pour stocker les sources
    1.21 +téléchargées ($SOURCES_REPOSITORY) et d'un répertoire pour les paquets générés
    1.22 +($PACKAGES_REPOSITORY). Taz utilise un fichier de configuration (tazwok.conf),
    1.23 +ce fichier peut se trouver dans /etc ou dans le répertoire courant.
    1.24 +
    1.25 +
    1.26 +Coding style
    1.27 +------------
    1.28 +Tazwok est écrit en script SHell, compatible avec ash du projet Busybox qui
    1.29 +est le SHell par défaut sur SliTaz. Le code est identé avec des tabulations,
    1.30 +cela donne un script plus léger (en terme de octect). Les commentaires se
    1.31 +mettent en English et devraient aider a s'y retouver. On peut créer de
    1.32 +nouvelles fonctions si nécessaire et ajouter des commandes qu'il faut tout
    1.33 +de suite documenter (voir même avant pour en discuter sur la liste).
    1.34 +
    1.35 +
    1.36 +BUGS et améliorations
    1.37 +---------------------
    1.38 +Si vous découvez un bug dans le code, ou des commandes qui pourraient être
    1.39 +plus courtes et mieux pensées, n'hésitez pas à vous inscrire sur la liste de
    1.40 +SliTaz ou à envoyer directemnt un mail au mainteneur actuel de Tazwok (voir
    1.41 +le fichier AUTHORS contenu dans les sources).
    1.42 +
    1.43 +
    1.44 +Cookbook et Tazwok
    1.45 +------------------
    1.46 +Tazwok a été inspiré des techniques utilisées dans le Cookbook de SliTaz, les
    1.47 +régles de compilation et celles pour généer le paquet sont largement décrites
    1.48 +dans le livre. Pour plus d'infos : http://www.slitaz.org/doc/cookbook/
    1.49 +
    1.50 +
    1.51 +Wok
    1.52 +---
    1.53 +Le wok est téléchargeable depuis le miroir de SliTaz, c'est une archive
    1.54 +contenant toutes les recettes et fichiers nécessaire à la compilation et
    1.55 +génération des paquets. Le wok principalement utilisé est celui de la version
    1.56 +Cooking (en cuisson), il contient les dernières recettes et fichiers. Pour
    1.57 +installer un wok, on peut télécharger l'archive, désarchiver et configurer
    1.58 +Tazwok pour qu'il trouve les fichiers du wok. Exemple :
    1.59 +
    1.60 + # cd /home/slitaz
    1.61 + # wget http://download.tuxfamily.org/slitaz/wok/cooking-wok.tar.gz
    1.62 + # tar xzf cooking-wok.tar.gz
    1.63 +
    1.64 +Configurer Tazwok pour lister les paquet disponibles :
    1.65 +
    1.66 + # tazwok list
    1.67 +
    1.68 +
    1.69 +Cooklists - Liste de cuisson
    1.70 +----------------------------
    1.71 +Pour compiler une plusieurs paquets en une seule commande, on peut utiliser
    1.72 +des liste de paquets. Il y a des listes exemples dans le répertoire examples/
    1.73 +de cette archive et dans le répertoire /usr/share/examples/tazwok/cooklists
    1.74 +sur SliTaz.
    1.75 +
    1.76 +
    1.77 +Structure d'un paquet dans le wok - $WOK/$PACKAGE/*
    1.78 +---------------------------------------------------
    1.79 +La structure des paquets dans le wok devraient être respectée si l'on veut que
    1.80 +Tazwok trouve les bons fichiers et répertoires. Contenu possible d'un paquet :
    1.81 +
    1.82 + * stuff/ : Le matériel utilisé pour configurer, compiler et générer
    1.83 +   le paquet (patche(s), Makefile, pseudo fs, etc).
    1.84 + * taz/ : Répertoire contenant l'arbre du paquet Tazpkg généré, le paquet
    1.85 +   compressé est stocké dans le répertoire spécifié par $PACKAGES_REPOSITORY.
    1.86 + * receipt : La recette de cuisine (voir receipt.txt).
    1.87 + * description.txt : La description du paquet (en option) est copiée
    1.88 +   à la racine du paquet Tazpkg. Une fois installé, 'tazpkg' sait
    1.89 +   traiter ce fichier via la commande 'tazpkg desc pkgname'.
    1.90 +
    1.91 +
    1.92 +Structure d'un paquet tazpkg - $WOK/$PACKAGE/taz/$PACKAGE-$VERSION/*
    1.93 +----------------------------
    1.94 +
    1.95 + * fs/ : Pseudo système de fichiers contenant tous les fichiers
    1.96 +   à installer.
    1.97 + * receipt : La recette de cuisine (voir receipt.txt).
    1.98 + * files.list : Liste des fichiers contenus dans le paquet.
    1.99 + * description.txt : La description du paquet (en option).
   1.100 +
   1.101 +
   1.102 +===============================================================================
   1.103 +                                                         http://www.slitaz.org/