[Pkg-allegro-commits] r28 - /

[Mark Purcell]

Author: msp
Date: 2006-09-12 22:13:41 +0000 (Tue, 12 Sep 2006)
New Revision: 28

Added:
   README
Log:
A sample README pulled from pkg-voip/ kde-extras which might make a useful starting point for managing pkg-allegro - comments welcome

Added: README
===================================================================
--- README	                        (rev 0)
+++ README	2006-09-12 22:13:41 UTC (rev 28)
@@ -0,0 +1,133 @@
+Debian VoIP Team
+-------------------
+
+1. Contacts
+------------
+
+We have two different lists. The only "human" list is the maintainers list. 
+The other has the only purpose of holding mails from SVN commits.
+
+General discussion mailing list: <pkg-allegro-maintainers at lists.alioth.debian.org>
+SVN commits only mailing list (moderated): <pkg-allegro-commits at lists.alioth.debian.org>
+
+
+2. Subversion repository
+------------------------
+  
+You can browse it only at:
+
+http://svn.debian.org/wsvn/pkg-allegro
+
+To "checkout" the repository use these commands:
+
+* If you want a read-only copy, use:
+
+  svn co svn://svn.alioth.debian.org/svn/pkg-allegro/
+
+* If you are a developer with an account in Alioth, you can also use:
+
+  svn co svn+ssh://${ALIOTH_USERNAME}@svn.debian.org/svn/pkg-allegro/
+
+Authorized SSH keys are controlled at https://alioth.debian.org/account/
+
+The repository layout is:
+
+- packagename/
+    - trunk/
+    - branches/
+    - tags/
+
+If only one version of the package is available at the time, development must 
+be made at trunk/ dir, copying the dir to tags/'pkg-version' each time a new 
+release is made.
+
+When, at some point, the need to have two different versions at the same time 
+arises (for example, if we need a version to be in unstable and a different one
+to be in experimental), experimental development will be made in trunk/ and 
+if a new unstable package needs to be cooked, copying tag/'latest_version_in_sid' 
+to tag/'latest_version_in_sid'+1 will make the trick.
+
+3. Using svn-buildpackage
+--------------------------
+
+Packages with an upstream tarball will require you to set the mergeWithUpstream
+property first (from the package root) so that svn-buildpackage will look for
+the .orig.tar.gz in the ../tarballs directory.
+	
+	% svn propset mergeWithUpstream 1 debian
+
+Please note that this only works for packages which have only the debian/
+directory committed. Consequently, you must use CDBS's simple-patchsys.mk or
+dpatch to modify the upstream sources.
+
+To download the *.orig.tar.gz to the ../tarballs directory, most of the
+pkg-allegro packages have a "get-orig-source" target in their debian/rules.
+Further, there is a "print-version" target to see what is the current upstream
+version, that's detected for download. You can run the get-orig-source directly
+from trunk/ or tags/$version/.
+
+After you have finished and committed your Debian patches via
+	
+	% svn commit [PACKAGE]
+
+as well as copying the orig.tar.gz to ../tarballs/ if necessary, you may build
+your package with the following commands:
+
+	% svn-buildpackage -rfakeroot
+
+You might want to add --svn-ignore-new to the flags if you do not want to
+commit before having finished your testbuild. Further, if you use debuild and
+edited /etc/devscripts.conf to use fakeroot by default, there is no need to add
+this to svn-buildpackage.
+
+Don't commit tarballs/ or build-area/ directories to SVN! They would be wasting
+loads of bandwith and there is no point.
+
+4. Tarballs and Build-area directories
+--------------------------------------
+
+You need to place those dirs in the parent directory of the one from which you're 
+running svn-buildpackage. Usually this means placing tarballs/ and build-area/ dirs 
+in 'pkgname'/ dir, at the same level as trunk/
+
+For the existing projects these are preset as symlinks to a central hierarchy
+under the pkg-allegro svn root. This is to faciliate the building of subsequent
+packages when having the full tree checked out.
+
+If you want to compile inside one version in tags/ dir, you'll need to place those
+dirs inside that dir. Also for most of the tags dirs there should be ready to
+use symlinks.
+
+5. Using svn-inject
+-------------------
+
+To inject a new package into the Debian VoIP svn archive you should use svn-inject(1)
+as follows:
+	
+	svn-inject -o <package>.dsc svn+ssh://${ALIOTH_USERNAME}@svn.debian.org/svn/pkg-allegro/
+
+Type in your alioth password a few hundred times :-) and your package should be 
+uploaded to the archive.  Note you will also need to manually copy the 
+package.orig.tar.gz to your tarballs directory.  The -o option is important as 
+this ensures that we 'Only keep modified files under SVN control'
+
+6. Versioning 
+-------------
+
+As the autobuilder and fellow developers will need to differentiate between
+versions that are uploaded into debian already and those which will be at a
+later point, do use the UNRELEASED distribution until the time you actually do
+upload to incoming. Whoever is not a DD himself should let the sponsor do that
+final step if that sponsor has SVN commit rights to the pkg-allegro archive.
+
+
+As the archive runs britney, it may well be that a built and installed package
+is not appearing to the archive until its reverse depends are (re)built too. In
+case of questions, feel free to mail kilian at debian.org.
+
+-(snip)-
+
+In case any of the above is unclear to you or seems outdated, please drop us a note to the maintainers list.
+
+Your
+Debian pkg-VoIP packaging team