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