[mirror_zfs-debian.git] / config / zfs-meta.m4

dnl #
dnl # DESCRIPTION:
dnl # Read meta data from the META file.  When building from a git repository
dnl # the ZFS_META_RELEASE field will be overwritten if there is an annotated
dnl # tag matching the form ZFS_META_NAME-ZFS_META_VERSION-*.  This allows
dnl # for working builds to be uniquely identified using the git commit hash.
dnl #
dnl #    The META file format is as follows:
dnl #      ^[ ]*KEY:[ \t]+VALUE$
dnl #
dnl #    In other words:
dnl #    - KEY is separated from VALUE by a colon and one or more spaces/tabs.
dnl #    - KEY and VALUE are case sensitive.
dnl #    - Leading spaces are ignored.
dnl #    - First match wins for duplicate keys.
dnl #
dnl #    A line can be commented out by preceding it with a '#' (or technically
dnl #    any non-space character since that will prevent the regex from
dnl #    matching).
dnl #
dnl # WARNING:
dnl #   Placing a colon followed by a space or tab (ie, ":[ \t]+") within the
dnl #   VALUE will prematurely terminate the string since that sequence is
dnl #   used as the awk field separator.
dnl #
dnl # KEYS:
dnl #   The following META keys are recognized:
dnl #     Name, Version, Release, Date, Author, LT_Current, LT_Revision, LT_Age
dnl #
dnl # Written by Chris Dunlap <cdunlap@llnl.gov>.
dnl # Modified by Brian Behlendorf <behlendorf1@llnl.gov>.
dnl #
AC_DEFUN([ZFS_AC_META], [

	AH_BOTTOM([
#undef PACKAGE
#undef PACKAGE_BUGREPORT
#undef PACKAGE_NAME
#undef PACKAGE_STRING
#undef PACKAGE_TARNAME
#undef PACKAGE_VERSION
#undef STDC_HEADERS
#undef VERSION])

	AC_PROG_AWK
	AC_MSG_CHECKING([metadata])

	META="$srcdir/META"
	_zfs_ac_meta_type="none"
	if test -f "$META"; then
		_zfs_ac_meta_type="META file"

		ZFS_META_NAME=_ZFS_AC_META_GETVAL([(Name|Project|Package)]);
		if test -n "$ZFS_META_NAME"; then
			AC_DEFINE_UNQUOTED([ZFS_META_NAME], ["$ZFS_META_NAME"],
				[Define the project name.]
			)
			AC_SUBST([ZFS_META_NAME])
		fi

		ZFS_META_VERSION=_ZFS_AC_META_GETVAL([Version]);
		if test -n "$ZFS_META_VERSION"; then
			AC_DEFINE_UNQUOTED([ZFS_META_VERSION], ["$ZFS_META_VERSION"],
				[Define the project version.]
			)
			AC_SUBST([ZFS_META_VERSION])
		fi

		ZFS_META_RELEASE=_ZFS_AC_META_GETVAL([Release]);
		if test ! -f ".nogitrelease" && git rev-parse --git-dir > /dev/null 2>&1; then
			_match="${ZFS_META_NAME}-${ZFS_META_VERSION}"
			_alias=$(git describe --match=${_match} 2>/dev/null)
			_release=$(echo ${_alias}|cut -f3- -d'-'|sed 's/-/_/g')
			if test -n "${_release}"; then
				ZFS_META_RELEASE=${_release}
				_zfs_ac_meta_type="git describe"
			fi
		fi

		if test -n "$ZFS_META_RELEASE"; then
			AC_DEFINE_UNQUOTED([ZFS_META_RELEASE], ["$ZFS_META_RELEASE"],
				[Define the project release.]
			)
			AC_SUBST([ZFS_META_RELEASE])

			RELEASE="$ZFS_META_RELEASE"
			AC_SUBST([RELEASE])
		fi

		ZFS_META_LICENSE=_ZFS_AC_META_GETVAL([License]);
		if test -n "$ZFS_META_LICENSE"; then
			AC_DEFINE_UNQUOTED([ZFS_META_LICENSE], ["$ZFS_META_LICENSE"],
				[Define the project license.]
			)
			AC_SUBST([ZFS_META_LICENSE])
		fi

		if test -n "$ZFS_META_NAME" -a -n "$ZFS_META_VERSION"; then
				ZFS_META_ALIAS="$ZFS_META_NAME-$ZFS_META_VERSION"
				test -n "$ZFS_META_RELEASE" && 
				        ZFS_META_ALIAS="$ZFS_META_ALIAS-$ZFS_META_RELEASE"
				AC_DEFINE_UNQUOTED([ZFS_META_ALIAS],
					["$ZFS_META_ALIAS"],
					[Define the project alias string.] 
				)
				AC_SUBST([ZFS_META_ALIAS])
		fi

		ZFS_META_DATA=_ZFS_AC_META_GETVAL([Date]);
		if test -n "$ZFS_META_DATA"; then
			AC_DEFINE_UNQUOTED([ZFS_META_DATA], ["$ZFS_META_DATA"],
				[Define the project release date.] 
			)
			AC_SUBST([ZFS_META_DATA])
		fi

		ZFS_META_AUTHOR=_ZFS_AC_META_GETVAL([Author]);
		if test -n "$ZFS_META_AUTHOR"; then
			AC_DEFINE_UNQUOTED([ZFS_META_AUTHOR], ["$ZFS_META_AUTHOR"],
				[Define the project author.]
			)
			AC_SUBST([ZFS_META_AUTHOR])
		fi

		m4_pattern_allow([^LT_(CURRENT|REVISION|AGE)$])
		ZFS_META_LT_CURRENT=_ZFS_AC_META_GETVAL([LT_Current]);
		ZFS_META_LT_REVISION=_ZFS_AC_META_GETVAL([LT_Revision]);
		ZFS_META_LT_AGE=_ZFS_AC_META_GETVAL([LT_Age]);
		if test -n "$ZFS_META_LT_CURRENT" \
				 -o -n "$ZFS_META_LT_REVISION" \
				 -o -n "$ZFS_META_LT_AGE"; then
			test -n "$ZFS_META_LT_CURRENT" || ZFS_META_LT_CURRENT="0"
			test -n "$ZFS_META_LT_REVISION" || ZFS_META_LT_REVISION="0"
			test -n "$ZFS_META_LT_AGE" || ZFS_META_LT_AGE="0"
			AC_DEFINE_UNQUOTED([ZFS_META_LT_CURRENT],
				["$ZFS_META_LT_CURRENT"],
				[Define the libtool library 'current'
				 version information.]
			)
			AC_DEFINE_UNQUOTED([ZFS_META_LT_REVISION],
				["$ZFS_META_LT_REVISION"],
				[Define the libtool library 'revision'
				 version information.]
			)
			AC_DEFINE_UNQUOTED([ZFS_META_LT_AGE], ["$ZFS_META_LT_AGE"],
				[Define the libtool library 'age' 
				 version information.]
			)
			AC_SUBST([ZFS_META_LT_CURRENT])
			AC_SUBST([ZFS_META_LT_REVISION])
			AC_SUBST([ZFS_META_LT_AGE])
		fi
	fi

	AC_MSG_RESULT([$_zfs_ac_meta_type])
	]
)

dnl # _ZFS_AC_META_GETVAL (KEY_NAME_OR_REGEX)
dnl #
dnl # Returns the META VALUE associated with the given KEY_NAME_OR_REGEX expr.
dnl #
dnl # Despite their resemblance to line noise,
dnl #   the "@<:@" and "@:>@" constructs are quadrigraphs for "[" and "]".
dnl #   <www.gnu.org/software/autoconf/manual/autoconf.html#Quadrigraphs>
dnl #
dnl # The "$[]1" and "$[]2" constructs prevent M4 parameter expansion
dnl #   so a literal $1 and $2 will be passed to the resulting awk script,
dnl #   whereas the "$1" will undergo M4 parameter expansion for the META key.
dnl #
AC_DEFUN([_ZFS_AC_META_GETVAL],
	[`$AWK -F ':@<:@ \t@:>@+' '$[]1 ~ /^ *$1$/ { print $[]2; exit }' $META`]dnl
)
Commit	Line	Data
c06d4368 AX	1	dnl #
	2	dnl # DESCRIPTION:
	3	dnl # Read meta data from the META file. When building from a git repository
	4	dnl # the ZFS_META_RELEASE field will be overwritten if there is an annotated
	5	dnl # tag matching the form ZFS_META_NAME-ZFS_META_VERSION-*. This allows
	6	dnl # for working builds to be uniquely identified using the git commit hash.
	7	dnl #
	8	dnl # The META file format is as follows:
	9	dnl # ^[ ]*KEY:[ \t]+VALUE$
	10	dnl #
	11	dnl # In other words:
	12	dnl # - KEY is separated from VALUE by a colon and one or more spaces/tabs.
	13	dnl # - KEY and VALUE are case sensitive.
	14	dnl # - Leading spaces are ignored.
	15	dnl # - First match wins for duplicate keys.
	16	dnl #
	17	dnl # A line can be commented out by preceding it with a '#' (or technically
	18	dnl # any non-space character since that will prevent the regex from
	19	dnl # matching).
	20	dnl #
	21	dnl # WARNING:
	22	dnl # Placing a colon followed by a space or tab (ie, ":[ \t]+") within the
	23	dnl # VALUE will prematurely terminate the string since that sequence is
	24	dnl # used as the awk field separator.
	25	dnl #
	26	dnl # KEYS:
	27	dnl # The following META keys are recognized:
	28	dnl # Name, Version, Release, Date, Author, LT_Current, LT_Revision, LT_Age
	29	dnl #
	30	dnl # Written by Chris Dunlap <cdunlap@llnl.gov>.
	31	dnl # Modified by Brian Behlendorf <behlendorf1@llnl.gov>.
	32	dnl #
c9c0d073 BB	33	AC_DEFUN([ZFS_AC_META], [
	34
	35	AH_BOTTOM([
	36	#undef PACKAGE
	37	#undef PACKAGE_BUGREPORT
	38	#undef PACKAGE_NAME
	39	#undef PACKAGE_STRING
	40	#undef PACKAGE_TARNAME
	41	#undef PACKAGE_VERSION
	42	#undef STDC_HEADERS
	43	#undef VERSION])
	44
c06d4368	45	AC_PROG_AWK
c9c0d073 BB	46	AC_MSG_CHECKING([metadata])
	47
	48	META="$srcdir/META"
f6fb7651	49	_zfs_ac_meta_type="none"
c9c0d073	50	if test -f "$META"; then
f6fb7651	51	_zfs_ac_meta_type="META file"
c9c0d073	52
c06d4368	53	ZFS_META_NAME=_ZFS_AC_META_GETVAL([(Name\|Project\|Package)]);
c9c0d073 BB	54	if test -n "$ZFS_META_NAME"; then
	55	AC_DEFINE_UNQUOTED([ZFS_META_NAME], ["$ZFS_META_NAME"],
	56	[Define the project name.]
	57	)
	58	AC_SUBST([ZFS_META_NAME])
	59	fi
	60
c06d4368	61	ZFS_META_VERSION=_ZFS_AC_META_GETVAL([Version]);
c9c0d073 BB	62	if test -n "$ZFS_META_VERSION"; then
	63	AC_DEFINE_UNQUOTED([ZFS_META_VERSION], ["$ZFS_META_VERSION"],
	64	[Define the project version.]
	65	)
	66	AC_SUBST([ZFS_META_VERSION])
	67	fi
	68
c06d4368 AX	69	ZFS_META_RELEASE=_ZFS_AC_META_GETVAL([Release]);
c06d4368 AX	70	if test ! -f ".nogitrelease" && git rev-parse --git-dir > /dev/null 2>&1; then
ea04106b	71	_match="${ZFS_META_NAME}-${ZFS_META_VERSION}"
f6fb7651 BB	72	_alias=$(git describe --match=${_match} 2>/dev/null)
	73	_release=$(echo ${_alias}\|cut -f3- -d'-'\|sed 's/-/_/g')
	74	if test -n "${_release}"; then
	75	ZFS_META_RELEASE=${_release}
	76	_zfs_ac_meta_type="git describe"
	77	fi
	78	fi
	79
c9c0d073 BB	80	if test -n "$ZFS_META_RELEASE"; then
	81	AC_DEFINE_UNQUOTED([ZFS_META_RELEASE], ["$ZFS_META_RELEASE"],
	82	[Define the project release.]
	83	)
	84	AC_SUBST([ZFS_META_RELEASE])
f3757573 BB	85
	86	RELEASE="$ZFS_META_RELEASE"
	87	AC_SUBST([RELEASE])
c9c0d073 BB	88	fi
c9c0d073 BB	89
c06d4368	90	ZFS_META_LICENSE=_ZFS_AC_META_GETVAL([License]);
c9c0d073 BB	91	if test -n "$ZFS_META_LICENSE"; then
	92	AC_DEFINE_UNQUOTED([ZFS_META_LICENSE], ["$ZFS_META_LICENSE"],
	93	[Define the project license.]
	94	)
	95	AC_SUBST([ZFS_META_LICENSE])
	96	fi
	97
	98	if test -n "$ZFS_META_NAME" -a -n "$ZFS_META_VERSION"; then
	99	ZFS_META_ALIAS="$ZFS_META_NAME-$ZFS_META_VERSION"
	100	test -n "$ZFS_META_RELEASE" &&
	101	ZFS_META_ALIAS="$ZFS_META_ALIAS-$ZFS_META_RELEASE"
	102	AC_DEFINE_UNQUOTED([ZFS_META_ALIAS],
	103	["$ZFS_META_ALIAS"],
	104	[Define the project alias string.]
	105	)
	106	AC_SUBST([ZFS_META_ALIAS])
	107	fi
	108
c06d4368	109	ZFS_META_DATA=_ZFS_AC_META_GETVAL([Date]);
c9c0d073 BB	110	if test -n "$ZFS_META_DATA"; then
	111	AC_DEFINE_UNQUOTED([ZFS_META_DATA], ["$ZFS_META_DATA"],
	112	[Define the project release date.]
	113	)
	114	AC_SUBST([ZFS_META_DATA])
	115	fi
	116
c06d4368	117	ZFS_META_AUTHOR=_ZFS_AC_META_GETVAL([Author]);
c9c0d073 BB	118	if test -n "$ZFS_META_AUTHOR"; then
	119	AC_DEFINE_UNQUOTED([ZFS_META_AUTHOR], ["$ZFS_META_AUTHOR"],
	120	[Define the project author.]
	121	)
	122	AC_SUBST([ZFS_META_AUTHOR])
	123	fi
	124
	125	m4_pattern_allow([^LT_(CURRENT\|REVISION\|AGE)$])
c06d4368 AX	126	ZFS_META_LT_CURRENT=_ZFS_AC_META_GETVAL([LT_Current]);
	127	ZFS_META_LT_REVISION=_ZFS_AC_META_GETVAL([LT_Revision]);
	128	ZFS_META_LT_AGE=_ZFS_AC_META_GETVAL([LT_Age]);
c9c0d073 BB	129	if test -n "$ZFS_META_LT_CURRENT" \
	130	-o -n "$ZFS_META_LT_REVISION" \
	131	-o -n "$ZFS_META_LT_AGE"; then
	132	test -n "$ZFS_META_LT_CURRENT" \|\| ZFS_META_LT_CURRENT="0"
	133	test -n "$ZFS_META_LT_REVISION" \|\| ZFS_META_LT_REVISION="0"
	134	test -n "$ZFS_META_LT_AGE" \|\| ZFS_META_LT_AGE="0"
	135	AC_DEFINE_UNQUOTED([ZFS_META_LT_CURRENT],
	136	["$ZFS_META_LT_CURRENT"],
	137	[Define the libtool library 'current'
	138	version information.]
	139	)
	140	AC_DEFINE_UNQUOTED([ZFS_META_LT_REVISION],
	141	["$ZFS_META_LT_REVISION"],
	142	[Define the libtool library 'revision'
	143	version information.]
	144	)
	145	AC_DEFINE_UNQUOTED([ZFS_META_LT_AGE], ["$ZFS_META_LT_AGE"],
	146	[Define the libtool library 'age'
	147	version information.]
	148	)
	149	AC_SUBST([ZFS_META_LT_CURRENT])
	150	AC_SUBST([ZFS_META_LT_REVISION])
	151	AC_SUBST([ZFS_META_LT_AGE])
	152	fi
	153	fi
	154
f6fb7651	155	AC_MSG_RESULT([$_zfs_ac_meta_type])
c9c0d073 BB	156	]
	157	)
	158
c06d4368 AX	159	dnl # _ZFS_AC_META_GETVAL (KEY_NAME_OR_REGEX)
	160	dnl #
	161	dnl # Returns the META VALUE associated with the given KEY_NAME_OR_REGEX expr.
	162	dnl #
	163	dnl # Despite their resemblance to line noise,
	164	dnl # the "@<:@" and "@:>@" constructs are quadrigraphs for "[" and "]".
	165	dnl # <www.gnu.org/software/autoconf/manual/autoconf.html#Quadrigraphs>
	166	dnl #
	167	dnl # The "$[]1" and "$[]2" constructs prevent M4 parameter expansion
	168	dnl # so a literal $1 and $2 will be passed to the resulting awk script,
	169	dnl # whereas the "$1" will undergo M4 parameter expansion for the META key.
	170	dnl #
	171	AC_DEFUN([_ZFS_AC_META_GETVAL],
	172	[`$AWK -F ':@<:@ \t@:>@+' '$[]1 ~ /^ *$1$/ { print $[]2; exit }' $META`]dnl
c9c0d073	173	)