website annotate en/devel/forge.php @ rev 923

en: news/* moved to PHP all en/* is now using PHP
author Christophe Lincoln <pankso@slitaz.org>
date Mon Mar 12 00:20:18 2012 +0100 (2012-03-12)
parents fc144258f2b7
children c2f9d5d0f314
rev   line source
pankso@830 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
pankso@830 2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
pankso@830 3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
pankso@830 4 <head>
pankso@830 5 <title>SliTaz - Forge (en)</title>
pankso@830 6 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
pankso@830 7 <meta name="description" content="slitaz developers forge" />
pankso@830 8 <meta name="keywords" lang="en" content="slitaz, devel, hg, bugs" />
pankso@830 9 <meta name="robots" content="index, follow, all" />
pankso@830 10 <meta name="modified" content="<?php echo (date( "Y-m-d H:i:s", getlastmod())); ?>" />
pankso@830 11 <meta name="author" content="Christophe Lincoln"/>
pankso@830 12 <link rel="shortcut icon" href="../../favicon.ico" />
pankso@830 13 <link rel="stylesheet" type="text/css" href="../../slitaz.css" />
pankso@830 14 </head>
pankso@830 15 <body>
pankso@830 16
pankso@922 17 <?php include("../../lib/html/header.html"); ?>
pankso@830 18
pankso@830 19 <!-- Block -->
pankso@830 20 <div id="block">
pankso@922 21 <?php include("../../lib/html/nav.en.html"); ?>
pankso@830 22 <!-- Information/image -->
pankso@830 23 <div id="block_info">
pankso@830 24 <h4>Forge</h4>
pankso@830 25 <p>
paul@833 26 Misc tools, guidelines and services used to create and build SliTaz.
pankso@830 27 </p>
pankso@830 28 <p>
pankso@830 29 <img src="../../images/users.png" alt="users.png" />
pankso@830 30 <a href="http://scn.slitaz.org/">Join us on SCN</a> and
pankso@920 31 the <a href="../mailing-list.php">mailing list</a>
pankso@830 32 </p>
pankso@830 33 </div>
pankso@830 34 </div>
pankso@830 35
pankso@830 36 <!-- Content -->
pankso@830 37 <div id="content">
pankso@830 38
pankso@830 39 <h2>Collaborative management</h2>
pankso@830 40
pankso@830 41 <ul>
pankso@830 42 <li><a href="#kiss">KISS and comply to standards.</a></li>
pankso@830 43 <li><a href="#tank">Build host &amp; home.</a></li>
pankso@830 44 <li><a href="#repos">Mercurial repositories.</a></li>
pankso@830 45 <li><a href="#gui">GUI in GTK and CGI/web</a></li>
pankso@830 46 <li><a href="#iconv">Implementation of iconv().</a></li>
pankso@923 47 <li><a href="#pkgs">Building SliTaz packages.</a></li>
pankso@830 48 <li><a href="#website">Website Management.</a></li>
pankso@830 49 </ul>
pankso@830 50
pankso@830 51 <a name="kiss"></a>
pankso@830 52 <h2>KISS and comply to standards</h2>
pankso@830 53 <p>
pankso@830 54 Keep it simple: follow the best standards, carefully draft and write
pankso@830 55 high quality documentation, provide a stable and robust system and keep
pankso@830 56 the <em>rootfs</em> on the LiveCD light enough to run on machines with at
pankso@830 57 least 128 MB RAM. It's also possible to use GTK+2, Dialog, SHell scripts,
pankso@830 58 or PHP coding tools on the distribution. The idea is not to duplicate and
pankso@830 59 to think small...
pankso@830 60 </p>
pankso@830 61
pankso@830 62 <a name="tank"></a>
pankso@830 63 <h2>Tank - Build host &amp; home</h2>
pankso@830 64 <p>
pankso@830 65 Each contributor may have an account on the project server with secure
pankso@830 66 access, disk space, a public directory and all development tools.
pankso@830 67 Developers can compile packages and maintainers of the mirror can handle
pankso@830 68 sychronization. Tank also hosts the website, web boot and mercurial
pankso@830 69 repositories: <a href="http://tank.slitaz.org/">tank.slitaz.org</a>
pankso@830 70 </p>
pankso@830 71 <p>
pankso@830 72 Instructions on using the build host are described in the Cookbook:
pankso@830 73 <a href="http://doc.slitaz.org/en:cookbook:buildhost">
pankso@830 74 SliTaz Build Host (tank)</a>.
pankso@830 75 </p>
pankso@830 76
pankso@830 77 <a name="repos"></a>
pankso@830 78 <h2>Mercurial repositories</h2>
pankso@830 79 <p>
pankso@830 80 SliTaz Mercurial or Hg repos can be browsed or cloned by anyone using
pankso@830 81 the URL: <a href="http://hg.slitaz.org/">http://hg.slitaz.org/</a>. People
pankso@830 82 with write access can directly use <code>repos.slitaz.org</code> which
pankso@830 83 requires authentication. Mercurial uses Python and is installable with:
pankso@830 84 <code>tazpkg get-install mercurial</code>
pankso@830 85 </p>
pankso@830 86
pankso@830 87 <h3>~/.hgrc</h3>
pankso@830 88 <p>
pankso@830 89 Before you push your first commit onto the server, be sure that you have a
pankso@830 90 correct Hg configuration file with your name and email address, and remember
pankso@830 91 to check that you are not root. Personal ~/.hgrc file example:
pankso@830 92 </p>
pankso@830 93 <pre class="script">
pankso@830 94 [ui]
pankso@830 95 username = FirstName LastName &lt;you@example.org&gt;
pankso@830 96 </pre>
pankso@830 97 <h4>Clone, modify, commit and push</h4>
pankso@830 98 <p>
pankso@830 99 Clone a repo, example for wok:
pankso@830 100 </p>
pankso@830 101 <pre>
pankso@830 102 $ hg clone http://repos.slitaz.org/wok
pankso@830 103 </pre>
pankso@830 104 <p>
pankso@830 105 Change directory to wok, note you must be in the repository to be able
pankso@830 106 to use 'hg' commands. To check all logs or just the last log:
pankso@830 107 </p>
pankso@830 108 <pre>
pankso@830 109 $ hg log
pankso@830 110 $ hg head
pankso@830 111 </pre>
pankso@830 112 <p>
pankso@830 113 Add or modify one or more files and commit:
pankso@830 114 </p>
pankso@830 115 <pre>
pankso@830 116 $ hg add
pankso@830 117 $ hg status
pankso@830 118 $ hg commit -m "Log message..."
pankso@830 119 $ hg log
pankso@830 120 </pre>
pankso@830 121 <p>
pankso@830 122 Note that you can use the command <code>rollback</code> to roll back to the last
pankso@830 123 transaction. Before pushing changes to the server, it is safe to pull once:
pankso@830 124 </p>
pankso@830 125 <pre>
pankso@830 126 $ hg pull
pankso@830 127 $ hg push
pankso@830 128 </pre>
pankso@830 129 <p>
pankso@830 130 Done, your changes, code or corrections are now on the server.
pankso@830 131 </p>
pankso@830 132 <h4>Updating a local wok</h4>
pankso@830 133 <p>
pankso@830 134 To update your wok with the local server (<em>pull</em> to pull the changes):
pankso@830 135 </p>
pankso@830 136 <pre>
pankso@830 137 $ hg pull -u
pankso@830 138 </pre>
pankso@830 139 <h4>Useful commands</h4>
pankso@830 140 <p>
pankso@830 141 Hg commands that can be used.
pankso@830 142 </p>
pankso@830 143 <ul>
pankso@830 144 <li><code>hg help</code> : Display the full list of commands.</li>
pankso@830 145 <li><code>hg rollback</code> : Undo the last action performed (commit,
pankso@830 146 pull, push).</li>
pankso@830 147 <li><code>hg log &lt;package&gt;</code> : Display a package log.</li>
pankso@830 148 <li><code>hg head</code> : Display the last log.</li>
pankso@830 149 </ul>
pankso@830 150
pankso@830 151 <a name="gui"></a>
pankso@830 152 <h2>GUI - Pure C/GTK, Yad, Vala/Genie and CGI/web</h2>
pankso@830 153
pankso@830 154 <p>
paul@832 155 There are many ways to create user interfaces in the open source world. From
paul@832 156 the start of the project until 3.0 we mainly used a tool called Gtkdialog
paul@832 157 which let us create quite nice and complex interfaces in GTK, but using a
paul@832 158 scripting language that just run without having to be compiled. But gtkdialog is
paul@832 159 unmaintained and lacks many new GTK features, so we switched to Yad for simple GUI boxes.
paul@832 160 For all the administration, packages and configuration tools we switched to TazPanel,
paul@832 161 a CGI/web interface with a gui coded in xHTML 5 and CSS 3.
pankso@830 162 </p>
pankso@830 163 <p>
paul@832 164 Yad is very simple but doesn't allow us to create complex interfaces even if we
paul@832 165 only need 2 or 3 entries with labels and a few buttons, so another way
paul@832 166 must be found. The advantage of a scripting language is the fact that it doesn't need
paul@832 167 to be compiled and can be coded in realtime (but it produces slower applications).
paul@832 168 Writing tools in C is complex and gets less contributions since SHell scripts are easier
paul@832 169 to understand, so the guidelines are now to keep and continue to improve our
paul@832 170 cmdline tools and provide frontends in GTK or CGI/web.
pankso@830 171 </p>
pankso@830 172 <p>
paul@832 173 There are many new languages that use GTK such as Genie, Vala or GTKaml.
paul@832 174 But keep in mind that they are not as popular as C and GTK and not really
paul@832 175 easier to learn and use (for simple frontends you can use SHell
paul@832 176 scripts to perform tasks). You can use Vala but look at a pure
paul@832 177 GTK single window, it uses only 14 lines:
pankso@830 178 </p>
pankso@830 179 <pre>
paul@839 180 #include &lt;gtk/gtk.h&gt;
pankso@830 181
pankso@830 182 int main(int argc, char *argv[])
pankso@830 183 {
pankso@831 184 GtkWidget *window;
pankso@831 185
pankso@831 186 gtk_init(&amp;argc, &amp;argv);
pankso@831 187 window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
pankso@831 188 g_signal_connect (G_OBJECT (window), "destroy",
pankso@831 189 G_CALLBACK (gtk_main_quit), NULL);
pankso@831 190
pankso@831 191 gtk_widget_show(window);
pankso@831 192 gtk_main();
pankso@831 193 return 0;
pankso@830 194 }
pankso@830 195 </pre>
pankso@830 196 <p>
paul@832 197 If you are not sure about which language to use, discuss it on the mailing list.
pankso@830 198 If you just want a small GUI function, look at tazbox in the slitaz-tools
paul@832 199 repo, it has tiny desktop tools such as a logout box. The first
paul@832 200 SliTaz sub-project written in pure GTK is TazWeb and you can use it to learn
paul@832 201 ways to use system() to include system commands in your frontend. For
paul@832 202 example TazWeb uses wget for downloads and sed to add bookmarks.
pankso@830 203 </p>
pankso@830 204 <p>
pankso@830 205 Yad scripts should follow TazYad guidelines:
pankso@830 206 <a href="http://hg.slitaz.org/slitaz-dev-tools/raw-file/tip/tazyad/README">
pankso@830 207 README</a> and
pankso@830 208 <a href="http://hg.slitaz.org/slitaz-dev-tools/raw-file/tip/tazyad/tazyad">
paul@832 209 example code</a>
pankso@830 210 </p>
pankso@830 211
pankso@830 212 <a name="iconv"></a>
pankso@830 213 <h2>Implementation of iconv()</h2>
pankso@830 214 <p>
pankso@923 215 SliTaz uses iconv() provided by GNU glibc - any packages that offer
pankso@923 216 <code>libiconv</code> must use the library contained in <code>glibc-locale</code>.
pankso@923 217 There is therefore no longer a libiconv package (1.2 MB) in SliTaz.
pankso@830 218 </p>
pankso@830 219
pankso@830 220 <a name="pkgs"></a>
pankso@923 221 <h2>Building SliTaz packages</h2>
pankso@830 222 <p>
pankso@923 223 Building official is done with the Cookutils suite. The package is installed
pankso@923 224 on each SliTaz system as well as the documentation about using cook and
pankso@923 225 <a href="http://hg.slitaz.org/cookutils/raw-file/tip/doc/cookutils.en.html">creating SliTaz Packages</a> suitable fot TazPKG packages manager.
pankso@830 226 </p>
pankso@830 227 <p>
pankso@923 228 The tazpkg packages in SliTaz are automatically created via the
pankso@923 229 <a href="http://cook.slitaz.org/">Cooker</a> from Cookutils package
pankso@923 230 and a receipt in the wok. The Cookbook describes the format of
pankso@923 231 <a href="http://doc.slitaz.org/en:cookbook:receipt">receipts</a>.
pankso@923 232 Cook and receipt documentation are required reading before we begin.
pankso@830 233 </p>
pankso@830 234 <p>
pankso@923 235 In terms of choice of package, the idea is to offer a package by task or
pankso@923 236 functionality, ie. the lightest application in the field and not duplicated.
pankso@923 237 Note that the current packages are not immutable, if you find an alternative
pankso@923 238 that is lighter, with more features or more <em>sexy</em> for a few extra KB,
pankso@923 239 you can suggest it on the Mailing List. Particular attention is given to
pankso@923 240 packages for the LiveCD, these should be stripped, removing unnecesary
pankso@923 241 dependencies and compiler options. In general candidate packages for the core
pankso@923 242 LiveCD are discussed on the Mailing List.
pankso@923 243 </p>
pankso@923 244 <p>
pankso@923 245 Before you begin to compile and create packages for SliTaz, be sure that the
pankso@923 246 work doesn't already exist in the
pankso@923 247 <a href="http://download.tuxfamily.org/slitaz/packages/undigest/">undigest</a>
pankso@923 248 wok provided by the primary SliTaz mirror. Don't forget that the members
pankso@923 249 of the list are there to help you and that the documentation of the
pankso@923 250 <a href="http://doc.slitaz.org/en:cookbook:wok">wok and tools</a>
pankso@923 251 exists to help you get started.
pankso@830 252 </p>
pankso@830 253
pankso@830 254 <a name="pkgs-naming"></a>
pankso@830 255 <h3>Naming of packages</h3>
pankso@830 256 <p>
pankso@923 257 In most cases the package name is the same as the source, except for
pankso@923 258 Python, Perl, PHP, Ruby and Lua modules. For example, the package
pankso@923 259 providing a Kid template system written in Python and XML is named:
pankso@923 260 <code>python-kid</code>.
pankso@830 261 </p>
pankso@830 262
pankso@830 263 <a name="website"></a>
pankso@830 264 <h2>Website Management</h2>
pankso@830 265 <p>
pankso@830 266 The website is managed via a mercurial repository, they can be cloned by:
pankso@830 267 </p>
pankso@830 268 <pre>
pankso@830 269 $ hg clone http://hg.slitaz.org/website
pankso@830 270 Or if you have the proper permissions:
pankso@830 271 $ hg clone http://repos.slitaz.org/website
pankso@830 272 </pre>
pankso@830 273
pankso@830 274 <h3>xHTML coding style</h3>
pankso@830 275 <p>
pankso@923 276 The pages and different <em>books</em> are coded in xHTML 1.0
pankso@923 277 transitional. The title of level 1 is used only once (at the top),
pankso@923 278 level 2 is the title of the document and levels 3 and 4 are then used for
pankso@923 279 the subtitles. If a list is used instead using smart anchors;
pankso@923 280 then that starts at the top, just after the title of level 2.
pankso@923 281 Paragraphs are contained in the tags <code>&lt;p&gt;&lt;/p&gt;</code>.
pankso@923 282 For indentation, we use tabs - the reason being semantics and to take
pankso@923 283 up less space in terms of octets (bytes). To put code, like the name of
pankso@923 284 a command inside a paragraph: <code>&lt;code&gt;</code> is the preferred
pankso@923 285 method. To view commands or to utilize a terminal, the web pages use
pankso@923 286 <code>&lt;pre&gt;</code> to display the formatted text. Example:
pankso@830 287 </p>
pankso@830 288 <pre>
pankso@830 289 $ command
pankso@830 290 </pre>
pankso@830 291 <p>
pankso@923 292 To view text that can be copied and pasted, such as scripts,
pankso@923 293 bits of code, sample configuration files, etc - we also use
pankso@923 294 <code>&lt;pre&gt;</code>, but with a CSS class named "script". Example:
pankso@830 295 </p>
pankso@830 296 <pre class="script">
pankso@830 297 &lt;pre class="script"&gt;
pankso@830 298
pankso@830 299 code...
pankso@830 300
pankso@830 301 &lt;/pre&gt;
pankso@830 302 </pre>
pankso@830 303 <p>
pankso@923 304 The <em>emphasized</em> words put themselves in the tag <code>&lt;em&gt;</code>
pankso@923 305 and internal links are relative. Remember to check the validity
pankso@923 306 of the code via the online <em>validator</em> of the W3C.
pankso@830 307 </p>
pankso@830 308
pankso@830 309 <a name="diff"></a>
pankso@830 310 <h2>Diff and patch</h2>
pankso@830 311 <p>
pankso@923 312 The utilities <code>diff</code> and <code>patch</code> are command-line tools
pankso@923 313 for creating and implementing a file containing differences between two files.
pankso@923 314 This technique is often used for collaboration and the changes made to the
pankso@923 315 original file can be clearly extracted. To create a <code>diff</code> file
pankso@923 316 readable by humans in a simple text editor, you must supply the <code>-u</code> option:
pankso@830 317 </p>
pankso@830 318 <pre>
pankso@830 319 $ diff -u file.orig file.new &gt; file.diff
pankso@830 320 </pre>
pankso@830 321 <p>
pankso@830 322 To apply a patch:
pankso@830 323 </p>
pankso@830 324 <pre>
pankso@830 325 $ patch file.orig file.diff
pankso@830 326 </pre>
pankso@830 327
pankso@830 328 <!-- End of content -->
pankso@830 329 </div>
pankso@830 330
pankso@922 331 <?php include("../../lib/html/footer.html"); ?>
pankso@830 332
pankso@830 333 </body>
pankso@830 334 </html>