website view fr/devel/forge.html @ rev 536
fr: localy browseable (with file://)
| author | Pascal Bellard <pascal.bellard@slitaz.org> |
|---|---|
| date | Wed Aug 19 15:29:41 2009 +0200 (2009-08-19) |
| parents | 83d68707e682 |
| children | 803de7c72d06 |
line source
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="fr" lang="fr">
4 <head>
5 <title>SliTaz - Forge (fr)</title>
6 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
7 <meta name="description" content="Développement de SliTaz GNU/Linux" />
8 <meta name="keywords" lang="fr" content="developpement slitaz developer GNU Linux" />
9 <meta name="robots" content="index, follow, all" />
10 <meta name="revisit-after" content="7 days" />
11 <meta name="expires" content="never" />
12 <meta name="modified" content="2009-16-01 16:00:00" />
13 <meta name="author" content="Christophe Lincoln"/>
14 <meta name="publisher" content="www.slitaz.org" />
15 <link rel="shortcut icon" href="../../favicon.ico" />
16 <link rel="stylesheet" type="text/css" href="../../slitaz.css" />
17 <link rel="Content" href="index.html#content" />
18 </head>
19 <body bgcolor="#ffffff">
21 <!-- Header -->
22 <div id="header">
23 <a name="top"></a>
24 <!-- Access -->
25 <div id="access">
26 Language:
27 <a href="../../en/devel/index.html">English</a>
28 </div>
29 <a href="http://www.slitaz.org/fr/"><img id="logo"
30 src="../../pics/website/logo.png" title="www.slitaz.org" alt="www.slitaz.org"
31 style="border: 0px solid ; width: 200px; height: 74px;" /></a>
32 <p id="titre">#!/GNU/Linux</p>
33 </div>
35 <!-- Navigation menu -->
36 <div id="nav">
37 <div id="nav_top"></div>
38 <!-- General -->
39 <ul>
40 <li><a href="../about/index.html" title="Informations au sujet du projet SliTaz">A propos du projet</a></li>
41 <li><a href="../asso/index.html" title="Infrastructure et services">Association</a></li>
42 <li><a href="../get/index.html" title="Téléchargements - LiveCD et sous projets">Obtenir SliTaz</a></li>
43 <li><a href="../doc/index.html" title="Handbook, Cookbook et manuels">Documentation</a></li>
44 <li><a href="../packages/index.html" title="Paquets logiciels disponibles">Paquets</a></li>
45 <li><a href="../devel/index.html" title="Le coin du développeur">Développement</a></li>
46 <li><a href="../artwork/index.html" title="Artwork, couleurs et images">Art & graphisme</a></li>
47 </ul>
48 <!-- Support -->
49 <ul>
50 <li><a href="http://forum.slitaz.org/" title="Forum d'aide et support">Forum de support</a></li>
51 <li><a href="../mailing-list.html" title="Support, contact et collaboration">Liste de discussion</a></li>
52 <li><a href="../search.html" title="Rechercher des infos et/ou de la doc">Recherche</a></li>
53 <li><a href="../sitemap.html" title="Vue globale du site web">Plan du site</a></li>
54 </ul>
55 <!-- Wiki and Labs -->
56 <ul>
57 <li><a href="http://wiki.slitaz.org/" title="Wiki collaboratif">Ressources Wiki</a></li>
58 <li><a href="http://labs.slitaz.org/" title="Gestion du projet">Laboratoires</a></li>
59 <li><a href="http://labs.slitaz.org/issues" title="Bug Tracking system">Suivi des Bugs</a></li>
60 </ul>
61 <div id="nav_bottom">
62 <div id="nav_bottom_img"></div>
63 </div>
64 </div>
66 <!-- Content top. -->
67 <div id="content_top">
68 <div class="top_left"></div>
69 <div class="top_right"></div>
70 </div>
72 <!-- Content -->
73 <div id="content">
74 <a name="content"></a>
76 <h1><font color="#3E1220">Forge</font></h1>
78 <h2><font color="#DF8F06">Gestion collaborative du développement</font></h2>
80 <ul>
81 <li><a href="index.html#kiss">KISS et respect des standards.</a></li>
82 <li><a href="index.html#tank">Build host & home.</a></li>
83 <li><a href="index.html#repos">Dépôts Mercurial.</a></li>
84 <li><a href="index.html#iconv">Implémentation d'iconv().</a></li>
85 <li><a href="index.html#pkgs">Paquets tazpkg.</a></li>
86 <li><a href="index.html#pkgs-naming">Nommage des paquets.</a></li>
87 <li><a href="index.html#site">Gestion du site Web et des livres.</a></li>
88 <li><a href="index.html#xhtml">xHTML coding style.</a></li>
89 </ul>
91 <p>
92 Le projet SliTaz dispose de divers moyens pour gérer le travail des
93 développeurs et collaborer. Un système de gestion de révision avec Mercurial
94 (Hg), des modules de synchronisation avec Rsync, de la documentation, une
95 <a href="../mailing-list.html">liste de discussion</a> et un canal IRC. Tous
96 les développeurs sont inscrits sur la liste, c'est le moyen de collaboration
97 principal et privilégié.
98 </p>
100 <a name="kiss"></a>
101 <h3>KISS et respect des standards</h3>
102 <p>
103 Rester simple, respecter au mieux les standards, réaliser un travail soigné,
104 rédiger de la documentation de haute qualité, fournir un système stable et
105 robuste et garder le <em>rootfs</em> du LiveCD standard assez léger pour que
106 SliTaz tourne sur des machines ayant au minimum 128 Mb de RAM. Possibilité
107 d'utiliser GTK+2, Dialog, Gtkdialog, des scripts SHell ou encore PHP pour
108 coder des outils propres à la distribution. L'idée est aussi de ne pas faire
109 de doublons et de penser mini...
110 </p>
111 <p>
112 SliTaz se veut un projet proche et à l'écoute des ses utilisateurs. Il y a
113 plusieurs développeurs actifs sur le <a href="http://forum.slitaz.org/">forum</a>
114 et sur la <a href="../mailing-list.html">liste de discussion</a>.
115 </p>
117 <a name="tank"></a>
118 <h3>Tank - Build host & home</h3>
119 <p>
120 Chaque contributeur peut avoir un compte sur le serveur principal du
121 projet, avec un accès sécurisé, de l'espace disque, un répertoire public
122 et tous les outils de développement. Les développeurs peuvent y compiler
123 leurs paquets et les mainteneurs du miroir s'occupent de la synchronisation.
124 Tank héberge aussi le site internet, le web boot et les dépôts Mercurial:
125 <a href="http://tank.slitaz.org/">tank.slitaz.org</a>
126 </p>
127 <p>
128 L'utilisation du build host est décrite dans le Cookbook:
129 <a href="../../en/doc/cookbook/build-host.html">SliTaz Build Host (tank)</a>.
130 </p>
132 <a name="repos"></a>
133 <h3>Dépôts Mercurial</h3>
134 <p>
135 Tous les sous-projets tels que Tazpkg, Tazwok ou Tazlito ont leurs propres
136 dépôts Hg sur le serveur du projet, tout comme le wok. Les développeurs ont
137 un compte et des droits en écriture afin de pouvoir envoyer leurs recettes,
138 mises à jour ou modifications. Il est bien sûr possible de demander la création
139 d'un nouveau dépôt pour collaborer sur un nouveau sous-projet lié à SliTaz.
140 A noter qu'il y a 2 domaines : <a href="http://hg.slitaz.org/">hg.slitaz.org</a>
141 est public et <code>repos.slitaz.org</code> nécessite une authentification, c'est-à-dire
142 que vous pouvez cloner hg.slitaz.org mais pas y pousser vos changements ou fichiers.
143 </p>
144 <h4>~/.hgrc</h4>
145 <p>
146 Mercurial utilise un fichier caché <code>~./hgrc</code> permettant de
147 spécifier son nom d'utilisateur. Il faut mettre votre nom et adresse mail pour
148 qu'on sache qui a modifié quoi. Et attention à ne pas être <em>root</em> pour
149 pousser vos modifications. Exemple :
150 </p>
151 <pre class="script">
152 [ui]
153 username = Prénom Nom <you@example.org>
154 </pre>
155 <h4>Cloner, modifier, commiter et pousser</h4>
156 <p>
157 Vous avez le choix de cloner anonymement via hg.slitaz.org ou directement avec
158 votre login et mot de passe. Pour cloner un dépôt tel que le wok :
159 </p>
160 <pre>
161 $ hg clone http://repos.slitaz.org/wok/
162 </pre>
163 <p>
164 Copier, créer, modifier des recettes ou des fichiers dans <code>stuff</code>.
165 Avant de pouvoir pousser vos modifs, il faut les additionner à votre dépôt
166 local et les commiter. A noter que la commande <code>status</code> permet de
167 savoir quels fichiers ont été modifiés :
168 </p>
169 <pre>
170 $ cd wok
171 $ hg status
172 $ hg add
173 $ hg commit
174 </pre>
175 <p>
176 La commande <code>commit</code> va ouvrir l'éditeur de texte Nano pour écrire le message
177 destiné aux logs (Ctrl + X pour enregistrer et quitter). Vous pouvez éviter
178 Nano en utilisant l'option : <code>-m "Message"</code>. And please,
179 messages in English if possible :
180 </p>
181 <pre>
182 $ hg commit -m "Message for Mercurial log"
183 </pre>
184 <p>
185 Une fois que tout est prêt, vous pouvez encore utiliser la commande
186 <code>log</code> pour voir ce qui va être affiché sur l'interface web. Pour
187 pousser vos changements c'est <code>push</code> :
188 </p>
189 <pre>
190 $ hg log
191 $ hg push
192 </pre>
193 <p>
194 Si vous avez cloné depuis hg.slitaz.org, il faut alors pousser en spécifiant
195 le bon URL :
196 </p>
197 <pre>
198 $ hg push http://repos.slitaz.org/wok/
199 </pre>
200 <h4>Mettre à jour un wok local</h4>
201 <p>
202 Pour mettre à jour votre wok local avec celui du serveur (<em>pull</em> pour
203 tirer les changements) :
204 </p>
205 <pre>
206 $ hg pull
207 $ hg update
208 </pre>
209 <h4>Commandes utiles</h4>
210 <p>
211 Des commandes hg qui peuvent servir.
212 </p>
213 <ul>
214 <li><code>hg help</code> : affiche la liste complète des commandes.</li>
215 <li><code>hg rollback</code> : annule la dernière action exécutée (commit,
216 pull, push).</li>
217 <li><code>hg log <paquet></code> : affiche les logs pour un paquet.</li>
218 <li><code>hg head</code> : affiche le dernier log.</li>
219 </ul>
221 <a name="iconv"></a>
222 <h3>Implémentation d'iconv()</h3>
223 <p>
224 SliTaz utilise iconv() fourni par la GNU glibc, même si certain paquets
225 proposent d'utiliser <code>libiconv</code> il faut utiliser la version de
226 la glibc (paquet <code>glibc-locale</code>). Il n'y a donc pas de paquet
227 libiconv (1,2 Mb) dans SliTaz.
228 </p>
230 <a name="pkgs"></a>
231 <h3>Paquets tazpkg</h3>
232 <p>
233 Les paquets tazpkg de SliTaz sont créés automatiquement via Tazwok et les
234 recettes contenues dans le wok, <a href="../doc/cookbook/index.html">le Cookbook</a>
235 décrit <a href="../doc/cookbook/wok-tools.html">l'utilisation des outils SliTaz</a>
236 et le format des <a href="../doc/cookbook/receipts.html">recettes</a>,
237 c'est sans doute par un petit peu de lecture qu'il faut commencer.
238 </p>
239 <p>
240 Concernant le choix des paquets, l'idée est de proposer un paquet par tâche ou
241 fonctionnalité, c'est à dire pas (trop) de doublons et de trouver
242 l'application la plus légère dans son domaine. A noter que les paquets actuels
243 ne sont pas figés, si vous trouvez une alternative à un paquet existant, étant
244 plus légère, ayant plus de fonctionnalités ou étant plus <em>sexy</em> pour
245 quelques Ko supplémentaires, vous pouvez la proposer sur la liste. Une
246 attention particulière est portée aux paquets destinés au LiveCD : strip,
247 suppression de tout ce qui est inutile, dépendances et options de compilation.
248 En général, les paquets candidats pour le corps du LiveCD sont discutés sur
249 la liste.
250 </p>
251 <p>
252 Avant de commencer à compiler et créer des paquets pour SliTaz, assurez-vous
253 qu'une recette n'existe pas dans le wok undigest, disponible sur le miroir
254 principal de SliTaz. N'oubliez pas non plus que les membres de la liste sont
255 là pour vous aider et que pour bien commencer, <a href="../doc/cookbook/wok-tools.html"
256 >la documentation du wok et des outils</a> existe.
257 </p>
259 <a name="pkgs-naming"></a>
260 <h3>Nommage des paquets</h3>
261 <p>
262 Dans la majorité des cas le nom du paquet est celui des sources exception
263 faite des modules Python, Perl, PHP, Ruby, Lua. Par example le paquet Kid
264 fournissant un système de template XML et écrit en Python se nomme:
265 <code>python-kid</code>.
266 </p>
268 <a name="site"></a>
269 <h3>Gestion du site Web et des livres</h3>
270 <p>
271 La gestion du site et des livres (Handbook et Cookbook) est faite via un
272 dépôt Mercurial, ce qui nous permet de traviller à plusieurs. Il faut
273 juste installer <code>mercurail</code> sur SliTaz et connaître les commandes
274 de base. Une fois le dépôt cloné vous avez une copie complète du site en
275 local pour commencer à travailler. Pour cloner le site web :
276 </p>
277 <pre>
278 $ hg clone http://hg.slitaz.org/website
279 </pre>
280 <p>
281 Si vous avez les droits :
282 </p>
283 <pre>
284 $ hg clone http://repos.slitaz.org/website
285 </pre>
286 <p>
287 Sur SliTaz vous pouvez installer le serveur web Lighttpd et mettre le
288 site dans votre répertoire ~/Public, cela permet de naviguer dans votre
289 copie locale via localhost/~user.
290 </p>
292 <a name="xhtml"></a>
293 <h3>xHTML coding style</h3>
294 <p>
295 Les pages du site et des différents <em>books</em> sont codés en xHTML 1.0
296 Transitional, les couleurs pour le <code>body</code> et les titres sont
297 directement mis dans la page, cela permet d'avoir une présentation plus soignée
298 pour Links. Le titre de niveau 1 est utilisé une seule fois en haut de page,
299 le titre 2 correspond au titre du document et les titres de niveau 3 et 4 sont
300 ensuite utilisés pour les sous-titres. Si il y a lieu d'avoir une liste à puces
301 avec des ancres, elle se met en haut juste après le titre de niveau 2. Les
302 paragraphes sont contenus dans les balises <code><p></p></code>.
303 Pour indenter, nous utilisons des tabulations, elles ont une raison d'être
304 sémantique et prennent moins de place en terme d'octets. Pour mettre
305 du code tel que le nom d'une commande dans un paragraphe, la balise
306 <code><code></code> est recommandée. Pour afficher une ou des commandes
307 à lancer dans un terminal, les pages du site utilisent la balise
308 <code><pre></code> permettant d'afficher du texte préformaté. Exemple :
309 </p>
310 <pre>
311 $ command
312 </pre>
313 <p>
314 Pour afficher du texte à copier/coller tels que des scripts, des bouts de
315 code, des exemples de fichiers de configuration, etc, c'est aussi la balise
316 <code><pre></code> mais avec une classe CSS nommée "script". Exemple:
317 </p>
318 <pre class="script">
319 <pre class="script">
321 code...
323 </pre>
324 </pre>
325 <p>
326 Les mots en <em>English</em> se mettent dans la balise <code><em></code>
327 et les liens internes sont relatifs. Penser à vérifier la validité du code via
328 le <em>validator</em> en ligne du W3C.
329 </p>
331 <h3>Diff et patch</h3>
332 <p>
333 Les utilitaires <code>diff</code> et <code>patch</code> sont des outils en
334 ligne de commande permettant de créer et d'appliquer un fichier contenant
335 les différences entre deux fichiers. Cette technique est souvent utilisée
336 pour collaborer et permet d'extraire clairement les modifications apportées
337 au fichier original. Pour créer un fichier <code>diff</code> lisible par
338 les humains dans un simple éditeur de texte, il faut utiliser l'option
339 <code>-u</code> en argument :
340 </p>
341 <pre>
342 $ diff -u file.orig file.new > file.diff
343 </pre>
344 <p>
345 Pour appliquer un patch :
346 </p>
347 <pre>
348 $ patch file.orig file.diff
349 </pre>
351 <!-- End of content with round corner -->
352 </div>
353 <div id="content_bottom">
354 <div class="bottom_left"></div>
355 <div class="bottom_right"></div>
356 </div>
358 <!-- Start of footer and copy notice -->
359 <div id="copy">
360 <p>
361 Dernière modification : 2009-20-03 03:00:00 -
362 <a href="index.html#top">Haut de la page</a>
363 </p>
364 <p>
365 Copyright © 2009 <a href="http://www.slitaz.org/">SliTaz</a> -
366 <a href="http://www.gnu.org/licenses/gpl.html">GNU General Public License</a>
367 </p>
368 <!-- End of copy -->
369 </div>
371 <!-- Bottom and logo's -->
372 <div id="bottom">
373 <p>
374 <a href="http://validator.w3.org/check?uri=referer"><img
375 src="../../pics/website/xhtml10.png" alt="Valid XHTML 1.0"
376 title="Code validé XHTML 1.0"
377 style="width: 80px; height: 15px;" /></a>
378 </p>
379 </div>
381 </body>
382 </html>