[Pkg-voip-commits] r4965 - /README

[kilian at alioth.debian.org]

Author: kilian
Date: Sat Dec  1 11:49:35 2007
New Revision: 4965

URL: http://svn.debian.org/wsvn/pkg-voip/?sc=1&rev=4965
Log:
minor Update. Explain a bit more verbosely the debian/changelog conventions and
explain use of debrelease with DEFAULT_DEBRELEASE_DEBS_DIR.

Modified:
    README

Modified: README
URL: http://svn.debian.org/wsvn/pkg-voip/README?rev=4965&op=diff
==============================================================================
--- README (original)
+++ README Sat Dec  1 11:49:35 2007
@@ -119,6 +119,7 @@
 DEBUILD_DPKG_BUILDPACKAGE_OPTS="-us -uc"
 DEBUILD_LINTIAN=yes
 DEBUILD_LINDA=yes
+DEFAULT_DEBRELEASE_DEBS_DIR=../build-area/
 EOF
 
 cat >> ~/.svn-buildpackage.conf <<EOF
@@ -130,6 +131,23 @@
 
 to make using "dch" just do the RightThing(TM).
 
+Common conventions for debian/changelog are:
+* "New upstream release" goes on top without having the Changed-By name
+  refering to it.
+* "NOT YET RELEASED" doesn't need to be added no more since "svn-noautodch" and
+  "DEBCHANGE_RELEASE_HEURISTIC=changelog"
+* distribution needs to be UNRELEASED for all pending patches and one of
+  unstable, proposed-updates, testing-proposed-updates etc. for uploaded
+  packages. 
+* Grouping of Changed-By is largely apprechiated. If there is only one editor,
+  the preamble with the name should be removed if it was added accidentially.
+  (use DEBCHANGE_MULTIMAINT_MERGE=yes will help a lot here)
+* Try to be verbose about what the change is and prefer "debcommit" to not have
+  different wordings for the same action. If SVN log and changelog match as
+  close as possible, it's easier to spot a change.
+* when releasing, use the text "Releasing $SOURCE ($VERSION) to $DIST." as SVN
+  commit message to make finding these updates more easy (and eventually allow
+  for a hold-back through IRC).
 
 4. Tarballs and Build-area directories
 --------------------------------------
@@ -138,17 +156,20 @@
 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-voip svn root. This is to faciliate the building of subsequent
+under the pkg-voip 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.
 
+With DEFAULT_DEBRELEASE_DEBS_DIR pointing to ../build-area you can just use the
+"debrelease" command from the trunk/ directory after running svn-buildpackage
+--svn-tag.
 
 5. Using svn-inject
 -------------------
-To inject a new package into the Debian VoIP svn archive you should use svn-inject(1)
+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-voip/
@@ -181,7 +202,7 @@
 for certain dists (like Debian sarge) which need certain adjustments to the
 source like altered Build-Depends. This hook is a plain shell script (or
 makefile like debian/rules) which needs to be put in the debian/backports
-directory and made executable by means of the svn properties set. The codenames
+directory and made executable by means of the SVN properties set. The codenames
 for the current dists are: sid, etch, sarge, edgy and dapper. For an example
 see asterisk-addons/trunk/debian/backports/sarge which may be more illustrating
 what to do.