[visualvm] 09/10: Added debian/README.source to document the workflow used with this package

[Emmanuel Bourg]

This is an automated email from the git hooks/post-receive script.

ebourg-guest pushed a commit to branch master
in repository visualvm.

commit 256e3976b3de473978719a7b13567ce9d0e0857d
Author: Emmanuel Bourg <ebourg at apache.org>
Date:   Wed Apr 30 19:04:19 2014 +0200

    Added debian/README.source to document the workflow used with this package
---
 debian/README.source | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 debian/changelog     |  1 +
 2 files changed, 65 insertions(+)

diff --git a/debian/README.source b/debian/README.source
new file mode 100644
index 0000000..23e489e
--- /dev/null
+++ b/debian/README.source
@@ -0,0 +1,64 @@
+Information about visualvm
+--------------------------
+
+visualvm is a composite source package. It consists in:
+
+- The build script maintained by the IcedTea project
+  (Mercurial repository: http://icedtea.classpath.org/hg/visualvm)
+
+- The source tarballs for VisualVM published at https://java.net/downloads/visualvm
+  * visualvm_xyz-src.tar.gz
+  * netbeans-profiler-visualvm_releaseXYZ.tar.gz
+
+
+Building a new version
+----------------------
+
+Here are the steps to create a new upstream tarball:
+
+1) Clone the IcedTea repository in a new directory:
+
+   hg clone http://icedtea.classpath.org/hg/visualvm
+
+2) Download the source tarballs:
+
+   cd visualvm
+   ./autogen.sh
+   ./configure
+   make download-visualvm
+   make download-netbeans-profiler
+
+3) Create the upstream tarball:
+
+   tar -cJf visualvm_z.y.z.orig.tar.xz --exclude '.hg*' visualvm
+
+4) Update the constants in debian/rules.
+
+5) Adjust the version of the NetBeans platform used
+   (there are references in debian/control and debian/jvisualvm.sh)
+
+
+Applying patches
+----------------
+
+quilt can't be used in the usual way since the source files are packed
+in an archive. Patches can be applied by enabling 01-inject-patches.patch.
+This patch will hook into the IcedTea makefile and apply a quilt series after
+extracting the source files. The patch have to be declared in
+debian/patches/series.netbeans-profiler.
+
+To create or modify patch you have to:
+
+1) Build the package once to extract the source files
+
+2) Use quilt by prefixing the command with:
+
+     QUILT_SERIES=debian/patches/series.netbeans-profiler
+
+   For example:
+
+     QUILT_SERIES=debian/patches/series.netbeans-profiler quilt new 03-fix-another-issue.patch
+     QUILT_SERIES=debian/patches/series.netbeans-profiler quilt add path/to/file
+     nano path/to/file
+     QUILT_SERIES=debian/patches/series.netbeans-profiler quilt refresh
+     QUILT_SERIES=debian/patches/series.netbeans-profiler quilt pop -a
diff --git a/debian/changelog b/debian/changelog
index a00affa..3b557a4 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -5,6 +5,7 @@ visualvm (1.3.7-1) UNRELEASED; urgency=medium
     - Removed the Ant compatibility patch
     - Depend on libnb-platform18-java instead of libnb-platform13-java
     - Updated the constants in debian/rules
+  * Added debian/README.source to document the workflow used with this package
   * debian/copyright:
     - Refreshed the source URLs
     - Replaced Sun Microsystems with Oracle

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/visualvm.git