share/mk/bsd.README

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