[groff] 01/01: Document SHORT_VERSION where it is defined.

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit a6c2217cd0a088b649257b87bea4299cbb1e90dd
Author: G. Branden Robinson <address@hidden>
Date:   Mon Apr 23 06:22:52 2018 -0400

    Document SHORT_VERSION where it is defined.
    
    Leave a breadcrumb in Makefile.am since SHORT_VERSION is logically
    related but handled by a different layer of GNU Autotools.
    
    Further clarify what SHORT_VERSION actually expands to: not just the
    truncated revision number, but the whole version string _up to_ the
    truncation point.
    
    Signed-off-by: G. Branden Robinson <address@hidden>
---
 Makefile.am  | 4 +---
 configure.ac | 5 +++--
 2 files changed, 4 insertions(+), 5 deletions(-)

diff --git a/Makefile.am b/Makefile.am
index bfea268..9de103f 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -634,9 +634,7 @@ endif
 # REVISION is the full revision given by git-version-gen, which can
 # have non-alphanumeric symbols.
 #
-# SHORT_VERSION (defined in configure.ac) contains only the number of
-# REVISION before the first '.', e.g. if REVISION is '3.real.434-5aafd'
-# then SHORT_VERSION is '3'.
+# Also see configure.ac for the related SHORT_VERSION macro.
 
 MAJOR_VERSION =`echo $(VERSION) | sed 's/\([0-9]\+\)\.[0-9]\+.*/\1/'`
 MINOR_VERSION =`echo $(VERSION) | sed 's/[0-9]\+\.\([0-9]\+\).*/\1/'`
diff --git a/configure.ac b/configure.ac
index ff89f11..19d4473 100644
--- a/configure.ac
+++ b/configure.ac
@@ -25,8 +25,9 @@ AC_INIT([GNU Troff],
 
 AC_PREREQ([2.62])
 
-# Version consisting of exactly MAJOR.MINOR.PATCH, stripped of any
-# digit after PATCH.
+# SHORT_VERSION contains only the number of REVISION before the first '.',
+# e.g. if REVISION is '3.real.434-5aafd' then SHORT_VERSION is 'x.yy.3',
+# where x and yy are MAJOR_VERSION and MINOR_VERSION, respectively.
 AC_SUBST([SHORT_VERSION],
        m4_bregexp(AC_PACKAGE_VERSION,[^\(\w+\.\w+\.\w+\).*$],[\1]))