Gestion collaborative du développement

Les outils et services utilisés pour forger SliTaz :-)

Le projet SliTaz dispose de divers moyens pour gérer le travail des développeurs et collaborer. Un système de gestion de révision avec Mercurial (Hg), des modules de synchronisation avec Rsync, de la documentation, une liste de discussion et un canal IRC. Tous les développeurs sont inscrits sur la liste, c'est le moyen de collaboration principal et privilégié.

KISS et respect des standards

Rester simple, respecter au mieux les standards, réaliser un travail soigné, rédiger de la documentation de haute qualité, fournir un système stable et robuste et garder le rootfs du LiveCD standard assez léger pour que SliTaz tourne sur des machines ayant au minimum 128 Mb de RAM. Possibilité d'utiliser GTK+2, Dialog, Gtkdialog, des scripts SHell ou encore PHP pour coder des outils propres à la distribution. L'idée est aussi de ne pas faire de doublons et de penser mini...

SliTaz se veut un projet proche et à l'écoute des ses utilisateurs. Il y a plusieurs développeurs actifs sur le forum et sur la liste de discussion.

Marmite - Build host & miroir

Chaque contributeur peut avoir un compte sur le serveur du projet, avec un accès SSH sécurisé (clé publique uniquement, sans mot de passe). Marmite est le build host de SliTaz et héberge le miroir officiel des paquets : mirror.slitaz.org, avec sa page d'état sur marmite.slitaz.org. Il remplace depuis 2026 l'ancien serveur Tank.

Dépôts Mercurial

Tous les sous-projets tels que Tazpkg, Cookutils ou Tazlito ont leurs propres dépôts Hg sur le serveur du projet, tout comme le wok. Il est bien sûr possible de demander la création d'un nouveau dépôt pour collaborer sur un nouveau sous-projet lié à SliTaz. Tout le monde peut parcourir et cloner les dépôts sur https://hg.slitaz.org/. Mercurial s'installe avec : tazpkg get-install mercurial

Depuis 2026, l'écriture se fait uniquement par SSH : l'ancien push en HTTPS avec mot de passe ne marche plus. Pour pousser, il faut un compte développeur et votre clé SSH (voir ci-dessous). L'URL SSH d'un dépôt est :

ssh://votrelogin@hg.slitaz.org//home/slitaz/repos/<dépôt>

Remplacez votrelogin par le nom de votre compte et <dépôt> par le nom du dépôt (wok, website, cookutils...). Attention au double slash après le nom du serveur : le chemin sur le serveur est absolu.

Clé SSH et compte développeur

Les comptes sont créés par un admin à partir de votre clé SSH publique. Générez une paire de clés ed25519 sur votre machine :

 $ ssh-keygen -t ed25519 -C "vous@votre-machine"
 $ cat ~/.ssh/id_ed25519.pub

Sur SliTaz (dropbear) :

 $ dropbearkey -t ed25519 -f ~/.ssh/id_dropbear
 $ dropbearkey -y -f ~/.ssh/id_dropbear | grep ^ssh-ed25519

Envoyez la ligne ssh-ed25519 AAAA… à un admin ou au groupe des développeurs (liste de diffusion ou forum). La clé publique peut se partager sans risque, la clé privée ne quitte jamais votre machine.

Avec OpenSSH, une fois le compte créé, ajoutez ceci à votre ~/.ssh/config : les serveurs bannissent les clients dont l'agent SSH présente trop de clés à la suite.

Host hg.slitaz.org marmite.slitaz.org
    User votrelogin
    IdentityFile ~/.ssh/id_ed25519
    IdentitiesOnly yes

Avec dropbear, le ssh par défaut de SliTaz, rien à configurer : il ne lit pas ~/.ssh/config, il utilise tout seul ~/.ssh/id_dropbear, et votre login est donné dans l'URL (ssh://votrelogin@hg.slitaz.org/...).

~/.hgrc

Mercurial lit votre nom dans le fichier caché ~/.hgrc. Mettez votre nom et adresse mail pour qu'on sache qui a modifié quoi, et ne travaillez jamais en root. Exemple :

