# $NetBSD: help.mk,v 1.18 2022/01/24 23:16:01 gutteridge Exp $
#

# This is the integrated pkgsrc online help system. To query for the
# meaning of a variable, run "make help TOPIC=VARNAME". All variables from
# certain pkgsrc Makefile fragments that have inline comments are eligible
# for querying.

_HELP_FILES=		Makefile
_HELP_FILES+=		mk/*.mk mk/*/*.mk mk/*/*/*.mk
_HELP_FILES+=		mk/defaults/mk.conf
_HELP_FILES+=		lang/go/*.mk
_HELP_FILES+=		lang/lua/*.mk
_HELP_FILES+=		lang/nodejs/*.mk
_HELP_FILES+=		lang/perl5/*.mk
_HELP_FILES+=		lang/php/*.mk
_HELP_FILES+=		lang/python/*.mk
_HELP_FILES+=		lang/qore/*.mk
_HELP_FILES+=		lang/ruby/*.mk
_HELP_FILES+=		math/octave/*.mk
_HELP_FILES+=		print/texlive/*.mk
_HELP_FILES+=		x11/tk/*.mk
_HELP_FILES+=		mk/*/*.help
.if exists(${.PARSEDIR}/../../wip/mk)
_HELP_FILES+=		wip/mk/*.mk
.endif

.if defined(VARNAME)
TOPIC?=		${VARNAME}
.endif
.if defined(topic)
TOPIC?=		${topic}
.endif

.if !target(help)
.PHONY: help
help:
.  if !defined(TOPIC)
	@${ECHO} "usage: "${MAKE:Q}" help topic=<topic>"
	@${ECHO} ""
	@${ECHO} "	<topic> may be a variable name or a make target,"
	@${ECHO} "	for example CONFIGURE_DIRS or patch."
	@${ECHO} ""
	@${ECHO} "	For convenience, all-uppercase topics such as variable"
	@${ECHO} "	names may also be given in all-lowercase."
	@${ECHO} ""
	@${ECHO} "	To see all available topics, use:"
	@${ECHO} "	    make help topic=:index"
	@${ECHO} ""
.  else
	${RUN} env TOPIC=${TOPIC:Q} ${AWK} -f ${PKGSRCDIR}/mk/help/help.awk \
		${_HELP_FILES:S|^|${_PKGSRC_TOPDIR}/|:S|^${.CURDIR}|.|:S,^./,,} \
	| $${PAGER:-cat}
.  endif
.endif