[Pkg-voip-commits] r5013 - /README

[paravoid at alioth.debian.org]

Author: paravoid
Date: Mon Dec  3 19:27:25 2007
New Revision: 5013

URL: http://svn.debian.org/wsvn/pkg-voip/?sc=1&rev=5013
Log:
Document the use of svn-do, dpatch and quilt.

Modified:
    README

Modified: README
URL: http://svn.debian.org/wsvn/pkg-voip/README?rev=5013&op=diff
==============================================================================
--- README (original)
+++ README Mon Dec  3 19:27:25 2007
@@ -10,7 +10,6 @@
 SVN commits only mailing list (moderated): <pkg-voip-commits at lists.alioth.debian.org>
 
 IRC: #debian-voip on irc.debian.org
-
 
 2. Subversion repository
 ------------------------
@@ -107,8 +106,18 @@
 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.
+svn-buildpackage provides svn-do, which you may find useful:
+	% /usr/share/svn-buildpackage/contrib/svn-do
+It executes svn-buildpackage --svn-export and enters that directory. After
+you change the tree as you like, exit the shell; your changes will be copied
+back to your working tree.
+Note, however, that it doesn't automatically "svn add" the new files that you
+may have created (e.g. debian/patches/foo); you'll have to do this manually.
+You may also want to edit the script and add --svn-ignore to the
+svn-buildpackage options.
+
+Don't commit tarballs/ or build-area/ directory contents to SVN! They would be
+wasting loads of bandwith and there is no point.
 
 What you may find useful is setting these two:
 -------------------------------------------------
@@ -184,8 +193,49 @@
 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 
+6. Patch management systems
+---------------------------
+Since all of our packages use mergeWithUpstream (we only keep debian/ in the
+repository) a patch management system should be used to make changes to
+upstream files.
+Most of the packages use dpatch, except a few that use quilt. The latter is
+recommended for big patchsets, even though it could be used for small ones, if
+the maintainer prefers it.
+
+6.1. dpatch
+~~~~~~~~~~~
+Using quilt is as easy as putting
+-------------------------------------------------
+	include /usr/share/dpatch/dpatch.make
+-------------------------------------------------
+to your debian/rules. This creates two new targets, "patch" and "unpatch"
+which may depended upon on configure and clean respectively.
+
+6.2. quilt
+~~~~~~~~~~
+Similarly, using quilt is as easy as putting
+-------------------------------------------------
+	include /usr/share/quilt/quilt.make
+-------------------------------------------------
+to your debian/rules. This creates two new targets, "patch" and "unpatch"
+which may depended upon on configure and clean respectively.
+
+It is recommended to use these settings so that you can move around on your
+series with quilt:
+-------------------------------------------------
+cat >> ~/.quiltrc <<EOF
+QUILT_PATCHES="debian/patches" 
+
+QUILT_PATCH_OPTS="--unified-reject-files" 
+QUILT_REFRESH_ARGS="-p ab --no-timestamps --no-index" 
+QUILT_DIFF_OPTS="--show-c-function"
+QUILT_DIFF_ARGS="-p ab --no-timestamps --no-index --color=auto"
+EOF
+
+-------------------------------------------------
+Consult quilt(1) for more information of what these options do.
+
+7. 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
@@ -201,7 +251,7 @@
 case of questions, feel free to mail kilian at debian.org.
 
 
-7. Automatic Backport hooks
+8. Automatic Backport hooks
 ---------------------------
 The checkout script for putting together the sources can run a backports hook
 for certain dists (like Debian sarge) which need certain adjustments to the
@@ -214,7 +264,8 @@
 
 -(snip)-
 
-In case any of the above is unclear to you or seems outdated, please drop us a note to the maintainers list.
+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