site/src/devel.xml

   1 <title>Getting started with adesklets code repository</title>
   2
   3 <item title="The basis">
   4
   5 <p>If you want to start hacking on adesklets code base, or if you are
   6 a hardcore user seeking the latest revision, this page is just for
   7 you.</p>
   8
   9 <p>The latest changes to the adesklets code base (and website) are
  10 publicly available at all time from the <a
  11 href="http://repo.or.cz/w/adesklets.git">online code
  12 repository</a>. The web interface gives you a simple way to track,
  13 analyse and eventually generate on-the-fly patches against
  14 pre-packaged releases.</p>
  15
  16 <p>You can get (development) help and share ideas on the <a
  17 href="https://lists.sourceforge.net/lists/listinfo/adesklets-devel">adesklets-devel
  18 mailing list</a>, or <a
  19 href="http://adesklets.sourceforge.net/doc/en/Open-PGP-Public-Key.html#Open-PGP-Public-Key">directly
  20 by email with the adesklets maintainer</a> if you feel more like
  21 it.</p>
  22
  23 <h2>Grabbing the code (cloning the repository)</h2>
  24 <p>If you have more needs (or are just especially curious!), the next thing to
  25 do would be to grab the latest version of the code, using <a
  26 href="http://git.or.cz/">git</a> and its companion software <a
  27 href="http://www.kernel.org/pub/software/scm/cogito/docs/">cogito</a>. It can
  28 be performed anonymously from the command line:</p>
  29 <p><strong>cg clone git://repo.or.cz/adesklets.git</strong></p>
  30 <p>Once done, you should have a bare-bone version of the latest source
  31 code at your disposal under <em>./adesklets</em>. Later on, you can
  32 just update it by fetching and locally merging the latest changes,
  33 which will be a lot faster:</p>
  34
  35 <p><strong>cg fetch &amp;&amp; cg merge</strong></p>
  36
  37
  38 <h2>Building the code from your cloned repository</h2>
  39
  40 <p>For successfully building adesklets from the repository, you will need some
  41 packages in addition of what is listed in the <em>INSTALL</em> document:
  42 basically, you will need most of the GNU autotools (automake, autoconf) as well
  43 as GNU Make, flex, bison, help2man and makeinfo -- any version of these software
  44 packages published in the last two or three years should do. Then, do
  45 invoke:</p>
  46 <p><strong>./autogen.sh</strong></p>
  47
  48 <p>And you should be in business; <strong>make sure to follow any
  49 direction given by this last script</strong>. Finally, be also aware
  50 that a few of the distribution-specific targets are less portable
  51 (some display a GNU bias), since they were not intended to be used "at
  52 large", but only by maintainers and similarly programming-inclined
  53 people.</p>
  54
  55 <h2>Sharing your changes</h2>
  56
  57 <p>Of course, you can use any method you like for sharing your
  58 modifications to the adesklets code base: for instance, generating
  59 patches from your cloned repository with command <strong>cg
  60 diff</strong>, then posting them online or on <a
  61 href="https://lists.sourceforge.net/lists/listinfo/adesklets-devel">adesklets-devel</a>
  62 would be perfectly fine. Nevertheless, be aware there is a more
  63 powerful solution at your disposal.</p>
  64
  65 <p>adesklets public git repository accepts anonymous push into a
  66 special branch called "<em>mob</em>". A special keyless, password-less
  67 user, also called <em>mob</em>, can push changes into it. You just
  68 have to set up the remote branch:</p>
  69
  70 <p><strong>cg branch-add mob
  71 git+ssh://mob@repo.or.cz/srv/git/adesklets.git#mob</strong></p>
  72
  73 <p>Then you are ready to push there (<strong>cg push</strong>): you
  74 are making the history! It is nevertheless a good idea to bring your
  75 changes to the attention of <a
  76 href="https://lists.sourceforge.net/lists/listinfo/adesklets-devel">adesklets-devel</a>
  77 or <a
  78 href="http://adesklets.sourceforge.net/doc/en/Open-PGP-Public-Key.html#Open-PGP-Public-Key">the
  79 maintainer</a>, so that people can review your work and eventually
  80 commit it into the master branch.</p>
  81
  82 </item>