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