Document use of dquilt in debian/README.source

Add link to Debian's wiki and short snippets with setup instrunctions

Change-Id: I306723034c7f215f5244e9b3eacfaaa5c2aa4388
Signed-off-by: Luca Boccassi <luca.boccassi@gmail.com>

diff --git a/debian/README.source b/debian/README.source
new file mode 100644 (file)
index 0000000..1d9ecea
--- /dev/null
+++ b/debian/README.source
@@ -0,0 +1,28 @@
+quilt patches format
+
+Note that we use the dquilt format for patches as outlined on Debian's wiki:
+https://www.debian.org/doc/manuals/maint-guide/modify.en.html#quiltrc
+
+Please consider using the same format to avoid excessive churn when adding or
+refreshing patches.
+
+Add the following to your ~/.bashrc (or equivalent):
+
+alias dquilt="quilt --quiltrc=${HOME}/.quiltrc-dpkg"
+complete -F _quilt_completion $_quilt_complete_opt dquilt
+
+And then create a new ~/.quiltrc-dpkg file with content:
+
+d=. ; while [ ! -d $d/debian -a `readlink -e $d` != / ]; do d=$d/..; done
+if [ -d $d/debian ] && [ -z $QUILT_PATCHES ]; then
+    # if in Debian packaging tree with unset $QUILT_PATCHES
+    QUILT_PATCHES="debian/patches"
+    QUILT_PATCH_OPTS="--reject-format=unified"
+    QUILT_DIFF_ARGS="-p ab --no-timestamps --no-index --color=auto"
+    QUILT_REFRESH_ARGS="-p ab --no-timestamps --no-index"
+    QUILT_COLORS="diff_hdr=1;32:diff_add=1;34:diff_rem=1;31:diff_hunk=1;33:diff_ctx=35:diff_cctx=33"
+    if ! [ -d $d/debian/patches ]; then mkdir $d/debian/patches; fi
+fi
+
+Open a new terminal or souce ~/.bashrc, and then you will be able to use
+dquilt.

diff --git a/debian/changelog b/debian/changelog
index 3e0ae32..6b33f9d 100644 (file)
--- a/debian/changelog
+++ b/debian/changelog
@@ -5,6 +5,7 @@ dpdk (16.07-rc5-1) UNRELEASED; urgency=medium
 
   [ Luca Boccassi ]
   * Generate pkgconfig and ship it in libdpdk-dev
+  * Document use of dquilt for patches in debian/README.source
 
  -- Ricardo Salveti de Araujo <rsalveti@rsalveti.net>  Tue, 26 Jul 2016 14:13:38 -0300