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