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