website annotate fr/devel/forge.php @ rev 1021

fr: utf-8
author Paul Issott <paul@slitaz.org>
date Sat Mar 31 16:55:59 2012 +0100 (2012-03-31)
parents 175ff0253b7a
children e0ee682de0a0
rev   line source
pankso@368 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
pankso@368 2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
pankso@368 3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr" lang="fr">
pankso@368 4 <head>
pankso@781 5 <title>SliTaz (fr) - Forge</title>
paul@1021 6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
paul@1021 7 <meta name="description" content="Développement de SliTaz GNU/Linux" />
pankso@368 8 <meta name="keywords" lang="fr" content="developpement slitaz developer GNU Linux" />
pankso@368 9 <meta name="author" content="Christophe Lincoln"/>
al@1017 10 <?php include("../../lib/html/meta-link.html"); ?>
pankso@368 11 </head>
pankso@781 12 <body>
pankso@368 13
al@1017 14 <?php include("../../lib/html/header.html"); ?>
pankso@368 15
pankso@781 16 <!-- Block -->
pankso@781 17 <div id="block">
al@1017 18 <?php include("../../lib/html/nav.fr.html"); ?>
pankso@781 19 <!-- Information/image -->
pankso@781 20 <div id="block_info">
pankso@781 21 <h4>Forge</h4>
pankso@781 22 <p>
paul@1021 23 Les outils et services utilisés pour forger Slitaz :-)
pankso@781 24 </p>
pankso@781 25 <p>
pankso@781 26 <img src="../../images/users.png" alt="users.png" />
pankso@781 27 <a href="http://scn.slitaz.org/">Rejoingez nous sur SCN</a>
al@1009 28 et la <a href="../mailing-list.php">mailing list</a>
pankso@781 29 </p>
pankso@781 30 </div>
pankso@368 31 </div>
pankso@368 32
pankso@368 33 <!-- Content -->
pankso@368 34 <div id="content">
pankso@368 35
paul@1021 36 <h2>Gestion collaborative du développement</h2>
pankso@368 37
pankso@368 38 <ul>
pankso@781 39 <li><a href="#kiss">KISS et respect des standards.</a></li>
pankso@781 40 <li><a href="#tank">Build host &amp; home.</a></li>
paul@1021 41 <li><a href="#repos">Dépôts Mercurial.</a></li>
paul@1021 42 <li><a href="#iconv">Implémentation d'iconv().</a></li>
pankso@781 43 <li><a href="#pkgs">Paquets tazpkg.</a></li>
pankso@781 44 <li><a href="#pkgs-naming">Nommage des paquets.</a></li>
pankso@781 45 <li><a href="#site">Gestion du site Web et des livres.</a></li>
pankso@781 46 <li><a href="#xhtml">xHTML coding style.</a></li>
pankso@368 47 </ul>
pankso@368 48
pankso@368 49 <p>
paul@1021 50 Le projet SliTaz dispose de divers moyens pour gérer le travail des
paul@1021 51 développeurs et collaborer. Un système de gestion de révision avec Mercurial
pankso@368 52 (Hg), des modules de synchronisation avec Rsync, de la documentation, une
al@1009 53 <a href="../mailing-list.php">liste de discussion</a> et un canal IRC. Tous
paul@1021 54 les développeurs sont inscrits sur la liste, c'est le moyen de collaboration
paul@1021 55 principal et privilégié.
pankso@368 56 </p>
pankso@368 57
pankso@506 58 <a name="kiss"></a>
pankso@506 59 <h3>KISS et respect des standards</h3>
pankso@506 60 <p>
paul@1021 61 Rester simple, respecter au mieux les standards, réaliser un travail soigné,
paul@1021 62 rédiger de la documentation de haute qualité, fournir un système stable et
paul@1021 63 robuste et garder le <em>rootfs</em> du LiveCD standard assez léger pour que
paul@1021 64 SliTaz tourne sur des machines ayant au minimum 128 Mb de RAM. Possibilité
pankso@506 65 d'utiliser GTK+2, Dialog, Gtkdialog, des scripts SHell ou encore PHP pour
paul@1021 66 coder des outils propres à la distribution. L'idée est aussi de ne pas faire
pankso@506 67 de doublons et de penser mini...
pankso@506 68 </p>
pankso@506 69 <p>
paul@1021 70 SliTaz se veut un projet proche et à l'écoute des ses utilisateurs. Il y a
paul@1021 71 plusieurs développeurs actifs sur le <a href="http://forum.slitaz.org/">forum</a>
al@1009 72 et sur la <a href="../mailing-list.php">liste de discussion</a>.
pankso@506 73 </p>
pankso@506 74
pankso@368 75 <a name="tank"></a>
pankso@368 76 <h3>Tank - Build host &amp; home</h3>
pankso@368 77 <p>
pankso@368 78 Chaque contributeur peut avoir un compte sur le serveur principal du
paul@1021 79 projet, avec un accès sécurisé, de l'espace disque, un répertoire public
paul@1021 80 et tous les outils de développement. Les développeurs peuvent y compiler
pankso@368 81 leurs paquets et les mainteneurs du miroir s'occupent de la synchronisation.
paul@1021 82 Tank héberge aussi le site internet, le web boot et les dépôts Mercurial:
pankso@368 83 <a href="http://tank.slitaz.org/">tank.slitaz.org</a>
pankso@368 84 </p>
pankso@368 85 <p>
paul@1021 86 L'utilisation du build host est décrite dans le Cookbook:
pascal@844 87 <a href="http://doc.slitaz.org/en:cookbook:buildhost">SliTaz Build Host (tank)</a>.
pankso@368 88 </p>
pankso@368 89
pankso@368 90 <a name="repos"></a>
paul@1021 91 <h3>Dépôts Mercurial</h3>
pankso@368 92 <p>
pankso@368 93 Tous les sous-projets tels que Tazpkg, Tazwok ou Tazlito ont leurs propres
paul@1021 94 dépôts Hg sur le serveur du projet, tout comme le wok. Les développeurs ont
paul@1021 95 un compte et des droits en écriture afin de pouvoir envoyer leurs recettes,
paul@1021 96 mises à jour ou modifications. Il est bien sûr possible de demander la création
paul@1021 97 d'un nouveau dépôt pour collaborer sur un nouveau sous-projet lié à SliTaz.
pankso@368 98 A noter qu'il y a 2 domaines : <a href="http://hg.slitaz.org/">hg.slitaz.org</a>
paul@1021 99 est public et <code>repos.slitaz.org</code> nécessite une authentification, c'est-à-dire
pierre@452 100 que vous pouvez cloner hg.slitaz.org mais pas y pousser vos changements ou fichiers.
pankso@368 101 </p>
pankso@368 102 <h4>~/.hgrc</h4>
pankso@368 103 <p>
paul@1021 104 Mercurial utilise un fichier caché <code>~./hgrc</code> permettant de
paul@1021 105 spécifier son nom d'utilisateur. Il faut mettre votre nom et adresse mail pour
paul@1021 106 qu'on sache qui a modifié quoi. Et attention à ne pas être <em>root</em> pour
pankso@368 107 pousser vos modifications. Exemple :
pankso@368 108 </p>
pankso@368 109 <pre class="script">
pankso@368 110 [ui]
paul@1021 111 username = Prénom Nom &lt;you@example.org&gt;
pankso@368 112 </pre>
pankso@368 113 <h4>Cloner, modifier, commiter et pousser</h4>
pankso@368 114 <p>
pankso@368 115 Vous avez le choix de cloner anonymement via hg.slitaz.org ou directement avec
paul@1021 116 votre login et mot de passe. Pour cloner un dépôt tel que le wok :
pankso@368 117 </p>
pankso@368 118 <pre>
pankso@368 119 $ hg clone http://repos.slitaz.org/wok/
pankso@368 120 </pre>
pankso@368 121 <p>
paul@1021 122 Copier, créer, modifier des recettes ou des fichiers dans <code>stuff</code>.
paul@1021 123 Avant de pouvoir pousser vos modifs, il faut les additionner à votre dépôt
pankso@368 124 local et les commiter. A noter que la commande <code>status</code> permet de
paul@1021 125 savoir quels fichiers ont été modifiés :
pankso@368 126 </p>
pankso@368 127 <pre>
pankso@368 128 $ cd wok
pankso@368 129 $ hg status
pankso@368 130 $ hg add
pankso@368 131 $ hg commit
pankso@368 132 </pre>
pankso@368 133 <p>
paul@1021 134 La commande <code>commit</code> va ouvrir l'éditeur de texte Nano pour écrire le message
paul@1021 135 destiné aux logs (Ctrl + X pour enregistrer et quitter). Vous pouvez éviter
pankso@368 136 Nano en utilisant l'option : <code>-m "Message"</code>. And please,
pankso@368 137 messages in English if possible :
pankso@368 138 </p>
pankso@368 139 <pre>
pankso@368 140 $ hg commit -m "Message for Mercurial log"
pankso@368 141 </pre>
pankso@368 142 <p>
paul@1021 143 Une fois que tout est prêt, vous pouvez encore utiliser la commande
paul@1021 144 <code>log</code> pour voir ce qui va être affiché sur l'interface web. Pour
pankso@368 145 pousser vos changements c'est <code>push</code> :
pankso@368 146 </p>
pankso@368 147 <pre>
pankso@368 148 $ hg log
pankso@368 149 $ hg push
pankso@368 150 </pre>
pankso@368 151 <p>
paul@1021 152 Si vous avez cloné depuis hg.slitaz.org, il faut alors pousser en spécifiant
pankso@368 153 le bon URL :
pankso@368 154 </p>
pankso@368 155 <pre>
pankso@368 156 $ hg push http://repos.slitaz.org/wok/
pankso@368 157 </pre>
paul@1021 158 <h4>Mettre à jour un wok local</h4>
pankso@368 159 <p>
paul@1021 160 Pour mettre à jour votre wok local avec celui du serveur (<em>pull</em> pour
pankso@368 161 tirer les changements) :
pankso@368 162 </p>
pankso@368 163 <pre>
pankso@368 164 $ hg pull
pankso@368 165 $ hg update
pankso@368 166 </pre>
pierre@452 167 <h4>Commandes utiles</h4>
pankso@368 168 <p>
pankso@368 169 Des commandes hg qui peuvent servir.
pankso@368 170 </p>
pankso@368 171 <ul>
paul@1021 172 <li><code>hg help</code> : affiche la liste complète des commandes.</li>
paul@1021 173 <li><code>hg rollback</code> : annule la dernière action exécutée (commit,
pankso@368 174 pull, push).</li>
pierre@452 175 <li><code>hg log &lt;paquet&gt;</code> : affiche les logs pour un paquet.</li>
pierre@452 176 <li><code>hg head</code> : affiche le dernier log.</li>
pankso@368 177 </ul>
pankso@368 178
pankso@506 179 <a name="iconv"></a>
paul@1021 180 <h3>Implémentation d'iconv()</h3>
pankso@506 181 <p>
paul@1021 182 SliTaz utilise iconv() fourni par la GNU glibc, même si certain paquets
pankso@506 183 proposent d'utiliser <code>libiconv</code> il faut utiliser la version de
pankso@506 184 la glibc (paquet <code>glibc-locale</code>). Il n'y a donc pas de paquet
pankso@506 185 libiconv (1,2 Mb) dans SliTaz.
pankso@506 186 </p>
pankso@506 187
pankso@368 188 <a name="pkgs"></a>
pankso@368 189 <h3>Paquets tazpkg</h3>
pankso@368 190 <p>
paul@1021 191 Les paquets tazpkg de SliTaz sont créés automatiquement via Tazwok et les
pascal@844 192 recettes contenues dans le wok, <a href="http://doc.slitaz.org/fr:cookbook:start">le Cookbook</a>
paul@1021 193 décrit <a href="http://doc.slitaz.org/fr:cookbook:wok">l'utilisation des outils SliTaz</a>
pascal@844 194 et le format des <a href="http://doc.slitaz.org/fr:cookbook:receipt">recettes</a>,
pankso@368 195 c'est sans doute par un petit peu de lecture qu'il faut commencer.
pankso@368 196 </p>
pankso@368 197 <p>
paul@1021 198 Concernant le choix des paquets, l'idée est de proposer un paquet par tâche ou
paul@1021 199 fonctionnalité, c'est à dire pas (trop) de doublons et de trouver
paul@1021 200 l'application la plus légère dans son domaine. A noter que les paquets actuels
paul@1021 201 ne sont pas figés, si vous trouvez une alternative à un paquet existant, étant
paul@1021 202 plus légère, ayant plus de fonctionnalités ou étant plus <em>sexy</em> pour
paul@1021 203 quelques Ko supplémentaires, vous pouvez la proposer sur la liste. Une
paul@1021 204 attention particulière est portée aux paquets destinés au LiveCD : strip,
paul@1021 205 suppression de tout ce qui est inutile, dépendances et options de compilation.
paul@1021 206 En général, les paquets candidats pour le corps du LiveCD sont discutés sur
pankso@368 207 la liste.
pankso@368 208 </p>
pankso@368 209 <p>
paul@1021 210 Avant de commencer à compiler et créer des paquets pour SliTaz, assurez-vous
pierre@452 211 qu'une recette n'existe pas dans le wok undigest, disponible sur le miroir
pankso@368 212 principal de SliTaz. N'oubliez pas non plus que les membres de la liste sont
paul@1021 213 là pour vous aider et que pour bien commencer, <a href="http://doc.slitaz.org/fr:cookbook:wok"
pierre@452 214 >la documentation du wok et des outils</a> existe.
pankso@368 215 </p>
pankso@368 216
pankso@506 217 <a name="pkgs-naming"></a>
pankso@506 218 <h3>Nommage des paquets</h3>
pankso@506 219 <p>
paul@1021 220 Dans la majorité des cas le nom du paquet est celui des sources exception
pankso@506 221 faite des modules Python, Perl, PHP, Ruby, Lua. Par example le paquet Kid
paul@1021 222 fournissant un système de template XML et écrit en Python se nomme:
pankso@506 223 <code>python-kid</code>.
pankso@506 224 </p>
pankso@506 225
pankso@368 226 <a name="site"></a>
pankso@368 227 <h3>Gestion du site Web et des livres</h3>
pankso@368 228 <p>
pierre@452 229 La gestion du site et des livres (Handbook et Cookbook) est faite via un
paul@1021 230 dépôt Mercurial, ce qui nous permet de traviller à plusieurs. Il faut
paul@1021 231 juste installer <code>mercurail</code> sur SliTaz et connaître les commandes
paul@1021 232 de base. Une fois le dépôt cloné vous avez une copie complète du site en
paul@1021 233 local pour commencer à travailler. Pour cloner le site web :
pankso@368 234 </p>
pankso@368 235 <pre>
pankso@368 236 $ hg clone http://hg.slitaz.org/website
pierre@452 237 </pre>
pierre@452 238 <p>
pierre@452 239 Si vous avez les droits :
pierre@452 240 </p>
pierre@452 241 <pre>
pankso@368 242 $ hg clone http://repos.slitaz.org/website
pankso@368 243 </pre>
pankso@396 244 <p>
pankso@396 245 Sur SliTaz vous pouvez installer le serveur web Lighttpd et mettre le
paul@1021 246 site dans votre répertoire ~/Public, cela permet de naviguer dans votre
pankso@396 247 copie locale via localhost/~user.
pankso@396 248 </p>
pankso@368 249
pankso@506 250 <a name="xhtml"></a>
pankso@506 251 <h3>xHTML coding style</h3>
pankso@506 252 <p>
paul@1021 253 Les pages du site et des différents <em>books</em> sont codés en xHTML 1.0
pankso@506 254 Transitional, les couleurs pour le <code>body</code> et les titres sont
paul@1021 255 directement mis dans la page, cela permet d'avoir une présentation plus soignée
paul@1021 256 pour Links. Le titre de niveau 1 est utilisé une seule fois en haut de page,
pankso@506 257 le titre 2 correspond au titre du document et les titres de niveau 3 et 4 sont
paul@1021 258 ensuite utilisés pour les sous-titres. Si il y a lieu d'avoir une liste à puces
paul@1021 259 avec des ancres, elle se met en haut juste après le titre de niveau 2. Les
pankso@506 260 paragraphes sont contenus dans les balises <code>&lt;p&gt;&lt;/p&gt;</code>.
paul@1021 261 Pour indenter, nous utilisons des tabulations, elles ont une raison d'être
paul@1021 262 sémantique et prennent moins de place en terme d'octets. Pour mettre
pankso@506 263 du code tel que le nom d'une commande dans un paragraphe, la balise
paul@1021 264 <code>&lt;code&gt;</code> est recommandée. Pour afficher une ou des commandes
paul@1021 265 à lancer dans un terminal, les pages du site utilisent la balise
paul@1021 266 <code>&lt;pre&gt;</code> permettant d'afficher du texte préformaté. Exemple :
pankso@506 267 </p>
pankso@506 268 <pre>
pankso@506 269 $ command
pankso@506 270 </pre>
pankso@506 271 <p>
paul@1021 272 Pour afficher du texte à copier/coller tels que des scripts, des bouts de
pankso@506 273 code, des exemples de fichiers de configuration, etc, c'est aussi la balise
paul@1021 274 <code>&lt;pre&gt;</code> mais avec une classe CSS nommée "script". Exemple:
pankso@506 275 </p>
pankso@506 276 <pre class="script">
pankso@506 277 &lt;pre class="script"&gt;
pankso@506 278
pankso@506 279 code...
pankso@506 280
pankso@506 281 &lt;/pre&gt;
pankso@506 282 </pre>
pankso@506 283 <p>
pankso@506 284 Les mots en <em>English</em> se mettent dans la balise <code>&lt;em&gt;</code>
paul@1021 285 et les liens internes sont relatifs. Penser à vérifier la validité du code via
pankso@506 286 le <em>validator</em> en ligne du W3C.
pankso@506 287 </p>
pankso@506 288
pankso@368 289 <h3>Diff et patch</h3>
pankso@368 290 <p>
pankso@368 291 Les utilitaires <code>diff</code> et <code>patch</code> sont des outils en
paul@1021 292 ligne de commande permettant de créer et d'appliquer un fichier contenant
paul@1021 293 les différences entre deux fichiers. Cette technique est souvent utilisée
paul@1021 294 pour collaborer et permet d'extraire clairement les modifications apportées
paul@1021 295 au fichier original. Pour créer un fichier <code>diff</code> lisible par
paul@1021 296 les humains dans un simple éditeur de texte, il faut utiliser l'option
pankso@368 297 <code>-u</code> en argument :
pankso@368 298 </p>
pankso@368 299 <pre>
pankso@368 300 $ diff -u file.orig file.new > file.diff
pankso@368 301 </pre>
pankso@368 302 <p>
pankso@368 303 Pour appliquer un patch :
pankso@368 304 </p>
pankso@368 305 <pre>
pankso@368 306 $ patch file.orig file.diff
pankso@368 307 </pre>
pankso@368 308
pankso@781 309 <!-- End of content -->
pankso@368 310 </div>
pankso@368 311
al@1017 312 <?php include("../../lib/html/footer.html"); ?>
pankso@368 313
pankso@368 314 </body>
pankso@368 315 </html>