xref: /freebsd/share/mk/bsd.README (revision e9b148a3185f41e3a09e91ea75cae7828d908845)
1#	@(#)bsd.README	8.2 (Berkeley) 4/2/94
2# $FreeBSD$
3
4This is the README file for the "include" files for the FreeBSD
5source tree.  The files are installed in /usr/share/mk, and are by
6convention, named with the suffix ".mk".  These files store several
7build options and should be handled with caution.
8
9Note, this file is not intended to replace reading through the .mk
10files for anything tricky.
11
12There are two main types of make include files.  One type is the generally
13usable make include files, such as bsd.prog.mk and bsd.lib.mk.  The other is
14the internal make include files, such as bsd.files.mk and bsd.man.mk, which
15can not/should not be used directly but are used by the other make include
16files.  In most cases it is only interesting to include bsd.prog.mk or
17bsd.lib.mk.
18
19bsd.arch.inc.mk		- includes arch-specific Makefile.$arch
20bsd.compat.mk		- definitions for building programs against compat ABIs
21bsd.compiler.mk		- defined based on current compiler
22bsd.confs.mk		- install of configuration files
23bsd.cpu.mk		- sets CPU/arch-related variables (included from sys.mk)
24bsd.crunchgen.mk	- building crunched binaries using crunchgen(1)
25bsd.dep.mk		- handle Makefile dependencies
26bsd.dirs.mk		- handle directory creation
27bsd.doc.mk		- building troff system documents
28bsd.endian.mk		- TARGET_ENDIAN=1234(little) or 4321 (big) for target
29bsd.files.mk		- install of general purpose files
30bsd.incs.mk		- install of include files
31bsd.info.mk		- building GNU Info hypertext system (deprecated)
32bsd.init.mk		- initialization for the make include files
33bsd.kmod.mk		- building loadable kernel modules
34bsd.lib.mk		- support for building libraries
35bsd.libnames.mk		- define library names
36bsd.links.mk		- install of links (sym/hard)
37bsd.man.mk		- install of manual pages and their links
38bsd.nls.mk		- build and install of NLS catalogs
39bsd.obj.mk		- creating 'obj' directories and cleaning up
40bsd.own.mk		- define common variables
41bsd.port.mk		- building ports
42bsd.port.post.mk	- building ports
43bsd.port.pre.mk		- building ports
44bsd.port.subdir.mk	- targets for building subdirectories for ports
45bsd.prog.mk		- building programs from source files
46bsd.progs.mk		- build multiple programs from sources
47bsd.snmpmod.mk		- building modules for the SNMP daemon bsnmpd
48bsd.subdir.mk		- targets for building subdirectories
49bsd.sys.mk		- common settings used for building FreeBSD sources
50bsd.test.mk		- building test programs from source files
51sys.mk			- default rules for all makes
52
53This file does not document bsd.port*.mk.  They are documented in ports(7).
54
55See also make(1), mkdep(1), style.Makefile(5) and `PMake - A
56Tutorial', located in /usr/share/doc/psd/12.make.
57
58=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
59
60Random things worth knowing about this document:
61
62If appropriate when documenting the variables the default value is
63indicated using square brackets e.g. [gzip].
64In some cases the default value depend on other values (e.g. system
65architecture).  In these cases the most common value is indicated.
66
67This document contains some simple examples of the usage of the BSD make
68include files.  For more examples look at the makefiles in the FreeBSD
69source tree.
70
71=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
72
73RANDOM THINGS WORTH KNOWING:
74
75The files are like C-style #include files, and pretty much behave like
76you'd expect.  The syntax is slightly different in that a single '.' is
77used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
78
79One difference that will save you lots of debugging time is that inclusion
80of the file is normally done at the *end* of the Makefile.  The reason for
81this is because .mk files often modify variables and behavior based on the
82values of variables set in the Makefile.  To make this work, remember that
83the FIRST target found is the target that is used, i.e. if the Makefile has:
84
85	a:
86		echo a
87	a:
88		echo a number two
89
90the command "make a" will echo "a".  To make things confusing, the SECOND
91variable assignment is the overriding one, i.e. if the Makefile has:
92
93	a=	foo
94	a=	bar
95
96	b:
97		echo ${a}
98
99the command "make b" will echo "bar".  This is for compatibility with the
100way the V7 make behaved.
101
102It's fairly difficult to make the BSD .mk files work when you're building
103multiple programs in a single directory.  It's a lot easier to split up
104the programs than to deal with the problem.  Most of the agony comes from
105making the "obj" directory stuff work right, not because we switch to a new
106version of make.  So, don't get mad at us, figure out a better way to handle
107multiple architectures so we can quit using the symbolic link stuff.
108(Imake doesn't count.)
109
110The file .depend in the source directory is expected to contain dependencies
111for the source files.  This file is read automatically by make after reading
112the Makefile.
113
114The variable DESTDIR works as before.  It's not set anywhere but will change
115the tree where the file gets installed.
116
117The profiled libraries are no longer built in a different directory than
118the regular libraries.  A new suffix, ".po", is used to denote a profiled
119object, and ".pico" denotes a position-independent relocatable object.
120".nossppico" denotes a position-independent relocatable object without
121stack smashing protection.
122
123=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
124
125The following variables are common:
126
127AFLAGS.${SRC}
128		Flags dependent on source file name.
129AFLAGS.${TARGET}
130		Flags dependent on output file name.
131ACFLAGS.${SRC}
132		Flags dependent on source file name.
133ACFLAGS.${TARGET}
134		Flags dependent on output file name.
135CFLAGS.${SRC}
136		Flags dependent on source file name.
137CFLAGS.${TARGET}
138		Flags dependent on output file name.
139CFLAGS.${COMPILER_TYPE}
140		Flags dependent on compiler added to CFLAGS.
141CFLAGS.${MACHINE_ARCH}
142		Architectural flags added to CFLAGS.
143CFLAGS_NO_SIMD	Add this to CFLAGS for programs that don't want any SIMD
144		instructions generated. It is setup in bsd.cpu.mk to an
145		appropriate value for the compiler and target.
146CXXFLAGS.${COMPILER_TYPE}
147		Flags dependent on compiler added to CXXFLAGS.
148CXXFLAGS.${MACHINE_ARCH}
149		Architectural flags added to CXXFLAGS.
150CXXFLAGS.${SRC}
151		Flags dependent on source file name.
152CXXFLAGS.${TARGET}
153		Flags dependent on output file name.
154COMPILER_FEATURES
155		A list of features that the compiler supports. Zero or
156		more of:
157			c++11	Supports full C++ 11 standard.
158
159COMPILER_TYPE	Type of compiler, either clang or gcc, though other
160		values are possible. Don't assume != clang == gcc.
161
162COMPILER_VERSION
163		A numeric constant equal to:
164		     major * 10000 + minor * 100 + tiny
165		for the compiler's self-reported version.
166
167=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
168
169The include file <sys.mk> has the default rules for all makes, in the BSD
170environment or otherwise.  You probably don't want to touch this file.
171
172=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
173
174The include file <bsd.arch.inc.mk> includes other Makefiles for specific
175architectures, if they exist. It will include the first of the following
176files that it finds: Makefile.${MACHINE}, Makefile.${MACHINE_ARCH},
177Makefile.${MACHINE_CPUARCH}
178
179=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
180
181The include file <bsd.man.mk> handles installing manual pages and their
182links.
183
184It has three targets:
185
186	all-man:
187		build manual pages.
188	maninstall:
189		install the manual pages and their links.
190	manlint:
191		verify the validity of manual pages.
192
193It sets/uses the following variables:
194
195MAN		The manual pages to be installed (use a .1 - .9 suffix).
196
197MANDIR		Base path for manual installation.
198
199MANGRP		Manual group.
200
201MANMODE		Manual mode.
202
203MANOWN		Manual owner.
204
205MANSUBDIR	Subdirectory under the manual page section, i.e. "/vax"
206		or "/tahoe" for machine specific manual pages.
207
208MLINKS		List of manual page links (using a .1 - .9 suffix).  The
209		linked-to file must come first, the linked file second,
210		and there may be multiple pairs.  The files are hard-linked.
211
212The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
213it exists.
214
215=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
216
217The include file <bsd.own.mk> contains the owners, groups, etc. for both
218manual pages and binaries.
219
220It has no targets.
221
222It sets/uses the following variables:
223
224BINGRP		Binary group.
225
226BINMODE		Binary mode.
227
228BINOWN		Binary owner.
229
230MANDIR		Base path for manual installation.
231
232MANGRP		Manual group.
233
234MANMODE		Manual mode.
235
236MANOWN		Manual owner.
237
238INSTALL_LINK	Command to install a hard link.
239
240INSTALL_SYMLINK	Command to install a symbolic link.
241
242INSTALL_RSYMLINK	Command to install a relative symbolic link.
243
244LINKOWN		Owner of hard links created by INSTALL_LINK.
245
246LINKGRP		Group of hard links created by INSTALL_LINK.
247
248LINKMODE	Mode of hard links created by INSTALL_LINK.
249
250SYMLINKOWN	Owner of hard links created by INSTALL_[R]SYMLINK.
251
252SYMLINKGRP	Group of hard links created by INSTALL_[R]SYMLINK.
253
254SYMLINKMODE	Mode of hard links created by INSTALL_[R]SYMLINK.
255
256This file is generally useful when building your own Makefiles so that
257they use the same default owners etc. as the rest of the tree.
258
259=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
260
261The include file <bsd.prog.mk> handles building programs from one or
262more source files, along with their manual pages.  It has a limited number
263of suffixes, consistent with the current needs of the BSD tree.
264
265It has seven targets:
266
267	all:
268		build the program and its manual page
269	clean:
270		remove the program and any object files.
271	cleandir:
272		remove all of the files removed by the target clean, as
273		well as .depend, tags, and any manual pages.
274	depend:
275		make the dependencies for the source files, and store
276		them in the file .depend.
277	install:
278		install the program and its manual pages; if the Makefile
279		does not itself define the target install, the targets
280		beforeinstall and afterinstall may also be used to cause
281		actions immediately before and after the install target
282		is executed.
283	tags:
284		create a tags file for the source files.
285
286It sets/uses the following variables:
287
288ACFLAGS		Flags to the compiler when preprocessing and
289		assembling .S files.
290
291AFLAGS		Flags to the assembler when assembling .s files.
292
293BINGRP		Binary group.
294
295BINMODE		Binary mode.
296
297BINOWN		Binary owner.
298
299CFLAGS		Flags to the compiler when creating C objects.
300
301CLEANDIRS	Additional files (CLEANFILES) and directories (CLEANDIRS) to
302CLEANFILES	remove during clean and cleandir targets.  "rm -rf" and
303		"rm -f" are used, respectively.
304
305DIRS		A list of variables referring to directories.  For example:
306
307			DIRS+=	FOO
308			FOO=	/usr/share/foo
309
310		Owner, Group, Mode and Flags are handled by FOO_OWN,
311		FOO_GRP, FOO_MODE and FOO_FLAGS, respectively.
312
313		This allows FILESDIR to be set to FOO, and the directory
314		will be created before the files are installed and the
315		dependencies will be set correctly.
316
317DPADD		Additional dependencies for the program.  Usually used for
318		libraries.  For example, to depend on the compatibility and
319		utility libraries use:
320
321			DPADD=${LIBCOMPAT} ${LIBUTIL}
322
323		There is a predefined identifier for each (non-profiled,
324		non-shared) library and object.  Library file names are
325		transformed to identifiers by removing the extension and
326		converting to upper case.
327
328		There are no special identifiers for profiled or shared
329		libraries or objects.  The identifiers for the standard
330		libraries are used in DPADD.  This works correctly iff all
331		the libraries are built at the same time.  Unfortunately,
332		it causes unnecessary relinks to shared libraries when
333		only the static libraries have changed.  Dependencies on
334		shared libraries should be only on the library version
335		numbers.
336
337FILES		A list of non-executable files.
338		The installation is controlled by the FILESNAME, FILESOWN,
339		FILESGRP, FILESMODE, FILESDIR variables that can be
340		further specialized by FILES<VAR>_<file>.
341
342LDADD		Additional loader objects.  Usually used for libraries.
343		For example, to load with the compatibility and utility
344		libraries, use:
345
346			LDADD=-lutil -lcompat
347
348LDADD.${TAREGT}
349		Loader objects dependent on output file name.
350
351LDFLAGS		Additional loader flags. Passed to the loader via CC,
352		since that's used to link programs as well, so loader
353		specific flags need to be prefixed with -Wl, to work.
354
355LDFLAGS.${TARGET}
356		Flags dependent on output file name.
357
358LIBADD		Additional libraries.  This is for base system libraries
359		and is only valid inside of the /usr/src tree.
360		Use LIBADD=name instead of LDADD=-lname.
361
362LIBADD.${TARGET}
363		Libraries dependent on output file name.
364
365LINKS		The list of binary links; should be full pathnames, the
366		linked-to file coming first, followed by the linked
367		file.  The files are hard-linked.  For example, to link
368		/bin/test and /bin/[, use:
369
370			LINKS=	/bin/test /bin/[
371
372LINKOWN		Owner of links created with LINKS [${BINOWN}].
373
374LINKGRP		Group of links created with LINKS [${BINGRP}].
375
376LINKMODE	Mode of links created with LINKS [${BINMODE}].
377
378
379MAN		Manual pages.  If no MAN variable is defined,
380		"MAN=${PROG}.1" is assumed. See bsd.man.mk for more details.
381
382NEED_COMPAT	Build and link targeting a compatability ABI or fail if it
383		is not available.  Supported values are "32", "soft", and
384		"any" being a wildcard.
385
386PROG		The name of the program to build.  If not supplied, nothing
387		is built.
388
389PROGNAME	The name that the above program will be installed as, if
390		different from ${PROG}.
391
392PROG_CXX	If defined, the name of the program to build.  Also
393		causes <bsd.prog.mk> to link the program with the
394		standard C++ library.  PROG_CXX overrides the value
395		of PROG if PROG is also set.
396
397PROGS		When used with <bsd.progs.mk>, allow building multiple
398PROGS_CXX	PROG and PROG_CXX in one Makefile.  To define
399		individual variables for each program the VAR.prog
400		syntax should be used.  For example:
401
402		PROGS=		foo bar
403		SRCS.foo=	foo_src.c
404		LDADD.foo=	-lutil
405		SRCS.bar=	bar_src.c
406
407		The supported variables are:
408		- BINDIR
409		- BINGRP
410		- BINMODE
411		- BINOWN
412		- CFLAGS
413		- CXXFLAGS
414		- DEBUG_FLAGS
415		- DPADD
416		- DPSRCS
417		- INTERNALPROG (no installation)
418		- LDADD
419		- LDFLAGS
420		- LIBADD
421		- LINKS
422		- MAN
423		- MLINKS
424		- NO_WERROR
425		- PROGNAME
426		- SRCS
427		- STRIP
428		- WARNS
429
430SCRIPTS		A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
431		The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
432		SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
433		further specialized by SCRIPTS<VAR>_<script>.
434
435SRCS		List of source files to build the program.  If SRCS is not
436		defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
437		defined, ${PROG_CXX}.cc.
438
439STRIP		The flag passed to the install program to cause the binary
440		to be stripped.  This is to be used when building your
441		own install script so that the entire system can be made
442		stripped/not-stripped using a single nob.
443
444SUBDIR		A list of subdirectories that should be built as well.
445		Each of the targets will execute the same target in the
446		subdirectories.
447
448WANT_COMPAT	Similar to NEED_COMPAT, but build with the base ABI if
449		the specified ABI is not available.
450
451The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
452if it exists, as well as the include file <bsd.man.mk>.
453
454Some simple examples:
455
456To build foo from foo.c with a manual page foo.1, use:
457
458	PROG=	foo
459
460	.include <bsd.prog.mk>
461
462To build foo from foo.c with a manual page foo.2, add the line:
463
464	MAN=	foo.2
465
466If foo does not have a manual page at all, add the line:
467
468	MAN=
469
470If foo has multiple source files, add the line:
471
472	SRCS=	a.c b.c c.c d.c
473
474=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
475
476The include file, <bsd.snmpmod.mk>, handles building MIB modules for bsnmpd
477from one or more source files, along with their manual pages.  It has a
478limited number of suffixes, consistent with the current needs of the BSD
479tree.
480
481bsd.snmpmod.mk leverages bsd.lib.mk for building MIB modules and
482bsd.files.mk for installing MIB description and definition files.
483
484It implements the following additional targets:
485
486	smilint:
487		execute smilint on the MIBs defined by BMIBS.
488
489		The net-mgmt/libsmi package must be installed before
490		executing this target. The net-mgmt/net-snmp package
491		should be installed as well to reduce false positives
492		from smilint.
493
494It sets/uses the following variables:
495
496BMIBS		The MIB definitions to install.
497
498BMIBSDIR	The directory where the MIB definitions are installed.
499		This defaults to `${SHAREDIR}/snmp/mibs`.
500
501DEFS		The MIB description files to install.
502
503DEFSDIR		The directory where MIB description files are installed.
504		This defaults to `${SHAREDIR}/snmp/defs`.
505
506EXTRAMIBDEFS	Extra MIB description files to use as input when
507		generating ${MOD}_oid.h and ${MOD}_tree.[ch].
508
509EXTRAMIBSYMS	Extra MIB definition files used only for extracting
510		symbols.
511
512		EXTRAMIBSYMS are useful when resolving inter-module
513		dependencies and are useful with files containing only
514		enum-definitions.
515
516		See ${MOD}_oid.h for more details.
517
518LOCALBASE	The package root where smilint and the net-snmp
519		definitions can be found
520
521MOD		The bsnmpd module name.
522
523SMILINT		smilint binary to use with the smilint make target.
524
525SMILINT_FLAGS	flags to pass to smilint.
526
527SMIPATH		A colon-separated directory path where MIBs definitions
528		can be found. See "SMIPATH" in smi_config for more
529		details.
530
531XSYM		MIB names to extract symbols for. See ${MOD}_oid.h for
532		more details.
533
534It generates the following files:
535
536${MOD}_tree.c	A source file and header which programmatically describes
537${MOD}_tree.h	the MIB (type, OID name, ACCESS attributes, etc).
538
539		The files are generated via "gensnmptree -p".
540
541		See gensnmptree(1) for more details.
542
543${MOD}_oid.h	A header which programmatically describes the MIB root and
544		MIB tables.
545
546		The files are generated via "gensnmptree -e".
547
548		See gensnmptree(1) for more details.
549
550=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
551
552The include file <bsd.subdir.mk> contains the default targets for building
553subdirectories.  It has the same seven targets as <bsd.prog.mk>: all, clean,
554cleandir, depend, install, and tags.  For all of the directories listed in the
555variable SUBDIRS, the specified directory will be visited and the target made.
556There is also a default target which allows the command "make subdir" where
557subdir is any directory listed in the variable SUBDIRS.
558
559=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
560
561The include file <bsd.lib.mk> has support for building libraries.  It has the
562same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend, install, and
563tags.  It has a limited number of suffixes, consistent with the current needs of
564the BSD tree.
565
566It sets/uses the following variables:
567
568LDADD		Additional loader objects.
569
570LIB		The name of the library to build.  Both a shared and static
571		library will be built.  NO_PIC can be set to only build a
572		static library.
573
574LIBADD		Additional libraries.  This is for base system libraries
575		and is only valid inside of the /usr/src tree.
576		Use LIBADD=name instead of LDADD=-lname.
577
578LIBDIR		Target directory for libraries.
579
580LIBGRP		Library group.
581
582LIBMODE		Library mode.
583
584LIBOWN		Library owner.
585
586LIBRARIES_ONLY	Do not build or install files other than the library.
587
588LIB_CXX		The name of the library to build. It also causes
589		<bsd.lib.mk> to link the library with the
590		standard C++ library.  LIB_CXX overrides the value
591		of LIB if LIB is also set.  Both a shared and static library
592		will be built.  NO_PIC can be set to only build a static
593		library.
594
595LINKS		The list of binary links; should be full pathnames, the
596		linked-to file coming first, followed by the linked
597		file.  The files are hard-linked.  For example, to link
598		/bin/test and /bin/[, use:
599
600			LINKS=	/bin/test /bin/[
601
602LINKOWN		Owner of links created with LINKS [${LIBOWN}].
603
604LINKGRP		Group of links created with LINKS [${LIBGRP}].
605
606LINKMODE	Mode of links created with LINKS [${LIBMODE}].
607
608LINTLIBDIR	Target directory for lint libraries.
609
610MAN		The manual pages to be installed. See bsd.man.mk for more
611		details.
612
613SHLIB		Like LIB but only builds a shared library.
614
615SHLIB_CXX	Like LIB_CXX but only builds a shared library.
616
617SHLIB_LDSCRIPT	Template file to generate shared library linker script.
618		If not defined, a simple symlink is created to the real
619		shared object.
620
621SRCS		List of source files to build the library.  Suffix types
622		.s, .c, and .f are supported.  Note, .s files are preferred
623		to .c files of the same name.  (This is not the default for
624		versions of make.)
625
626The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
627if it exists, as well as the include file <bsd.man.mk>.
628
629It has rules for building profiled objects; profiled libraries are
630built by default.
631
632Libraries are ranlib'd before installation.
633
634=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
635
636The include file <bsd.test.mk> handles building one or more test programs
637intended to be used in the FreeBSD Test Suite under /usr/tests/.
638
639It has seven targets:
640
641	all:
642		build the test programs.
643	check:
644		runs the test programs with kyua test.
645
646		The beforecheck and aftercheck targets will be invoked, if
647		defined, to execute commands before and after the realcheck
648		target has been executed, respectively.
649
650		The devel/kyua package must be installed before invoking this
651		target.
652	clean:
653		remove the test programs and any object files.
654	cleandir:
655		remove all of the files removed by the target clean, as
656		well as .depend and tags.
657	depend:
658		make the dependencies for the source files, and store
659		them in the file .depend.
660	install:
661                install the test programs and their data files; if the
662                Makefile does not itself define the target install, the
663                targets beforeinstall and afterinstall may also be used
664                to cause actions immediately before and after the
665                install target is executed.
666	tags:
667		create a tags file for the source files.
668
669It sets/uses the following variables, among many others:
670
671ATF_TESTS_C	The names of the ATF C test programs to build.
672
673ATF_TESTS_CXX	The names of the ATF C++ test programs to build.
674
675ATF_TESTS_SH	The names of the ATF sh test programs to build.
676
677GTESTS		The names of the GoogleTest test programs to build.
678
679KYUAFILE	If 'auto' (the default), generate a Kyuafile out of the
680		test programs defined in the Makefile.  If 'yes', then a
681		manually-crafted Kyuafile must be supplied with the
682		sources.  If 'no', no Kyuafile is installed (useful for
683		subdirectories providing helper programs or data files
684		only).
685
686LOCALBASE	The --prefix for the kyua package.
687
688		The value of LOCALBASE defaults to /usr/local .
689
690NOT_FOR_TEST_SUITE
691		If defined, none of the built test programs get
692		installed under /usr/tests/ and no Kyuafile is
693		automatically generated.  Should not be used within the
694		FreeBSD source tree but is provided for the benefit of
695		third-parties.
696
697PLAIN_TESTS_C	The names of the plain (legacy) programs to build.
698
699PLAIN_TESTS_CXX	The names of the plain (legacy) test programs to build.
700
701PLAIN_TESTS_SH	The names of the plain (legacy) test programs to build.
702
703TAP_PERL_INTERPRETER
704		Path to the Perl interpreter to be used for
705		TAP-compliant test programs that are written in Perl.
706		Refer to TAP_TESTS_PERL for details.
707
708TAP_TESTS_C	The names of the TAP-compliant C test programs to build.
709
710TAP_TESTS_CXX	The names of the TAP-compliant C++ test programs to
711		build.
712
713TAP_TESTS_PERL	The names of the TAP-compliant Perl test programs to
714		build.  The corresponding source files should end with
715		the .pl extension; the test program is marked as
716		requiring Perl; and TAP_PERL_INTERPRETER is used in the
717		built scripts as the interpreter of choice.
718
719TAP_TESTS_SH	The names of the TAP-compliant sh test programs to
720		build.
721
722TESTSBASE	Installation prefix for tests. Defaults to /usr/tests
723
724TESTSDIR	Path to the installed tests.  Must be a subdirectory of
725		TESTSBASE and the subpath should match the relative
726		location of the tests within the src tree.
727
728		The value of TESTSDIR defaults to
729		${TESTSBASE}/${RELDIR:H} , e.g. /usr/tests/bin/ls when
730		included from bin/ls/tests .
731
732TESTS_SUBDIRS	List of subdirectories containing tests into which to
733		recurse.  Differs from SUBDIR in that these directories
734		get registered into the automatically-generated
735		Kyuafile (if any).
736
737The actual building of the test programs is performed by <bsd.prog.mk>.
738Please see the documentation above for this other file for additional
739details on the behavior of <bsd.test.mk>.
740