xref: /freebsd/share/mk/bsd.obj.mk (revision f0a75d274af375d15b97b830966b99a02b7db911)
1# $FreeBSD$
2#
3# The include file <bsd.obj.mk> handles creating the 'obj' directory
4# and cleaning up object files, etc.
5#
6# +++ variables +++
7#
8# CLEANDIRS	Additional directories to remove for the clean target.
9#
10# CLEANFILES	Additional files to remove for the clean target.
11#
12# MAKEOBJDIR 	A pathname for the directory where the targets
13#		are built.  Note: MAKEOBJDIR is an *environment* variable
14#		and works properly only if set as an environment variable,
15#		not as a global or command line variable!
16#
17#		E.g. use `env MAKEOBJDIR=temp-obj make'
18#
19# MAKEOBJDIRPREFIX  Specifies somewhere other than /usr/obj to root the object
20#		tree.  Note: MAKEOBJDIRPREFIX is an *environment* variable
21#		and works properly only if set as an environment variable,
22#		not as a global or command line variable!
23#
24#		E.g. use `env MAKEOBJDIRPREFIX=/somewhere/obj make'
25#
26# NO_OBJ	Do not create object directories.  This should not be set
27#		if anything is built.
28#
29# +++ targets +++
30#
31#	clean:
32#		remove ${CLEANFILES}; remove ${CLEANDIRS} and all contents.
33#
34#	cleandir:
35#		remove the build directory (and all its contents) created by obj
36#
37#	obj:
38#		create build directory.
39#
40
41.if !target(__<bsd.obj.mk>__)
42__<bsd.obj.mk>__:
43.include <bsd.own.mk>
44
45.if defined(MAKEOBJDIRPREFIX)
46CANONICALOBJDIR:=${MAKEOBJDIRPREFIX}${.CURDIR}
47.else
48CANONICALOBJDIR:=/usr/obj${.CURDIR}
49.endif
50
51#
52# Warn of unorthodox object directory.
53#
54# The following directories are tried in order for ${.OBJDIR}:
55#
56# 1.  ${MAKEOBJDIRPREFIX}/`pwd`
57# 2.  ${MAKEOBJDIR}
58# 3.  obj.${MACHINE}
59# 4.  obj
60# 5.  /usr/obj/`pwd`
61# 6.  ${.CURDIR}
62#
63# If ${.OBJDIR} is constructed using canonical cases 1 or 5, or
64# case 2 (using MAKEOBJDIR), don't issue a warning.  Otherwise,
65# issue a warning differentiating between cases 6 and (3 or 4).
66#
67objwarn:
68.if !defined(NO_OBJ) && ${.OBJDIR} != ${CANONICALOBJDIR} && \
69    !(defined(MAKEOBJDIRPREFIX) && exists(${CANONICALOBJDIR}/)) && \
70    !(defined(MAKEOBJDIR) && exists(${MAKEOBJDIR}/))
71.if ${.OBJDIR} == ${.CURDIR}
72	@${ECHO} "Warning: Object directory not changed from original ${.CURDIR}"
73.elif exists(${.CURDIR}/obj.${MACHINE}/) || exists(${.CURDIR}/obj/)
74	@${ECHO} "Warning: Using ${.OBJDIR} as object directory instead of\
75		canonical ${CANONICALOBJDIR}"
76.endif
77.endif
78
79.if !defined(NO_OBJ)
80.if !target(obj)
81obj: .PHONY
82	@if ! test -d ${CANONICALOBJDIR}/; then \
83		mkdir -p ${CANONICALOBJDIR}; \
84		if ! test -d ${CANONICALOBJDIR}/; then \
85			${ECHO} "Unable to create ${CANONICALOBJDIR}."; \
86			exit 1; \
87		fi; \
88		${ECHO} "${CANONICALOBJDIR} created for ${.CURDIR}"; \
89	fi
90.endif
91
92.if !target(objlink)
93objlink:
94	@if test -d ${CANONICALOBJDIR}/; then \
95		rm -f ${.CURDIR}/obj; \
96		ln -s ${CANONICALOBJDIR} ${.CURDIR}/obj; \
97	else \
98		echo "No ${CANONICALOBJDIR} to link to - do a make obj."; \
99	fi
100.endif
101.endif # !defined(NO_OBJ)
102
103#
104# where would that obj directory be?
105#
106.if !target(whereobj)
107whereobj:
108	@echo ${.OBJDIR}
109.endif
110
111.if ${CANONICALOBJDIR} != ${.CURDIR} && exists(${CANONICALOBJDIR}/)
112cleanobj:
113	@rm -rf ${CANONICALOBJDIR}
114.else
115cleanobj: clean cleandepend
116.endif
117	@if [ -L ${.CURDIR}/obj ]; then rm -f ${.CURDIR}/obj; fi
118
119.if !target(clean)
120clean:
121.if defined(CLEANFILES) && !empty(CLEANFILES)
122	rm -f ${CLEANFILES}
123.endif
124.if defined(CLEANDIRS) && !empty(CLEANDIRS)
125	rm -rf ${CLEANDIRS}
126.endif
127.endif
128
129cleandir: cleanobj
130
131.include <bsd.subdir.mk>
132
133.endif # !target(__<bsd.obj.mk>__)
134