Blame m4/ax_generate_changelog.m4

Packit 4b6dd7
# ===========================================================================
Packit 4b6dd7
#  https://www.gnu.org/software/autoconf-archive/ax_generate_changelog.html
Packit 4b6dd7
# ===========================================================================
Packit 4b6dd7
#
Packit 4b6dd7
# SYNOPSIS
Packit 4b6dd7
#
Packit 4b6dd7
#   AX_GENERATE_CHANGELOG()
Packit 4b6dd7
#
Packit 4b6dd7
# DESCRIPTION
Packit 4b6dd7
#
Packit 4b6dd7
#   Builds a rule for generating a ChangeLog file from version control
Packit 4b6dd7
#   system commit messages.  Currently, the only supported VCS is git, but
Packit 4b6dd7
#   support for others could be added in future.
Packit 4b6dd7
#
Packit 4b6dd7
#   Defines GENERATE_CHANGELOG_RULES which should be substituted in your
Packit 4b6dd7
#   Makefile.
Packit 4b6dd7
#
Packit 4b6dd7
#   Usage example:
Packit 4b6dd7
#
Packit 4b6dd7
#   configure.ac:
Packit 4b6dd7
#
Packit 4b6dd7
#     AX_GENERATE_CHANGELOG
Packit 4b6dd7
#
Packit 4b6dd7
#   Makefile.am:
Packit 4b6dd7
#
Packit 4b6dd7
#     @GENERATE_CHANGELOG_RULES@
Packit 4b6dd7
#     CHANGELOG_START = 0.2.3^
Packit 4b6dd7
#     dist-hook: dist-ChangeLog
Packit 4b6dd7
#
Packit 4b6dd7
#   ChangeLog (stub committed to VCS):
Packit 4b6dd7
#
Packit 4b6dd7
#     The ChangeLog is auto-generated when releasing.
Packit 4b6dd7
#     If you are seeing this, use 'git log' for a detailed list of changes.
Packit 4b6dd7
#
Packit 4b6dd7
#   This results in a "dist-ChangeLog" rule being added to the Makefile.
Packit 4b6dd7
#   When run, "dist-ChangeLog" will generate a ChangeLog in the
Packit 4b6dd7
#   $(top_distdir), using $(CHANGELOG_GIT_FLAGS) to format the output from
Packit 4b6dd7
#   "git log" being run in $(CHANGELOG_GIT_DIR).
Packit 4b6dd7
#
Packit 4b6dd7
#   Unless Automake is initialised with the 'foreign' option, a dummy
Packit 4b6dd7
#   ChangeLog file must be committed to VCS in $(top_srcdir), containing the
Packit 4b6dd7
#   text above (for example).  It will be substituted by the automatically
Packit 4b6dd7
#   generated ChangeLog during "make dist".
Packit 4b6dd7
#
Packit 4b6dd7
# LICENSE
Packit 4b6dd7
#
Packit 4b6dd7
#   Copyright (c) 2015 David King <amigadave@amigadave.com>
Packit 4b6dd7
#   Copyright (c) 2015 Philip Withnall <philip.withnall@collabora.co.uk>
Packit 4b6dd7
#
Packit 4b6dd7
#   Copying and distribution of this file, with or without modification, are
Packit 4b6dd7
#   permitted in any medium without royalty provided the copyright notice
Packit 4b6dd7
#   and this notice are preserved.  This file is offered as-is, without any
Packit 4b6dd7
#   warranty.
Packit 4b6dd7
Packit 4b6dd7
#serial 3
Packit 4b6dd7
Packit 4b6dd7
AC_DEFUN([AX_GENERATE_CHANGELOG],[
Packit 4b6dd7
	# Find git, defaulting to the 'missing' script so the user gets a nice
Packit 4b6dd7
	# message if git is missing, rather than a plain 'command not found'.
Packit 4b6dd7
	AC_PATH_PROG([GIT],[git],[${am_missing_run}git])
Packit 4b6dd7
	AC_SUBST([GIT])
Packit 4b6dd7
Packit 4b6dd7
	# Build the ChangeLog rules.
Packit 4b6dd7
	m4_pattern_allow([AM_V_GEN])
Packit 4b6dd7
GENERATE_CHANGELOG_RULES='
Packit 4b6dd7
# Generate ChangeLog
Packit 4b6dd7
#
Packit 4b6dd7
# Optional:
Packit 4b6dd7
#  - CHANGELOG_START: git commit ID or tag name to output changelogs from
Packit 4b6dd7
#    (exclusive). (Default: include all commits)
Packit 4b6dd7
#  - CHANGELOG_GIT_FLAGS: General flags to pass to git-log when generating the
Packit 4b6dd7
#    ChangeLog. (Default: various)
Packit 4b6dd7
#  - CHANGELOG_GIT_DIR: .git directory to use. (Default: $(top_srcdir)/.git)
Packit 4b6dd7
Packit 4b6dd7
# git-specific
Packit 4b6dd7
CHANGELOG_GIT_FLAGS ?= --stat -M -C --name-status --no-color --no-decorate
Packit 4b6dd7
CHANGELOG_GIT_DIR ?= $(top_srcdir)/.git
Packit 4b6dd7
Packit 4b6dd7
ifeq ($(CHANGELOG_START),)
Packit 4b6dd7
CHANGELOG_GIT_RANGE =
Packit 4b6dd7
else
Packit 4b6dd7
CHANGELOG_GIT_RANGE = $(CHANGELOG_START)..
Packit 4b6dd7
endif
Packit 4b6dd7
Packit 4b6dd7
# Generate a ChangeLog in $(top_distdir)
Packit 4b6dd7
dist-ChangeLog:
Packit 4b6dd7
	$(AM_V_GEN)if $(GIT) \
Packit 4b6dd7
		--git-dir=$(CHANGELOG_GIT_DIR) --work-tree=$(top_srcdir) log \
Packit 4b6dd7
		$(CHANGELOG_GIT_FLAGS) $(CHANGELOG_GIT_RANGE) \
Packit 4b6dd7
		| fmt --split-only >.ChangeLog.tmp; \
Packit 4b6dd7
	then mv -f .ChangeLog.tmp "$(top_distdir)/ChangeLog"; \
Packit 4b6dd7
	else rm -f .ChangeLog.tmp; exit 1; fi
Packit 4b6dd7
Packit 4b6dd7
.PHONY: dist-ChangeLog
Packit 4b6dd7
'
Packit 4b6dd7
Packit 4b6dd7
	AC_SUBST([GENERATE_CHANGELOG_RULES])
Packit 4b6dd7
	m4_ifdef([_AM_SUBST_NOTMAKE], [_AM_SUBST_NOTMAKE([GENERATE_CHANGELOG_RULES])])
Packit 4b6dd7
])