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