Some spelling fixes in a comment

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

diff --git a/maintainer/git2changelog.sh b/maintainer/git2changelog.sh
index 6050eebf696f3b280cb4156565599161466ebccd..9e828f97acda0d916bfdfd930df20982a789ff37 100755 (executable)
--- a/maintainer/git2changelog.sh
+++ b/maintainer/git2changelog.sh
@@ -25,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/'