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 and without sanitizer instrumentation. 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.${TARGET} 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 382PROG The name of the program to build. If not supplied, nothing 383 is built. 384 385PROGNAME The name that the above program will be installed as, if 386 different from ${PROG}. 387 388PROG_CXX If defined, the name of the program to build. Also 389 causes <bsd.prog.mk> to link the program with the 390 standard C++ library. PROG_CXX overrides the value 391 of PROG if PROG is also set. 392 393PROGS When used with <bsd.progs.mk>, allow building multiple 394PROGS_CXX PROG and PROG_CXX in one Makefile. To define 395 individual variables for each program the VAR.prog 396 syntax should be used. For example: 397 398 PROGS= foo bar 399 SRCS.foo= foo_src.c 400 LDADD.foo= -lutil 401 SRCS.bar= bar_src.c 402 403 The supported variables are: 404 - BINDIR 405 - BINGRP 406 - BINMODE 407 - BINOWN 408 - CFLAGS 409 - CXXFLAGS 410 - DEBUG_FLAGS 411 - DPADD 412 - DPSRCS 413 - INTERNALPROG (no installation) 414 - LDADD 415 - LDFLAGS 416 - LIBADD 417 - LINKS 418 - MAN 419 - MLINKS 420 - MK_WERROR=no 421 - PROGNAME 422 - SRCS 423 - STRIP 424 - WARNS 425 426SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 427 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN, 428 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be 429 further specialized by SCRIPTS<VAR>_<script>. 430 431SRCS List of source files to build the program. If SRCS is not 432 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is 433 defined, ${PROG_CXX}.cc. 434 435STRIP The flag passed to the install program to cause the binary 436 to be stripped. This is to be used when building your 437 own install script so that the entire system can be made 438 stripped/not-stripped using a single nob. 439 440SUBDIR A list of subdirectories that should be built as well. 441 Each of the targets will execute the same target in the 442 subdirectories. 443 444The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 445if it exists, as well as the include file <bsd.man.mk>. 446 447Some simple examples: 448 449To build foo from foo.c with a manual page foo.1, use: 450 451 PROG= foo 452 453 .include <bsd.prog.mk> 454 455To build foo from foo.c with a manual page foo.2, add the line: 456 457 MAN= foo.2 458 459If foo does not have a manual page at all, add the line: 460 461 MAN= 462 463If foo has multiple source files, add the line: 464 465 SRCS= a.c b.c c.c d.c 466 467=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 468 469The include file, <bsd.compat.mk>, allows programs (built with 470<bsd.prog.mk>) to be built for one the ABI(s) supported by the 471top-level Makefile.libcompat. It requires that <bsd.prog.mk> also be 472included. 473 474NEED_COMPAT Build and link targeting a compatibility ABI or fail if it 475 is not available. Supported values are "32", "soft", and 476 "any" being a wildcard. 477 478WANT_COMPAT Similar to NEED_COMPAT, but build with the base ABI if 479 the specified ABI is not available. 480 481=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 482 483The include file, <bsd.snmpmod.mk>, handles building MIB modules for bsnmpd 484from one or more source files, along with their manual pages. It has a 485limited number of suffixes, consistent with the current needs of the BSD 486tree. 487 488bsd.snmpmod.mk leverages bsd.lib.mk for building MIB modules and 489bsd.files.mk for installing MIB description and definition files. 490 491It implements the following additional targets: 492 493 smilint: 494 execute smilint on the MIBs defined by BMIBS. 495 496 The net-mgmt/libsmi package must be installed before 497 executing this target. The net-mgmt/net-snmp package 498 should be installed as well to reduce false positives 499 from smilint. 500 501It sets/uses the following variables: 502 503BMIBS The MIB definitions to install. 504 505BMIBSDIR The directory where the MIB definitions are installed. 506 This defaults to `${SHAREDIR}/snmp/mibs`. 507 508DEFS The MIB description files to install. 509 510DEFSDIR The directory where MIB description files are installed. 511 This defaults to `${SHAREDIR}/snmp/defs`. 512 513EXTRAMIBDEFS Extra MIB description files to use as input when 514 generating ${MOD}_oid.h and ${MOD}_tree.[ch]. 515 516EXTRAMIBSYMS Extra MIB definition files used only for extracting 517 symbols. 518 519 EXTRAMIBSYMS are useful when resolving inter-module 520 dependencies and are useful with files containing only 521 enum-definitions. 522 523 See ${MOD}_oid.h for more details. 524 525LOCALBASE The package root where smilint and the net-snmp 526 definitions can be found 527 528MOD The bsnmpd module name. 529 530SMILINT smilint binary to use with the smilint make target. 531 532SMILINT_FLAGS flags to pass to smilint. 533 534SMIPATH A colon-separated directory path where MIBs definitions 535 can be found. See "SMIPATH" in smi_config for more 536 details. 537 538XSYM MIB names to extract symbols for. See ${MOD}_oid.h for 539 more details. 540 541It generates the following files: 542 543${MOD}_tree.c A source file and header which programmatically describes 544${MOD}_tree.h the MIB (type, OID name, ACCESS attributes, etc). 545 546 The files are generated via "gensnmptree -p". 547 548 See gensnmptree(1) for more details. 549 550${MOD}_oid.h A header which programmatically describes the MIB root and 551 MIB tables. 552 553 The files are generated via "gensnmptree -e". 554 555 See gensnmptree(1) for more details. 556 557=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 558 559The include file <bsd.subdir.mk> contains the default targets for building 560subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean, 561cleandir, depend, install, and tags. For all of the directories listed in the 562variable SUBDIRS, the specified directory will be visited and the target made. 563There is also a default target which allows the command "make subdir" where 564subdir is any directory listed in the variable SUBDIRS. 565 566=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 567 568The include file <bsd.lib.mk> has support for building libraries. It has the 569same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend, install, and 570tags. It has a limited number of suffixes, consistent with the current needs of 571the BSD tree. 572 573It sets/uses the following variables: 574 575LDADD Additional loader objects. 576 577LIB The name of the library to build. Both a shared and static 578 library will be built. NO_PIC can be set to only build a 579 static library. 580 581LIBADD Additional libraries. This is for base system libraries 582 and is only valid inside of the /usr/src tree. 583 Use LIBADD=name instead of LDADD=-lname. 584 585LIBDIR Target directory for libraries. 586 587LIBGRP Library group. 588 589LIBMODE Library mode. 590 591LIBOWN Library owner. 592 593LIBRARIES_ONLY Do not build or install files other than the library. 594 595LIB_CXX The name of the library to build. It also causes 596 <bsd.lib.mk> to link the library with the 597 standard C++ library. LIB_CXX overrides the value 598 of LIB if LIB is also set. Both a shared and static library 599 will be built. NO_PIC can be set to only build a static 600 library. 601 602LINKS The list of binary links; should be full pathnames, the 603 linked-to file coming first, followed by the linked 604 file. The files are hard-linked. For example, to link 605 /bin/test and /bin/[, use: 606 607 LINKS= /bin/test /bin/[ 608 609LINKOWN Owner of links created with LINKS [${LIBOWN}]. 610 611LINKGRP Group of links created with LINKS [${LIBGRP}]. 612 613LINKMODE Mode of links created with LINKS [${LIBMODE}]. 614 615MAN The manual pages to be installed. See bsd.man.mk for more 616 details. 617 618SHLIB Like LIB but only builds a shared library. 619 620SHLIB_CXX Like LIB_CXX but only builds a shared library. 621 622SHLIB_LDSCRIPT Template file to generate shared library linker script. 623 If not defined, a simple symlink is created to the real 624 shared object. 625 626SRCS List of source files to build the library. Suffix types 627 .s, .c, and .f are supported. Note, .s files are preferred 628 to .c files of the same name. (This is not the default for 629 versions of make.) 630 631The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 632if it exists, as well as the include file <bsd.man.mk>. 633 634It has rules for building profiled objects; profiled libraries are 635built by default. 636 637Libraries are ranlib'd before installation. 638 639=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 640 641The include file <bsd.test.mk> handles building one or more test programs 642intended to be used in the FreeBSD Test Suite under /usr/tests/. 643 644It has seven targets: 645 646 all: 647 build the test programs. 648 check: 649 runs the test programs with kyua test. 650 651 The beforecheck and aftercheck targets will be invoked, if 652 defined, to execute commands before and after the realcheck 653 target has been executed, respectively. 654 655 The devel/kyua package must be installed before invoking this 656 target. 657 clean: 658 remove the test programs and any object files. 659 cleandir: 660 remove all of the files removed by the target clean, as 661 well as .depend and tags. 662 depend: 663 make the dependencies for the source files, and store 664 them in the file .depend. 665 install: 666 install the test programs and their data files; if the 667 Makefile does not itself define the target install, the 668 targets beforeinstall and afterinstall may also be used 669 to cause actions immediately before and after the 670 install target is executed. 671 tags: 672 create a tags file for the source files. 673 674It sets/uses the following variables, among many others: 675 676ATF_TESTS_C The names of the ATF C test programs to build. 677 678ATF_TESTS_CXX The names of the ATF C++ test programs to build. 679 680ATF_TESTS_SH The names of the ATF sh test programs to build. 681 682GTESTS The names of the GoogleTest test programs to build. 683 684KYUAFILE If 'auto' (the default), generate a Kyuafile out of the 685 test programs defined in the Makefile. If 'yes', then a 686 manually-crafted Kyuafile must be supplied with the 687 sources. If 'no', no Kyuafile is installed (useful for 688 subdirectories providing helper programs or data files 689 only). 690 691LOCALBASE The --prefix for the kyua package. 692 693 The value of LOCALBASE defaults to /usr/local . 694 695NOT_FOR_TEST_SUITE 696 If defined, none of the built test programs get 697 installed under /usr/tests/ and no Kyuafile is 698 automatically generated. Should not be used within the 699 FreeBSD source tree but is provided for the benefit of 700 third-parties. 701 702PLAIN_TESTS_C The names of the plain (legacy) programs to build. 703 704PLAIN_TESTS_CXX The names of the plain (legacy) test programs to build. 705 706PLAIN_TESTS_SH The names of the plain (legacy) test programs to build. 707 708TAP_PERL_INTERPRETER 709 Path to the Perl interpreter to be used for 710 TAP-compliant test programs that are written in Perl. 711 Refer to TAP_TESTS_PERL for details. 712 713TAP_TESTS_C The names of the TAP-compliant C test programs to build. 714 715TAP_TESTS_CXX The names of the TAP-compliant C++ test programs to 716 build. 717 718TAP_TESTS_PERL The names of the TAP-compliant Perl test programs to 719 build. The corresponding source files should end with 720 the .pl extension; the test program is marked as 721 requiring Perl; and TAP_PERL_INTERPRETER is used in the 722 built scripts as the interpreter of choice. 723 724TAP_TESTS_SH The names of the TAP-compliant sh test programs to 725 build. 726 727TESTSBASE Installation prefix for tests. Defaults to /usr/tests 728 729TESTSDIR Path to the installed tests. Must be a subdirectory of 730 TESTSBASE and the subpath should match the relative 731 location of the tests within the src tree. 732 733 The value of TESTSDIR defaults to 734 ${TESTSBASE}/${RELDIR:H} , e.g. /usr/tests/bin/ls when 735 included from bin/ls/tests . 736 737TESTS_SUBDIRS List of subdirectories containing tests into which to 738 recurse. Differs from SUBDIR in that these directories 739 get registered into the automatically-generated 740 Kyuafile (if any). 741 742The actual building of the test programs is performed by <bsd.prog.mk>. 743Please see the documentation above for this other file for additional 744details on the behavior of <bsd.test.mk>. 745