all Makefile{.inc}s: simplify setting of bmake_topdir

- we only need to append to it in intermediate Makefile.inc's!
robohack · Mar 26, 2024 · ab8460b · ab8460b
1 parent 1ad7394
commit ab8460b
Show file tree

Hide file tree

Showing 14 changed files with 27 additions and 53 deletions.
diff --git a/Makefile b/Makefile
@@ -226,12 +226,7 @@
 
 #####################
 #
-# Now, on with the show....
-#
-
-bmake_topdir =	.
-
-#####################
+#	Now, on with the show....
 #
 # Sub-directories of the project
 #

diff --git a/Makefile.inc b/Makefile.inc
@@ -6,33 +6,25 @@
 #
 # (Some settings can be overridden on the command-line or from environment
 # variables though...)
-#
-# Note also that this file does have some unique per-project settings.
 
-# XXX see SJG's SSLrsh release for simple portability hacks via Make
-# e.g. in particular the use of .-include "$Makefile.${MACHINE}.inc" etc.
+# XXX see SJG's SSLrsh release for simple portability hacks via Make e.g. in
+# particular the use of .-include "$Makefile.${MACHINE}.inc" etc.
 
-# N.B.:  all sub-directory Makefiles must set ${bmake_topdir} to be a relative
-# path to the top of the source tree.
+# For subdirectories Makefiles this ${bmake_topdir} is provided to help find the
+# project's root directory.
+#
+# N.B.:  the top-level Makefile is not expected to ever have to use it though!
 #
-# This is used to allow values in LDADD, DPADD, and CPPFLAGS (or CFLAGS) to
-# directly reference both products and sources in other parts of the tree,
-# especially if they are set in this file (though use directly in subdir
+bmake_topdir = ..
+#
+# ${bmake_topdir} is used to allow values in LDADD, DPADD, and CPPFLAGS (or
+# CFLAGS) to directly reference both products and sources in other parts of the
+# tree, especially if they are set in this file (though use directly in subdir
 # makefiles can help them be more readable).  This is particularly useful for a
 # project that builds a library used by other programs in the same project,
 # and/or which may also build header files shared by several sources in
 # different directories in the same project.
 #
-# The setting of ${bmake_topdir} would not be necessary if/when all supported
-# BSDMake versions have the ${.MAKE.LEVEL} feature.  ${.MAKE.LEVEL} was first
-# found in NetBSD-current after 2009/09/08 but it is not found in any release
-# until 6.0.  Unfortunately there is no easy way to know definitively what
-# version of BSDMake is being used.  Simon Gerraty's (sjg's) BMake has
-# MAKE_VERSION, as does FreeBSD's make though they are entirely and totally
-# different and unrelated.  In NetBSD MAKE_VERSION was only briefly present
-# since it represented the build date, not the release date, and it was removed
-# in order to make it possible to do reproducible builds.
-#
 # For example this file can be used to define the version number(s) for the
 # project, and thus sources which use these numbers (header file templates, or
 # shared library filenames, etc), can add a dependency on this file as follows:
@@ -45,19 +37,20 @@
 # very early on, just before <bsd.own.mk> is included, and it is done by
 # sub-directory makes.  For most implementations certain system variables must
 # be defined before <bsd.own.mk> is included, and so they can be defined here.
-# See below though for why this also includes <bsd.own.mk> itself
-# half-way-through.  As such we depend on the standard <bsd.*.mk> files
-# protecting themselves from multiple inclusions, and though this was not true
-# on the original CSRG BSD releases it has been done now in all modern releases.
+# See below though for why this also includes <bsd.own.mk> itself half-way
+# through.  As such we depend on the standard <bsd.*.mk> files protecting
+# themselves from multiple inclusions, and though this was not true on the
+# original CSRG BSD releases it has been done now in all modern releases.
 #
-# Note also that this is only included by default by makefiles using standard
+# Note also that this is only included by default by Makefiles using standard
 # <bsd.*.mk> files in an immediate subdirectory -- i.e. it is done as follows:
 #
 #	.include "${.CURDIR}/../Makefile.inc"
 #
-# Thus the top level makefile may need to directly include this file, but it
-# must only do so after it has defined any default target (i.e. the .MAIN
-# target).
+# Thus the top level Makefile may need to directly include this file, but it
+# must only do so after it has defined the default target (i.e. the .MAIN
+# target, normally "all").  The top level Makefile should not (need to) use
+# ${bmake_topdir}.
 #
 # This also means that in any project with deeper source trees it may be
 # necessary to create a "Makefile.inc" in intermediate sub-directories in order
