[Extras-cauldron-commits] r12 - trunk/buildme

[mishas at garage.maemo.org]

Author: mishas
Date: 2008-03-30 12:34:23 +0300 (Sun, 30 Mar 2008)
New Revision: 12

Modified:
   trunk/buildme/HOWTO
Log:
added a few bits to make HOWTO a proper ReST file :)

Modified: trunk/buildme/HOWTO
===================================================================
--- trunk/buildme/HOWTO	2008-03-30 09:28:28 UTC (rev 11)
+++ trunk/buildme/HOWTO	2008-03-30 09:34:23 UTC (rev 12)
@@ -1,7 +1,14 @@
+===================================
 Builder for Maemo Extras (buildME).
-------------------------------------
+===================================
 
+:Author: Ed Bartosh
+:Version: $Revision$
+
+.. contents::
+
 1. What is it?
+==============
 
 It's automatic package building system for Maemo Extras repository based on
 sbdmock package builder[1].
@@ -17,11 +24,14 @@
  * detailed logs can be found in results directory
 
 2. How to prepare and upload source packages for build?
+=======================================================
 
-Source package can be produced using this command[2]:
+Source package can be produced using this command[2]::
+
     dpkg-buildpackage -rfakeroot -sa -S
 
-and signed with[3]:
+and signed with[3]::
+
     debsign -k<key_id> <package>.changes
 
 Uploading source packages for builder is similar to uploading to extras and
@@ -29,7 +39,7 @@
 building uploader must have upload rights to extras repository.
 
 To upload sources to for build uploader should have the following section in
-/etc/dput.cf[5]
+/etc/dput.cf[5]::
 
     [chinook-extras-builder]
     login = <your_garage_login_name>
@@ -39,16 +49,19 @@
     allow_unsigned_uploads = 0
     incoming = /var/www/extras-devel/incoming-builder/chinook
 
-Uploading is done by:
+Uploading is done by::
+
     dput chinook-extras-builder *.changes
 
 NB: After a successful upload dput creates a .upload file.  If you try to
 upload the same set of files, dput will refuse to do that.  If you really want
 to upload it again (e.g. after uploading and have built a build dependency for
-a particular package), please use '-f' parameter:
+a particular package), please use '-f' parameter::
+
     dput -f chinook-extras-builder *.changes
 
 3. What happens when packages are uploaded?
+===========================================
 
 The builder picks up packages from the builder queue and produces binaries for
 all required architectures.  Architectures are determined by 'Architecture:'
@@ -61,15 +74,18 @@
 build dependencies specified in package's control file will be installed into
 target before build.  Sbdmock uses packages from SDK and extras-devel repositories
 to satisfy build dependencies.  Build is done using dpkg-buildpackage. Builder
-produces 2 logs:
+produces 2 logs::
+
     root.log  -- information about setting up build target
     build.log -- information about the actual build operation
 
 4. What to expect as a result
+=============================
 
 When build is complete, status information is sent to the 'builds' mailing list[6].
 
-Build results are available in results directory:
+Build results are available in results directory::
+
     https://garage.maemo.org/builder/chinook/<package name and version>/
 
 Content of this directory depends on the build status.  For successful builds
@@ -85,6 +101,7 @@
 uploaded to extras-devel repository.
 
 5. References
+=============
 
 [1] Scratchbox Debian package builder tool: http://bifh.org/wiki/sbdmock
 [2] dpkg-buildpackage man page: http://www.penguin-soft.com/penguin/man/1/dpkg-source.html