website view en/devel/index.php @ rev 819
Change links to new bugtracker
| author | Claudinei Pereira <claudinei@slitaz.org> |
|---|---|
| date | Thu Apr 14 03:36:49 2011 +0000 (2011-04-14) |
| parents | 99c609c6f5b8 |
| children | afa852ea51a0 |
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="en" lang="en">
4 <head>
5 <title>SliTaz - Developers corner</title>
6 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
7 <meta name="description" content="SliTaz GNU/Linux project information overview" />
8 <meta name="keywords" lang="en" content="about slitaz, gnu, linux, mini distro, livecd" />
9 <meta name="robots" content="index, follow, all" />
10 <meta name="modified" content="<?php echo (date( "Y-m-d H:i:s", getlastmod())); ?>" />
11 <meta name="author" content="Christophe Lincoln"/>
12 <link rel="shortcut icon" href="../../favicon.ico" />
13 <link rel="stylesheet" type="text/css" href="../../slitaz.css" />
14 </head>
15 <body>
17 <!-- Header -->
18 <div id="header">
19 <div id="logo"></div>
20 <div id="network">
21 <a href="http://www.slitaz.org/netmap.php">
22 <img src="../../images/network.png" alt="network.png" /></a>
23 <a href="http://scn.slitaz.org/">Community</a>
24 <a href="http://doc.slitaz.org/">Doc</a>
25 <a href="http://forum.slitaz.org/">Forum</a>
26 <a href="http://bugs.slitaz.org">Bugs</a>
27 <a href="http://hg.slitaz.org/">Hg</a>
28 </div>
29 <h1><a href="http://www.slitaz.org/">SliTaz GNU/Linux</a></h1>
30 </div>
32 <!-- Block -->
33 <div id="block">
34 <!-- Navigation -->
35 <div id="block_nav">
36 <h4>Navigation</h4>
37 <div class="right_box">
38 <ul>
39 <li><a href="../mailing-list.html">Mailing List</a></li>
40 <li><a href="../devel/">Development</a></li>
41 <li><a href="../packages/">Packages</a></li>
42 <li><a href="../artwork/">Artwork</a></li>
43 <li><a href="../search.html">Search</a></li>
44 </ul>
45 </div>
46 <div class="left_box">
47 <ul>
48 <li><a href="../">Headlines</a></li>
49 <li><a href="../about/">About</a></li>
50 <li><a href="../get/">Download</a></li>
51 <li><a href="../asso/">Association</a></li>
52 <li><a href="../doc/">Documentation</a></li>
53 </ul>
54 </div>
55 </div>
56 <!-- Information/image -->
57 <div id="block_info">
58 <h4>Development</h4>
59 <p>
60 SliTaz is a community based distribution made by many
61 people all over the world and everyone is welcome to help
62 and get involved in the project.
63 </p>
64 <p>
65 <img src="../../images/users.png" alt="users.png" />
66 <a href="http://scn.slitaz.org/">Join us on SCN</a> and
67 the <a href="../mailing-list.html">mailing list</a>
68 </p>
69 </div>
70 </div>
72 <!-- Content -->
73 <div id="content">
75 <h2>Devel corner</h2>
77 <ul>
78 <li><a href="#devel">SliTaz Developers corner.</a></li>
79 <li><a href="#kiss">KISS and comply to standards.</a></li>
80 <li><a href="#tank">Build host & home.</a></li>
81 <li><a href="#repos">Mercurial repositories.</a></li>
82 <li><a href="#iconv">Implementation of iconv().</a></li>
83 <li><a href="#pkgs">Tazpkg packages.</a></li>
84 <li><a href="#website">Website Management.</a></li>
85 <li><a href="http://hg.slitaz.org/" >Mercurial Repositories</a></li>
86 <li><a href="http://labs.slitaz.org/">SliTaz Laboratories</a></li>
87 </ul>
89 <a name="devel"></a>
90 <h2>SliTaz Developers corner</h2>
91 <p>
92 SliTaz is an open source and community driven distribution. Everyone is welcome
93 to join and contribute, from users, to hackers and developers, there is always
94 something to do, ie. Proofreading or writing documentation, sending bugs or
95 patches to the Mailing list, gaining access to the wok and pushing some new
96 packages or simply to help others on the Mailing list or forum. SliTaz has got
97 Mercurial repositories hosted on a SliTaz system, developers can ask for a new
98 repo if needed and contributors have write access to correct typos, scripts, etc.
99 </p>
100 <p>
101 SliTaz is a tiny community and listens to its users. There are several
102 developers who are active on the <a href="http://forum.slitaz.org/">forum</a>
103 and the <a href="../mailing-list.html">Mailing List</a>.
104 </p>
105 <p>
106 For artists there is a dedicated website, simply create an account and
107 post your graphics or pictures. The site is managed by the community. If
108 you want to lend a hand to administer the site, please contact a
109 contributor or e-mail the discussion list. Join the SliTaz Community
110 <a href="http://scn.slitaz.org/groups/artwork/">Artwork group</a>
111 </p>
113 <a name="kiss"></a>
114 <h2>KISS and comply to standards</h2>
115 <p>
116 Keep it simple: follow the best standards, carefully draft and write
117 high quality documentation, provide a stable and robust system and keep
118 the <em>rootfs</em> on the LiveCD light enough to run on machines with at
119 least 128 MB RAM. It's also possible to use GTK+2, Dialog, SHell scripts,
120 or PHP coding tools on the distribution. The idea is not to duplicate and
121 to think small...
122 </p>
124 <a name="tank"></a>
125 <h2>Tank - Build host & home</h2>
126 <p>
127 Each contributor may have an account on the project server with secure
128 access, disk space, a public directory and all development tools.
129 Developers can compile packages and maintainers of the mirror can handle
130 sychronization. Tank also hosts the website, web boot and mercurial
131 repositories: <a href="http://tank.slitaz.org/">tank.slitaz.org</a>
132 </p>
133 <p>
134 Instructions on using the build host are described in the Cookbook:
135 <a href="http://doc.slitaz.org/en:cookbook:buildhost">SliTaz Build Host (tank)</a>.
136 </p>
138 <a name="repos"></a>
139 <h2>Mercurial repositories</h2>
140 <p>
141 SliTaz Mercurial or Hg repos can be browsed or cloned by anyone using the URL:
142 <a href="http://hg.slitaz.org/">http://hg.slitaz.org/</a>. People with write
143 access can directly use <code>repos.slitaz.org</code> which requires authentication.
144 Mercurial uses Python and is installable with:
145 <code>tazpkg get-install mercurial</code>
146 </p>
147 <h3>~/.hgrc</h3>
148 <p>
149 Before you push your first commit onto the server, be sure that you have a correct
150 Hg configuration file with your name and email address, and remember to check
151 that you are not root. Personal ~/.hgrc file example:
152 </p>
153 <pre class="script">
154 [ui]
155 username = FirstName LastName <you@example.org>
156 </pre>
157 <h4>Clone, modify, commit and push</h4>
158 <p>
159 Clone a repo, example for wok:
160 </p>
161 <pre>
162 $ hg clone http://repos.slitaz.org/wok
163 </pre>
164 <p>
165 Change directory to wok, note you must be in the repository to be able
166 to use 'hg' commands. To check all logs or just the last log:
167 </p>
168 <pre>
169 $ hg log
170 $ hg head
171 </pre>
172 <p>
173 Add or modify one or more files and commit:
174 </p>
175 <pre>
176 $ hg add
177 $ hg status
178 $ hg commit -m "Log message..."
179 $ hg log
180 </pre>
181 <p>
182 Note that you can use the command <code>rollback</code> to roll back to the last
183 transaction. Before pushing changes to the server, it is safe to pull once:
184 </p>
185 <pre>
186 $ hg pull
187 $ hg push
188 </pre>
189 <p>
190 Done, your changes, code or corrections are now on the server.
191 </p>
192 <h4>Updating a local wok</h4>
193 <p>
194 To update your wok with the local server (<em>pull</em> to pull the changes):
195 </p>
196 <pre>
197 $ hg pull
198 $ hg update
199 </pre>
200 <h4>Useful commands</h4>
201 <p>
202 Hg commands that can be used.
203 </p>
204 <ul>
205 <li><code>hg help</code> : Display the full list of commands.</li>
206 <li><code>hg rollback</code> : Undo the last action performed (commit,
207 pull, push).</li>
208 <li><code>hg log <package></code> : Display a package log.</li>
209 <li><code>hg head</code> : Display the last log.</li>
210 </ul>
212 <a name="iconv"></a>
213 <h2>Implementation of iconv()</h2>
214 <p>
215 SliTaz uses iconv() provided by GNU glibc - any packages that offer
216 <code>libiconv</code> must use the library contained in <code>glibc-locale</code>.
217 There is therefore no longer a libiconv package (1.2 MB) in SliTaz.
218 </p>
220 <a name="pkgs"></a>
221 <h2>Tazpkg Packages</h2>
222 <p>
223 The tazpkg packages in SliTaz are automatically created via Tazwok and a
224 receipt in the wok. The Cookbook describes the
225 <a href="../doc/cookbook/wok-tools.html">use of tools</a>
226 and the format of <a href="../doc/cookbook/receipts.html">receipts</a>.
227 These are required reading before we begin.
228 </p>
229 <p>
230 In terms of choice of package, the idea is to offer a package by task or
231 functionality, ie. the lightest application in the field and not duplicated.
232 Note that the current packages are not immutable, if you find an alternative
233 that is lighter, with more features or more <em>sexy</em> for a few extra KB,
234 you can suggest it on the Mailing List. Particular attention is given to
235 packages for the LiveCD, these should be stripped, removing unnecesary
236 dependancies and compiler options. In general candidate packages for the core
237 LiveCD are discussed on the Mailing List.
238 </p>
239 <p>
240 Before you begin to compile and create packages for SliTaz, be sure that the
241 work doesn't already exist in the
242 <a href="http://download.tuxfamily.org/slitaz/packages/undigest/">undigest</a>
243 wok provided by the primary SliTaz mirror. Don't forget that the members
244 of the list are there to help you and that the documentation of the
245 <a href="../doc/cookbook/wok-tools.html">wok and tools</a>
246 exists to help you get started.
247 </p>
249 <a name="pkgs-naming"></a>
250 <h3>Naming of packages</h3>
251 <p>
252 In most cases the package name is the same as the source, except for
253 Python, Perl, PHP, Ruby and Lua modules. For example, the package
254 providing a Kid template system written in Python and XML is named:
255 <code>python-kid</code>.
256 </p>
258 <a name="website"></a>
259 <h2>Website Management</h2>
260 <p>
261 The website is managed via a mercurial repository, they can be cloned by:
262 </p>
263 <pre>
264 $ hg clone http://hg.slitaz.org/website
265 Or if you have the proper permissions:
266 $ hg clone http://repos.slitaz.org/website
267 </pre>
269 <h3>xHTML coding style</h3>
270 <p>
271 The pages and different <em>books</em> are coded in xHTML 1.0
272 transitional. The title of level 1 is used only once (at the top),
273 level 2 is the title of the document and levels 3 and 4 are then used for
274 the subtitles. If a list is used instead using smart anchors;
275 then that starts at the top, just after the title of level 2.
276 Paragraphs are contained in the tags <code><p></p></code>.
277 For indentation, we use tabs - the reason being semantics and to take
278 up less space in terms of octets (bytes). To put code, like the name of
279 a command inside a paragraph: <code><code></code> is the preferred
280 method. To view commands or to utilize a terminal, the web pages use
281 <code><pre></code> to display the formatted text. Example:
282 </p>
283 <pre>
284 $ command
285 </pre>
286 <p>
287 To view text that can be copied and pasted, such as scripts,
288 bits of code, sample configuration files, etc - we also use
289 <code><pre></code>, but with a CSS class named "script". Example:
290 </p>
291 <pre class="script">
292 <pre class="script">
294 code...
296 </pre>
297 </pre>
298 <p>
299 The <em>emphasized</em> words put themselves in the tag <code><em></code>
300 and internal links are relative. Remember to check the validity
301 of the code via the online <em>validator</em> of the W3C.
302 </p>
304 <a name="diff"></a>
305 <h2>Diff and patch</h2>
306 <p>
307 The utilities <code>diff</code> and <code>patch</code> are command-line tools
308 for creating and implementing a file containing differences between two files.
309 This technique is often used for collaboration and the changes made to the
310 original file can be clearly extracted. To create a <code>diff</code> file
311 readable by humans in a simple text editor, you must supply the <code>-u</code> option:
312 </p>
313 <pre>
314 $ diff -u file.orig file.new > file.diff
315 </pre>
316 <p>
317 To apply a patch:
318 </p>
319 <pre>
320 $ patch file.orig file.diff
321 </pre>
323 <!-- End of content -->
324 </div>
326 <!-- Footer -->
327 <div id="footer">
328 Copyright © <span class="year"></span>
329 <a href="http://www.slitaz.org/">SliTaz</a> - Network:
330 <a href="http://scn.slitaz.org/">Community</a>
331 <a href="http://doc.slitaz.org/">Doc</a>
332 <a href="http://forum.slitaz.org/">Forum</a>
333 <a href="http://pkgs.slitaz.org/">Packages</a>
334 <a href="http://bugs.slitaz.org">Bugs</a>
335 <a href="http://hg.slitaz.org/">Hg</a>
336 <p>
337 SliTaz @
338 <a href="http://twitter.com/slitaz">Twitter</a>
339 <a href="http://www.facebook.com/slitaz">Facebook</a>
340 <a href="http://distrowatch.com/slitaz">Distrowatch</a>
341 <a href="http://en.wikipedia.org/wiki/SliTaz">Wikipedia</a>
342 <a href="http://flattr.com/profile/slitaz">Flattr</a>
343 </p>
344 </div>
346 </body>
347 </html>