website annotate en/devel/index.html @ rev 166

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