website view en/devel/index.html @ rev 356

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