@@ -69,6 +62,7 @@
 #	# N.B.:  ${.CURDIR} here is not needed -- it's already implied because of the
 #	# include done by <bsd.prog.mk> in the subdir's Makefile
 #	.include "../Makefile.inc"
+#	bmake_topdir := ${bmake_topdir}/..
 
 .if !target(yajl-showenv)
 
@@ -366,6 +360,7 @@ showenv: yajl-showenv .PHONY
 
 yajl-showenv: .PHONY
 	@echo "" ; \
+	echo "bmake_topdir = '${bmake_topdir}'"; \
 	echo "${.OBJDIR}/${bmake_topdir}/src"; \
 	if [ -d "${.OBJDIR}/${bmake_topdir}/src" ]; then \
 		echo "the directory shown above exists!"; \

diff --git a/doc/Makefile b/doc/Makefile
@@ -1,7 +1,5 @@
 # -*- makefile-bsdmake -*-
 
-bmake_topdir =	..
-
 .include <bsd.own.mk>
 
 #

diff --git a/example/Makefile b/example/Makefile
@@ -1,7 +1,5 @@
 # -*- makefile-bsdmake -*-
 
-bmake_topdir = ..
-
 PROG = 	parse_config
 
 MAN =	# empty

diff --git a/perf/Makefile b/perf/Makefile
@@ -1,7 +1,5 @@
 # -*- makefile-bsdmake -*-
 
-bmake_topdir = ..
-
 SRCS = perftest.c
 SRCS += documents.c
 

diff --git a/reformatter/Makefile b/reformatter/Makefile
@@ -1,7 +1,5 @@
 # -*- makefile-bsdmake -*-
 
-bmake_topdir = ..
-
 PROG = 	json_reformat
 
 MAN =	# empty

diff --git a/src/Makefile b/src/Makefile
@@ -1,7 +1,5 @@
 # -*- makefile-bsdmake -*-
 
-bmake_topdir = ..
-
 LIB =	${PACKAGE:S/^lib//}
 
 # If these are set blank then no shared library is built

diff --git a/src/Makefile.inc b/src/Makefile.inc
@@ -3,3 +3,5 @@
 # N.B.:  ${.CURDIR} here is not needed -- it's already implied because of the
 # include done by <bsd.prog.mk> in the subdir's Makefile
 .include "../Makefile.inc"
+
+bmake_topdir := ${bmake_topdir}/..
diff --git a/src/yajl/Makefile b/src/yajl/Makefile
@@ -1,7 +1,5 @@
 # -*- makefile-bsdmake -*-
 
-bmake_topdir = ../..
-
 yajl_INCS +=	yajl_parse.h
 yajl_INCS +=	yajl_gen.h
 yajl_INCS +=	yajl_common.h

diff --git a/test/Makefile b/test/Makefile
@@ -1,7 +1,5 @@
 # -*- makefile-bsdmake -*-
 
-bmake_topdir = ..
-
 SUBDIR =	api
 SUBDIR +=	parsing
 

diff --git a/test/Makefile.inc b/test/Makefile.inc
@@ -3,3 +3,5 @@
 # N.B.:  ${.CURDIR} here is not needed -- it's already implied because of the
 # include done by <bsd.prog.mk> in the subdir's Makefile
 .include "../Makefile.inc"
+
+bmake_topdir := ${bmake_topdir}/..
diff --git a/test/api/Makefile b/test/api/Makefile
@@ -1,7 +1,5 @@
 # -*- makefile-bsdmake -*-
 
-bmake_topdir = ../..
-
 PROG = 	gen-extra-close
 
 MAN =	# empty

diff --git a/test/parsing/Makefile b/test/parsing/Makefile
@@ -1,7 +1,5 @@
 # -*- makefile-bsdmake -*-
 
-bmake_topdir = ../..
-
 PROG = 	yajl_test
 
 MAN =	# empty

diff --git a/verify/Makefile b/verify/Makefile
@@ -1,7 +1,5 @@
 # -*- makefile-bsdmake -*-
 
-bmake_topdir = ..
-
 PROG = 	json_verify
 
 MAN =	# empty