[QA] Use map ids

[andy/viking.git] / maintainer / git2changelog.sh

diff --git a/maintainer/git2changelog.sh b/maintainer/git2changelog.sh
index 276e8ae5e3b956336325e0a10bbcd523451899f7..9e828f97acda0d916bfdfd930df20982a789ff37 100755 (executable)
--- a/maintainer/git2changelog.sh
+++ b/maintainer/git2changelog.sh
@@ -5,7 +5,8 @@
 # This script parse the git history and format it like a ChangeLog file.
 # This script is called at distribution tile (see "make dist").
 #
-# =-=-=-=-=
+
+#
 # viking -- GPS Data and Topo Analyzer, Explorer, and Manager
 #
 # Copyright (C) 2009-2010, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
@@ -24,6 +25,10 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 #
+# e.g. for updating the NEWS file before tagging the final commit
+# such as for release 1.5.1 or 1.6, to only list the changes since previous main release (1.5):
+# ./git2changelog.sh HEAD..viking-1.5
+#
 git log --date=short "--format=%cd %an <%aE>:%n%x09* %s" "$@" \
 | awk '/^[^\t]/{if(previous==$0)next;previous=$0}{print}' \
 | sed '/^[^\t]/s/\([^ ]*\) \(.*\)/\n\1\n\2/'