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