>From c83dddb36b1471975bcd7dd972c1916bcb66162a Mon Sep 17 00:00:00 2001
From: Mats Erik Andersson <address@hidden>
Date: Fri, 17 Apr 2015 17:33:58 +0200
Subject: [PATCH] git-version-gen: add a use-case comment

* build-aux/git-version-gen: Add a further use-case
description in the preamble, demonstrating settings
with sed scripts used for tag mangling.
---
 build-aux/git-version-gen |   16 ++++++++++++++++
 1 files changed, 16 insertions(+), 0 deletions(-)

diff --git a/build-aux/git-version-gen b/build-aux/git-version-gen
index 8e92c0a..b4ae499 100755
--- a/build-aux/git-version-gen
+++ b/build-aux/git-version-gen
@@ -68,6 +68,22 @@ scriptversion=2014-12-02.19; # UTC
 #	echo $(VERSION) > address@hidden && mv address@hidden $@
 # dist-hook:
 #	echo $(VERSION) > $(distdir)/.tarball-version
+#
+# The use case just described presumes that tags are prefixed with
+# the single character "v".  Projects prefering other tag naming
+# conventions have the option of supplying a normalizing sed script
+# to git-version-gen in configure.ac; an entry now taking the form
+#
+# AC_INIT([GNU project],
+#   m4_esyscmd([build-aux/git-version-gen .tarball-version 's/our/v/']),
+#   address@hidden)
+#
+# It is important, however, for retaining the expected functionality,
+# that the identical sed script also is included in cfg.mk:
+#
+# git-version-gen-tag-sed-script = 's/our/v/'
+#
+# Failure to do so could have adverse effects during 'make dist'.
 
 
 me=$0
-- 
1.7.3.2