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