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

Added Fonts to Handbook (en) and typos
author Paul Issot <paul@slitaz.org>
date Wed Apr 09 21:58:38 2008 +0000 (2008-04-09)
parents fc69ec3c3b99
children ec780b182951
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-03-25 23:30: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 </head>
18 <body bgcolor="#ffffff">
19 <!-- Header -->
20 <div id="header">
21 <a name="top"></a>
22 <!-- Access -->
23 <div id="access">
24 <a href="#content" title="Page content">Content</a> |
25 <a href="../../devel/" title="A propos de SliTaz en français">Français</a>
26 </div>
27 <a href="http://www.slitaz.org/en/"><img id="logo"
28 src="../../pics/website/logo.png" title="www.slitaz.org/en" alt="www.slitaz.org"
29 style="border: 0px solid ; width: 200px; height: 74px;" /></a>
30 <p id="titre">#!/GNU/Linux</p>
31 </div>
32 <div id="nav">
33 <div id="nav_top"></div>
34 <ul>
35 <li><a href="../about/" title="Informations about the SliTaz project">About the project</a></li>
36 <li><a href="../get/" title="Download - LiveCD ISO">Get SliTaz</a></li>
37 <li><a href="../doc/" title="LiveCD usage and howto">Documentation</a></li>
38 <li><a href="../packages/" title="Packaged software">Packages</a></li>
39 <li><a href="../mailing-list.html" title="Support, contact and collaboration">Mailing List</a></li>
40 <li><a href="../devel/" title="Developer corner">Developement</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 <li><a href="http://forum.slitaz.org/#idx2" title="English support forum">Forum</a></li>
45 </ul>
46 <div id="nav_bottom">
47 <div id="nav_bottom_img"></div>
48 </div>
49 </div>
50
51 <!-- Content top. -->
52 <div id="content_top">
53 <div class="top_left"></div>
54 <div class="top_right"></div>
55 </div>
56
57 <!-- Content -->
58 <div id="content">
59 <a name="content"></a>
60
61 <h1><font color="#3e1220">Developement</font></h1>
62 <h2><font color="#df8f06">SliTaz Developers corner</font></h2>
63
64 <ul>
65 <li><a href="#repos">Mercurial repositories.</a></li>
66 <li><a href="#pkgs">Tazpkg packages.</a></li>
67 <li><a href="#website">Website Management.</a></li>
68 </ul>
69
70 <p>
71 SliTaz is an open source and community driven distribution. Everyone is welcome
72 to join and contribute, from users, to hackers and developers there is always
73 something to do, ie. Proofreading or writing documentation, sending bugs or
74 patches to the Mailing list, gaining access to the wok and pushing some new
75 packages or simply to help others on the Mailing list or forum. SliTaz has got
76 Mercurial repositories hosted on a SliTaz system, developers can ask for a new
77 repo if needed and contributors have write access to correct typos, scripts, etc.
78 </p>
79
80 <p>
81 SliTaz is a tiny community and listens to it's users. There are several
82 developers who are active on the <a href="http://forum.slitaz.org/">forum</a>
83 and the <a href="../mailing-list.html">Mailing List</a>.
84 </p>
85
86 <a name="repos"></a>
87 <h3>Mercurial repositories</h3>
88 <p>
89 SliTaz Mercurial or Hg repos can be browsed or cloned by anyone using the URL:
90 <a href="http://hg.slitaz.org/">http://hg.slitaz.org/</a>. People with write
91 access can directly use <code>repos.slitaz.org</code> which needs authentication.
92 Mercurial uses Python and is installable with:
93 <code>tazpkg get-install mercurial</code>
94 </p>
95 <h4>~/.hgrc</h4>
96 <p>
97 Before you push your first commit onto the server, be sure you have a correct
98 Hg configuration file with your name and email address and remember to check
99 that you are not root. Personal ~/.hgrc file example:
100 </p>
101 <pre class="script">
102 [ui]
103 username = Name FirstName &lt;you@example.org&gt;
104 </pre>
105 <h4>Clone, modify, commit and push</h4>
106 <p>
107 Clone a repo, example for slitaz-doc:
108 </p>
109 <pre>
110 $ hg clone http://repos.slitaz.org/slitaz-doc
111 </pre>
112 <p>
113 Change directory to slitaz-doc, note you must be in the repository to be able
114 to use 'hg' commands. To check all logs or just the last log:
115 </p>
116 <pre>
117 $ hg log
118 $ hg head
119 </pre>
120 <p>
121 Modify one or more files and commit:
122 </p>
123 <pre>
124 $ hg status
125 $ hg commit -m "Log message..."
126 $ hg log
127 </pre>
128 <p>
129 Note that you can use the command <code>rollback</code> to roll back to the last
130 transaction. Before pushing changes to the server it is safe to pull once:
131 </p>
132 <pre>
133 $ hg pull
134 $ hg push
135 </pre>
136 <p>
137 Done, your changes, code or corrections are now on the server.
138 </p>
139
140 <a name="pkgs"></a>
141 <h3>Tazpkg Packages</h3>
142 <p>
143 The packages tazpkg in SliTaz are automatically created via Tazwok and a
144 receipt in the wok, the Cookbook describes the
145 <a href="http://www.slitaz.org/doc/cookbook/wok-tools.html">use of tools (fr)</a>
146 and the format <a href="http://www.slitaz.org/doc/cookbook/receipts.html">receipts (fr)</a>,
147 These are required reading before we begin.
148 </p>
149 <p>
150 In terms of choice of package, the idea is to offer a package by task or
151 functionality, ie. the lightest application in the field and not duplicated.
152 Note that the current packages are not immutable, if you find an alternative
153 that is lighter, with more features or more <em>sexy</em> for a few extra KB,
154 you can suggest it on the Mailing List. Particular attention is given to
155 packages for the LiveCD; these should be stripped, removing unnecesary
156 dependancies and compiler options. In general candidate packages for the core
157 LiveCD are discussed on the Mailing List.
158 </p>
159 <p>
160 Before you begin to compile and create packages for SliTaz, be sure that the
161 work doesn't already exist in the wok indigest provided by the primary SliTaz
162 mirror. Don't forget that the members of the list are there to help you
163 and that the documentation of the
164 <a href="http://www.slitaz.org/doc/cookbook/wok-tools.html">wok and tools (fr)</a>
165 exists to help you get started.
166 </p>
167
168 <a name="website"></a>
169 <h3>Website Management and Books</h3>
170 <p>
171 The management of the website and books (Handbook &amp; Cookbook) is made via
172 a rsync module, Mercurial, diff and patch utilities and the Mailing List.
173 Rsync is a tool for incremental backup; using an ultra-fast algorithm, It can
174 transfer or syncronize data both locally or over the network. The
175 <code>diff</code> utility is used to send the list of files containing only
176 the changes and <code>patch</code> to apply the changes to the original pages.
177 </p>
178 <p>
179 You can syncronize the site and books graphically using Grsync or via the
180 command line. To download the site for the first time or syncronize the pages
181 in the directory <code>/home/hacker/Public/slitaz/website</code>,
182 use the module <code>rsync://slitaz.org/website</code>:
183 </p>
184 <pre>
185 $ rsync -r -t -p -v \
186 --progress --delete \
187 rsync://slitaz.org/website /home/hacker/Public/slitaz/website
188 </pre>
189 <h4>Diff and patch</h4>
190 <p>
191 The utilities <code>diff</code> and <code>patch</code> are command-line tools
192 for creating and implementing the differences between two files. This technique
193 is often used for collaboration and the changes made to the original file can
194 be clearly extracted. To create a <code>diff</code> file readable by humans in
195 a simple text editor, you must supply the <code>-u</code> option:
196 </p>
197 <pre>
198 $ diff -u file.orig file.new &gt; file.diff
199 </pre>
200 <p>
201 To apply a patch:
202 </p>
203 <pre>
204 $ patch file.orig file.diff
205 </pre>
206
207 <!-- End of content with round corner -->
208 </div>
209 <div id="content_bottom">
210 <div class="bottom_left"></div>
211 <div class="bottom_right"></div>
212 </div>
213
214 <!-- Start of footer and copy notice -->
215 <div id="copy">
216 <p>
217 Last modification : 2008-03-25 23:30:00 -
218 <a href="#top">Top of the page</a>
219 </p>
220 <p>
221 Copyright &copy; 2008 <a href="http://www.slitaz.org/">SliTaz</a> -
222 <a href="http://www.gnu.org/licenses/gpl.html">GNU General Public License</a>
223 </p>
224 <!-- End of copy -->
225 </div>
226
227 <!-- Bottom and logo's -->
228 <div id="bottom">
229 <p>
230 <a href="http://validator.w3.org/check?uri=referer"><img
231 src="../../pics/website/xhtml10.png" alt="Valid XHTML 1.0"
232 title="Code validé XHTML 1.0"
233 style="width: 80px; height: 15px;" /></a>
234 </p>
235 </div>
236
237 </body>
238 </html>