[ui]
username = Prénom Nom <you@example.org>

Nouveau clone : pull en HTTPS, push en SSH

C'est la configuration des développeurs du projet : les pull restent rapides et anonymes en HTTPS, les push passent par SSH avec votre clé. Pour cloner, par exemple le wok :

 $ hg clone https://hg.slitaz.org/wok

Ouvrez ensuite wok/.hg/hgrc avec un éditeur de texte et ajoutez la ligne default-push sous [paths] :

[paths]
default = https://hg.slitaz.org/wok
default-push = ssh://votrelogin@hg.slitaz.org//home/slitaz/repos/wok

Vous pouvez aussi cloner directement par SSH : pull et push passent alors tous les deux par SSH et il n'y a rien à ajouter :

 $ hg clone ssh://votrelogin@hg.slitaz.org//home/slitaz/repos/wok

Clone existant : passer le push en SSH

Un clone fait avant le passage à SSH n'a pas besoin d'être refait. Ouvrez son .hg/hgrc avec un éditeur de texte :

Retirez aussi de votre ~/.hgrc toute section [auth] ou mot de passe écrit pour hg.slitaz.org : ils ne servent plus.

Vérifier avant le premier push

 $ hg paths
 $ hg outgoing

hg paths affiche l'URL de pull (default) et celle de push (default-push). hg outgoing se connecte en SSH et liste les commits qui seraient poussés, sans rien pousser. À la première connexion, SSH demande de confirmer la clé du serveur : répondez oui. Si le serveur refuse votre clé, votre compte ou votre clé n'est pas encore en place : voir Clé SSH et compte développeur.

En option : le raccourci schemes

L'extension schemes est livrée avec Mercurial et raccourcit l'URL SSH. Ajoutez à votre ~/.hgrc :

[extensions]
schemes =

[schemes]
slitaz = ssh://votrelogin@hg.slitaz.org//home/slitaz/repos/

slitaz://wok remplace alors l'URL SSH complète du wok. Pour cloner, donnez toujours le dossier de destination : sans lui, Mercurial s'arrête sur "empty destination path is not valid".

 $ hg clone slitaz://wok wok

Un tel clone enregistre slitaz://wok/ comme URL et a besoin de l'extension pour continuer à marcher. Dans un clone HTTPS, default-push = slitaz://wok marche aussi.

Modifier, commiter et pousser

Copier, créer, modifier des recettes ou des fichiers dans stuff. Avant de pouvoir pousser vos modifs, il faut les ajouter à votre dépôt local et les commiter. À noter que la commande status permet de savoir quels fichiers ont été modifiés :

 $ cd wok
 $ hg status
 $ hg add
 $ hg commit

La commande commit va ouvrir l'éditeur de texte Nano pour écrire le message destiné aux logs (Ctrl + X pour enregistrer et quitter). Vous pouvez éviter Nano en utilisant l'option : -m "Message". And please, messages in English if possible :

 $ hg commit -m "Message for Mercurial log"

Une fois que tout est prêt, vous pouvez encore utiliser la commande log pour voir ce qui va être affiché sur l'interface web. Avant de pousser, tirez toujours les changements du serveur :

 $ hg log
 $ hg pull
 $ hg push

Si quelqu'un a poussé entre-temps, le pull affiche "run 'hg merge' to merge" et un push sans fusion s'arrête sur "push creates new remote head". Fusionnez, commitez la fusion, puis poussez :

 $ hg merge
 $ hg commit -m "Merge"
 $ hg push

Mettre à jour un wok local

Pour mettre à jour votre wok local avec celui du serveur (pull pour tirer les changements, -u pour mettre à jour les fichiers) :

 $ hg pull -u

Commandes utiles

Implémentation d'iconv()

SliTaz utilise iconv() fourni par la GNU glibc, même si certain paquets proposent d'utiliser libiconv il faut utiliser la version de la glibc (paquet glibc-locale). Il n'y a donc pas de paquet libiconv (1,2 Mb) dans SliTaz.

Paquets tazpkg

