website view en/devel/index.html @ rev 461
en: Prepare for Chinese links
| author | Paul Issott <paul@slitaz.org> |
|---|---|
| date | Sat May 09 18:14:38 2009 +0000 (2009-05-09) |
| parents | 4980c0fb2688 |
| children | 25bd49d28303 |
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="revisit-after" content="7 days" />
11 <meta name="expires" content="never" />
12 <meta name="modified" content="2008-07-16 21:45: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="#content" />
18 </head>
19 <body bgcolor="#ffffff">
20 <!-- Header -->
21 <div id="header">
22 <a name="top"></a>
23 <!-- Access -->
24 <div id="access">
25 Language:
26 <a href="../../de/devel/">Deutsch</a> |
27 <a href="../../fr/devel/" title="Développement en français">Français</a> |
28 <a href="../../pt/devel/">Português</a>
29 </div>
30 <a href="http://www.slitaz.org/en/"><img id="logo"
31 src="../../pics/website/logo.png" title="www.slitaz.org/en" alt="www.slitaz.org"
32 style="border: 0px solid ; width: 200px; height: 74px;" /></a>
33 <p id="titre">#!/GNU/Linux</p>
34 </div>
35 <div id="nav">
36 <div id="nav_top"></div>
37 <!-- General -->
38 <ul>
39 <li><a href="../about/" title="Information about the SliTaz project">About the project</a></li>
40 <li><a href="../asso/" title="SliTaz non-profit association">Association</a></li>
41 <li><a href="../get/" title="Download - LiveCD ISO">Get SliTaz</a></li>
42 <li><a href="../doc/" title="LiveCD usage and howto">Documentation</a></li>
43 <li><a href="../packages/" title="Packaged software">Packages</a></li>
44 <li><a href="../devel/" title="Developers corner">Development</a></li>
45 <li><a href="../artwork/" title="Artwork, colors and images">Artwork</a></li>
46 </ul>
47 <!-- Support -->
48 <ul>
49 <li><a href="http://forum.slitaz.org/#idx2" title="Forum for help and support">Support Forum</a></li>
50 <li><a href="../mailing-list.html" title="Support, contact and collaboration">Mailing List</a></li>
51 <li><a href="../search.html" title="Search engine">Search</a></li>
52 <li><a href="../sitemap.html" title="Web site overview">Sitemap</a></li>
53 </ul>
54 <!-- Wiki and Labs -->
55 <ul>
56 <li><a href="http://wiki.slitaz.org/" title="Wiki communities">Wiki Resources</a></li>
57 <li><a href="http://labs.slitaz.org/" title="SliTaz Laboratories">SliTaz Labs</a></li>
58 <li><a href="http://labs.slitaz.org/issues" title="Bug Tracking system">Bug Tracking</a></li>
59 </ul>
60 <div id="nav_bottom">
61 <div id="nav_bottom_img"></div>
62 </div>
63 </div>
65 <!-- Content top. -->
66 <div id="content_top">
67 <div class="top_left"></div>
68 <div class="top_right"></div>
69 </div>
71 <!-- Content -->
72 <div id="content">
73 <a name="content"></a>
75 <h1><font color="#3e1220">Development</font></h1>
76 <h2><font color="#df8f06">SliTaz Developers corner</font></h2>
78 <ul>
79 <li><a href="#tank">Build host & home.</a></li>
80 <li><a href="#repos">Mercurial repositories.</a></li>
81 <li><a href="#pkgs">Tazpkg packages.</a></li>
82 <li><a href="#website">Website Management.</a></li>
83 <li><a href="../mailing-list.html">Mailing List.</a></li>
84 <li><a href="../doc/cookbook/wok-tools.html">Wok & Tools.</a></li>
85 <li>Mercurial Repositories: <a href="http://hg.slitaz.org" >hg.slitaz.org</a></li>
86 <li>SliTaz Laboratories: <a href="http://labs.slitaz.org/">labs.slitaz.org</a></li>
87 </ul>
89 <p>
90 SliTaz is an open source and community driven distribution. Everyone is welcome
91 to join and contribute, from users, to hackers and developers, there is always
92 something to do, ie. Proofreading or writing documentation, sending bugs or
93 patches to the Mailing list, gaining access to the wok and pushing some new
94 packages or simply to help others on the Mailing list or forum. SliTaz has got
95 Mercurial repositories hosted on a SliTaz system, developers can ask for a new
96 repo if needed and contributors have write access to correct typos, scripts, etc.
97 </p>
99 <p>
100 SliTaz is a tiny community and listens to its users. There are several
101 developers who are active on the <a href="http://forum.slitaz.org/">forum</a>
102 and the <a href="../mailing-list.html">Mailing List</a>.
103 </p>
105 <a name="tank"></a>
106 <h3>Tank - Build host & home</h3>
107 <p>
108 Each contributor may have an account on the project server with secure access,
109 disk space, a public directory and all development tools. Developers can compile
110 packages and maintainers of the mirror can handle sychronization. Tank also
111 hosts the website, web boot and mercurial repositories:
112 <a href="http://tank.slitaz.org/">tank.slitaz.org</a>
113 </p>
115 <a name="repos"></a>
116 <h3>Mercurial repositories</h3>
117 <p>
118 SliTaz Mercurial or Hg repos can be browsed or cloned by anyone using the URL:
119 <a href="http://hg.slitaz.org/">http://hg.slitaz.org/</a>. People with write
120 access can directly use <code>repos.slitaz.org</code> which requires authentication.
121 Mercurial uses Python and is installable with:
122 <code>tazpkg get-install mercurial</code>
123 </p>
124 <h4>~/.hgrc</h4>
125 <p>
126 Before you push your first commit onto the server, be sure that you have a correct
127 Hg configuration file with your name and email address, and remember to check
128 that you are not root. Personal ~/.hgrc file example:
129 </p>
130 <pre class="script">
131 [ui]
132 username = FirstName LastName <you@example.org>
133 </pre>
134 <h4>Clone, modify, commit and push</h4>
135 <p>
136 Clone a repo, example for wok:
137 </p>
138 <pre>
139 $ hg clone http://repos.slitaz.org/wok
140 </pre>
141 <p>
142 Change directory to wok, note you must be in the repository to be able
143 to use 'hg' commands. To check all logs or just the last log:
144 </p>
145 <pre>
146 $ hg log
147 $ hg head
148 </pre>
149 <p>
150 Add or modify one or more files and commit:
151 </p>
152 <pre>
153 $ hg add
154 $ hg status
155 $ hg commit -m "Log message..."
156 $ hg log
157 </pre>
158 <p>
159 Note that you can use the command <code>rollback</code> to roll back to the last
160 transaction. Before pushing changes to the server, it is safe to pull once:
161 </p>
162 <pre>
163 $ hg pull
164 $ hg push
165 </pre>
166 <p>
167 Done, your changes, code or corrections are now on the server.
168 </p>
169 <h4>Updating a local wok</h4>
170 <p>
171 To update your wok with the local server (<em>pull</em> to pull the changes):
172 </p>
173 <pre>
174 $ hg pull
175 $ hg update
176 </pre>
177 <h4>Useful commands</h4>
178 <p>
179 Hg commands that can be used.
180 </p>
181 <ul>
182 <li><code>hg help</code> : Display the full list of commands.</li>
183 <li><code>hg rollback</code> : Undo the last action performed (commit,
184 pull, push).</li>
185 <li><code>hg log <package></code> : Display a package log.</li>
186 <li><code>hg head</code> : Display the last log.</li>
187 </ul>
189 <a name="pkgs"></a>
190 <h3>Tazpkg Packages</h3>
191 <p>
192 The tazpkg packages in SliTaz are automatically created via Tazwok and a
193 receipt in the wok. The Cookbook describes the
194 <a href="../doc/cookbook/wok-tools.html">use of tools</a>
195 and the format of <a href="../doc/cookbook/receipts.html">receipts</a>.
196 These are required reading before we begin.
197 </p>
198 <p>
199 In terms of choice of package, the idea is to offer a package by task or
200 functionality, ie. the lightest application in the field and not duplicated.
201 Note that the current packages are not immutable, if you find an alternative
202 that is lighter, with more features or more <em>sexy</em> for a few extra KB,
203 you can suggest it on the Mailing List. Particular attention is given to
204 packages for the LiveCD, these should be stripped, removing unnecesary
205 dependancies and compiler options. In general candidate packages for the core
206 LiveCD are discussed on the Mailing List.
207 </p>
208 <p>
209 Before you begin to compile and create packages for SliTaz, be sure that the
210 work doesn't already exist in the wok undigest provided by the primary SliTaz
211 mirror. Don't forget that the members of the list are there to help you
212 and that the documentation of the
213 <a href="../doc/cookbook/wok-tools.html">wok and tools</a>
214 exists to help you get started.
215 </p>
217 <a name="website"></a>
218 <h3>Website Management and Books</h3>
219 <p>
220 The website and books (Handbook and Cookbook) are managed via
221 a mercurial repository, they can be cloned by:
222 </p>
223 <pre>
224 $ hg clone http://hg.slitaz.org/website
225 Or if you have the proper permissions:
226 $ hg clone http://repos.slitaz.org/website
227 </pre>
229 <h4>Diff and patch</h4>
230 <p>
231 The utilities <code>diff</code> and <code>patch</code> are command-line tools
232 for creating and implementing a file containing differences between two files.
233 This technique is often used for collaboration and the changes made to the
234 original file can be clearly extracted. To create a <code>diff</code> file
235 readable by humans in a simple text editor, you must supply the <code>-u</code> option:
236 </p>
237 <pre>
238 $ diff -u file.orig file.new > file.diff
239 </pre>
240 <p>
241 To apply a patch:
242 </p>
243 <pre>
244 $ patch file.orig file.diff
245 </pre>
247 <!-- End of content with round corner -->
248 </div>
249 <div id="content_bottom">
250 <div class="bottom_left"></div>
251 <div class="bottom_right"></div>
252 </div>
254 <!-- Start of footer and copy notice -->
255 <div id="copy">
256 <p>
257 Last modification : 2008-07-16 21:45:00 -
258 <a href="#top">Top of the page</a>
259 </p>
260 <p>
261 Copyright © 2009 <a href="http://www.slitaz.org/">SliTaz</a> -
262 <a href="http://www.gnu.org/licenses/gpl.html">GNU General Public License</a>
263 </p>
264 <!-- End of copy -->
265 </div>
267 <!-- Bottom and logo's -->
268 <div id="bottom">
269 <p>
270 <a href="http://validator.w3.org/check?uri=referer"><img
271 src="../../pics/website/xhtml10.png" alt="Valid XHTML 1.0"
272 title="Code validé XHTML 1.0"
273 style="width: 80px; height: 15px;" /></a>
274 </p>
275 </div>
277 </body>
278 </html>