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