Les paquets tazpkg de SliTaz sont créés automatiquement via Tazwok et les recettes contenues dans le wok, le Cookbook décrit l'utilisation des outils SliTaz et le format des recettes, c'est sans doute par un petit peu de lecture qu'il faut commencer.

Concernant le choix des paquets, l'idée est de proposer un paquet par tâche ou fonctionnalité, c'est à dire pas (trop) de doublons et de trouver l'application la plus légère dans son domaine. A noter que les paquets actuels ne sont pas figés, si vous trouvez une alternative à un paquet existant, étant plus légère, ayant plus de fonctionnalités ou étant plus sexy pour quelques Ko supplémentaires, vous pouvez la proposer sur la liste. Une attention particulière est portée aux paquets destinés au LiveCD : strip, suppression de tout ce qui est inutile, dépendances et options de compilation. En général, les paquets candidats pour le corps du LiveCD sont discutés sur la liste.

Avant de commencer à compiler et créer des paquets pour SliTaz, assurez-vous qu'une recette n'existe pas dans le wok undigest, disponible sur le miroir principal de SliTaz. N'oubliez pas non plus que les membres de la liste sont là pour vous aider et que pour bien commencer, la documentation du wok et des outils existe.

Nommage des paquets

Dans la majorité des cas le nom du paquet est celui des sources exception faite des modules Python, Perl, PHP, Ruby, Lua. Par example le paquet Kid fournissant un système de template XML et écrit en Python se nomme: python-kid.

Gestion du site Web et des livres

La gestion du site et des livres (Handbook et Cookbook) est faite via un dépôt Mercurial, ce qui nous permet de traviller à plusieurs. Il faut juste installer mercurial sur SliTaz et connaître les commandes de base. Une fois le dépôt cloné vous avez une copie complète du site en local pour commencer à travailler. Pour cloner le site web :

 $ hg clone https://hg.slitaz.org/website

Pour pousser, ajoutez default-push = ssh://votrelogin@hg.slitaz.org//home/slitaz/repos/website sous [paths] dans website/.hg/hgrc, comme pour le wok (voir Dépôts Mercurial).

Sur SliTaz vous pouvez installer le serveur web Lighttpd et mettre le site dans votre répertoire ~/Public, cela permet de naviguer dans votre copie locale via localhost/~user.

xHTML coding style

Les pages du site et des différents books sont codés en xHTML 1.0 Transitional, les couleurs pour le body et les titres sont directement mis dans la page, cela permet d'avoir une présentation plus soignée pour Links. Le titre de niveau 1 est utilisé une seule fois en haut de page, le titre 2 correspond au titre du document et les titres de niveau 3 et 4 sont ensuite utilisés pour les sous-titres. Si il y a lieu d'avoir une liste à puces avec des ancres, elle se met en haut juste après le titre de niveau 2. Les paragraphes sont contenus dans les balises <p></p>. Pour indenter, nous utilisons des tabulations, elles ont une raison d'être sémantique et prennent moins de place en terme d'octets. Pour mettre du code tel que le nom d'une commande dans un paragraphe, la balise <code> est recommandée. Pour afficher une ou des commandes à lancer dans un terminal, les pages du site utilisent la balise <pre> permettant d'afficher du texte préformaté. Exemple :

 $ command

Pour afficher du texte à copier/coller tels que des scripts, des bouts de code, des exemples de fichiers de configuration, etc, c'est aussi la balise <pre> mais avec une classe CSS nommée "script". Exemple:

<pre class="script">

code...

</pre>

Les mots en English se mettent dans la balise <em> et les liens internes sont relatifs. Penser à vérifier la validité du code via le validator en ligne du W3C.

Diff et patch

Les utilitaires diff et patch sont des outils en ligne de commande permettant de créer et d'appliquer un fichier contenant les différences entre deux fichiers. Cette technique est souvent utilisée pour collaborer et permet d'extraire clairement les modifications apportées au fichier original. Pour créer un fichier diff lisible par les humains dans un simple éditeur de texte, il faut utiliser l'option -u en argument :

 $ diff -u file.orig file.new > file.diff

Pour appliquer un patch :

 $ patch file.orig file.diff