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 123ACFLAGS.${SRC} 124 Flags dependent on source file name. 125CFLAGS.${SRC} 126 Flags dependent on source file name. 127CFLAGS.${COMPILER_TYPE} 128 Flags dependent on compiler added to CXXFLAGS. 129CFLAGS.${MACHINE_ARCH} 130 Architectural flags added to CFLAGS. 131CFLAGS_NO_SIMD Add this to CFLAGS for programs that don't want any SIMD 132 instructions generated. It is setup in bsd.cpu.mk to an 133 appropriate value for the compiler and target. 134CXXFLAGS.${COMPILER_TYPE} 135 Flags dependent on compiler added to CXXFLAGS. 136CXXFLAGS.${MACHINE_ARCH} 137 Architectural flags added to CXXFLAGS. 138CXXFLAGS.${SRC} 139 Flags dependent on source file name. 140COMPILER_FEATURES 141 A list of features that the compiler supports. Zero or 142 more of: 143 c++11 Supports full C++ 11 standard. 144 145COMPILER_TYPE Type of compiler, either clang or gcc, though other 146 values are possible. Don't assume != clang == gcc. 147 148COMPILER_VERSION 149 A numeric constant equal to: 150 major * 10000 + minor * 100 + tiny 151 for the compiler's self-reported version. 152 153=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 154 155The include file <sys.mk> has the default rules for all makes, in the BSD 156environment or otherwise. You probably don't want to touch this file. 157 158=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 159 160The include file <bsd.arch.inc.mk> includes other Makefiles for specific 161architectures, if they exist. It will include the first of the following 162files that it finds: Makefile.${MACHINE}, Makefile.${MACHINE_ARCH}, 163Makefile.${MACHINE_CPUARCH} 164 165=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 166 167The include file <bsd.man.mk> handles installing manual pages and their 168links. 169 170It has three targets: 171 172 all-man: 173 build manual pages. 174 maninstall: 175 install the manual pages and their links. 176 manlint: 177 verify the validity of manual pages. 178 179It sets/uses the following variables: 180 181MANDIR Base path for manual installation. 182 183MANGRP Manual group. 184 185MANOWN Manual owner. 186 187MANMODE Manual mode. 188 189MANSUBDIR Subdirectory under the manual page section, i.e. "/vax" 190 or "/tahoe" for machine specific manual pages. 191 192MAN The manual pages to be installed (use a .1 - .9 suffix). 193 194MLINKS List of manual page links (using a .1 - .9 suffix). The 195 linked-to file must come first, the linked file second, 196 and there may be multiple pairs. The files are hard-linked. 197 198The include file <bsd.man.mk> includes a file named "../Makefile.inc" if 199it exists. 200 201=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 202 203The include file <bsd.own.mk> contains the owners, groups, etc. for both 204manual pages and binaries. 205 206It has no targets. 207 208It sets/uses the following variables: 209 210BINGRP Binary group. 211 212BINOWN Binary owner. 213 214BINMODE Binary mode. 215 216MANDIR Base path for manual installation. 217 218MANGRP Manual group. 219 220MANOWN Manual owner. 221 222MANMODE Manual mode. 223 224This file is generally useful when building your own Makefiles so that 225they use the same default owners etc. as the rest of the tree. 226 227=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 228 229The include file <bsd.prog.mk> handles building programs from one or 230more source files, along with their manual pages. It has a limited number 231of suffixes, consistent with the current needs of the BSD tree. 232 233It has seven targets: 234 235 all: 236 build the program and its manual page 237 clean: 238 remove the program and any object files. 239 cleandir: 240 remove all of the files removed by the target clean, as 241 well as .depend, tags, and any manual pages. 242 depend: 243 make the dependencies for the source files, and store 244 them in the file .depend. 245 install: 246 install the program and its manual pages; if the Makefile 247 does not itself define the target install, the targets 248 beforeinstall and afterinstall may also be used to cause 249 actions immediately before and after the install target 250 is executed. 251 lint: 252 run lint on the source files 253 tags: 254 create a tags file for the source files. 255 256It sets/uses the following variables: 257 258BINGRP Binary group. 259 260BINOWN Binary owner. 261 262BINMODE Binary mode. 263 264CLEANFILES Additional files to remove and 265CLEANDIRS additional directories to remove during clean and cleandir 266 targets. "rm -f" and "rm -rf" used respectively. 267 268CFLAGS Flags to the compiler when creating C objects. 269 270FILES A list of non-executable files. 271 The installation is controlled by the FILESNAME, FILESOWN, 272 FILESGRP, FILESMODE, FILESDIR variables that can be 273 further specialized by FILES<VAR>_<file>. 274 275LDADD Additional loader objects. Usually used for libraries. 276 For example, to load with the compatibility and utility 277 libraries, use: 278 279 LDADD=-lutil -lcompat 280 281LIBADD Additional libraries. This is for base system libraries 282 and is only valid inside of the /usr/src tree. 283 Rather than use LDADD=-lname use LIBADD=name. 284 285LDFLAGS Additional loader flags. Passed to the loader via CC, 286 since that's used to link programs as well, so loader 287 specific flags need to be prefixed with -Wl, to work. 288 289LINKS The list of binary links; should be full pathnames, the 290 linked-to file coming first, followed by the linked 291 file. The files are hard-linked. For example, to link 292 /bin/test and /bin/[, use: 293 294 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 295 296MAN Manual pages (should end in .1 - .9). If no MAN variable 297 is defined, "MAN=${PROG}.1" is assumed. 298 299PROG The name of the program to build. If not supplied, nothing 300 is built. 301 302PROG_CXX If defined, the name of the program to build. Also 303 causes <bsd.prog.mk> to link the program with the 304 standard C++ library. PROG_CXX overrides the value 305 of PROG if PROG is also set. 306 307PROGS When used with <bsd.progs.mk>, allow building multiple 308PROGS_CXX PROG and PROGS_CXX in one Makefile. To define 309 individual variables for each program the VAR.prog 310 syntax should be used. For example: 311 312 PROGS= foo bar 313 SRCS.foo= foo_src.c 314 LDADD.foo= -lutil 315 SRCS.bar= bar_src.c 316 317 The supported variables are BINDIR BINGRP BINMODE BINOWN 318 CFLAGS CXXFLAGS DPADD DPLIBS DPSRCS LDADD 319 LDFLAGS LIBADD MAN MLINKS PROGNAME SRCS. 320 321PROGNAME The name that the above program will be installed as, if 322 different from ${PROG}. 323 324SRCS List of source files to build the program. If SRCS is not 325 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is 326 defined, ${PROG_CXX}.cc. 327 328DPADD Additional dependencies for the program. Usually used for 329 libraries. For example, to depend on the compatibility and 330 utility libraries use: 331 332 DPADD=${LIBCOMPAT} ${LIBUTIL} 333 334 There is a predefined identifier for each (non-profiled, 335 non-shared) library and object. Library file names are 336 transformed to identifiers by removing the extension and 337 converting to upper case. 338 339 There are no special identifiers for profiled or shared 340 libraries or objects. The identifiers for the standard 341 libraries are used in DPADD. This works correctly iff all 342 the libraries are built at the same time. Unfortunately, 343 it causes unnecessary relinks to shared libraries when 344 only the static libraries have changed. Dependencies on 345 shared libraries should be only on the library version 346 numbers. 347 348STRIP The flag passed to the install program to cause the binary 349 to be stripped. This is to be used when building your 350 own install script so that the entire system can be made 351 stripped/not-stripped using a single nob. 352 353SUBDIR A list of subdirectories that should be built as well. 354 Each of the targets will execute the same target in the 355 subdirectories. 356 357SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 358 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN, 359 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be 360 further specialized by SCRIPTS<VAR>_<script>. 361 362The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 363if it exists, as well as the include file <bsd.man.mk>. 364 365Some simple examples: 366 367To build foo from foo.c with a manual page foo.1, use: 368 369 PROG= foo 370 371 .include <bsd.prog.mk> 372 373To build foo from foo.c with a manual page foo.2, add the line: 374 375 MAN= foo.2 376 377If foo does not have a manual page at all, add the line: 378 379 MAN= 380 381If foo has multiple source files, add the line: 382 383 SRCS= a.c b.c c.c d.c 384 385=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 386 387The include file <bsd.subdir.mk> contains the default targets for building 388subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean, 389cleandir, depend, install, lint, and tags. For all of the directories 390listed in the variable SUBDIRS, the specified directory will be visited 391and the target made. There is also a default target which allows the 392command "make subdir" where subdir is any directory listed in the variable 393SUBDIRS. 394 395=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 396 397The include file <bsd.lib.mk> has support for building libraries. It has 398the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend, 399install, lint, and tags. It has a limited number of suffixes, consistent 400with the current needs of the BSD tree. 401 402It sets/uses the following variables: 403 404LIB The name of the library to build. 405 406LIB_CXX The name of the library to build. It also causes 407 <bsd.lib.mk> to link the library with the 408 standard C++ library. LIB_CXX overrides the value 409 of LIB if LIB is also set. 410 411LIBDIR Target directory for libraries. 412 413LINTLIBDIR Target directory for lint libraries. 414 415LIBGRP Library group. 416 417LIBOWN Library owner. 418 419LIBMODE Library mode. 420 421LDADD Additional loader objects. 422 423LIBADD Additional libraries. This is for base system libraries 424 and is only valid inside of the /usr/src tree. 425 Rather than use LDADD=-lname use LIBADD=name. 426 427MAN The manual pages to be installed (use a .1 - .9 suffix). 428 429SRCS List of source files to build the library. Suffix types 430 .s, .c, and .f are supported. Note, .s files are preferred 431 to .c files of the same name. (This is not the default for 432 versions of make.) 433 434SHLIB_LDSCRIPT Template file to generate shared library linker script. 435 Unless used, a simple symlink is created to the real 436 shared object. 437 438LIBRARIES_ONLY Do not build or install files other than the library. 439 440The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 441if it exists, as well as the include file <bsd.man.mk>. 442 443It has rules for building profiled objects; profiled libraries are 444built by default. 445 446Libraries are ranlib'd before installation. 447 448=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 449 450The include file <bsd.test.mk> handles building one or more test programs 451intended to be used in the FreeBSD Test Suite under /usr/tests/. 452 453It has seven targets: 454 455 all: 456 build the test programs. 457 check: 458 runs the test programs from CHECKDIR with kyua test. 459 460 The beforecheck and aftercheck targets will be invoked, if 461 defined, to execute commands before and after the realcheck 462 target has been executed, respectively. 463 464 The devel/kyua package must be installed before invoking this 465 target. 466 467 See CHECKDIR for more details. 468 clean: 469 remove the test programs and any object files. 470 cleandir: 471 remove all of the files removed by the target clean, as 472 well as .depend and tags. 473 depend: 474 make the dependencies for the source files, and store 475 them in the file .depend. 476 install: 477 install the test programs and their data files; if the 478 Makefile does not itself define the target install, the 479 targets beforeinstall and afterinstall may also be used 480 to cause actions immediately before and after the 481 install target is executed. 482 lint: 483 run lint on the source files. 484 tags: 485 create a tags file for the source files. 486 487It sets/uses the following variables, among many others: 488 489TESTSBASE Installation prefix for tests. Defaults to /usr/tests 490 491TESTSDIR Path to the installed tests. Must be a subdirectory of 492 TESTSBASE and the subpath should match the relative 493 location of the tests within the src tree. 494 495 The value of TESTSDIR defaults to 496 ${TESTSBASE}/${RELDIR:H} , e.g. /usr/tests/bin/ls when 497 included from bin/ls/tests . 498 499CHECKDIR The directory that 'make check' executes tests from. 500 501 The value of CHECKDIR defaults to .OBJDIR. 502 503KYUAFILE If 'auto' (the default), generate a Kyuafile out of the 504 test programs defined in the Makefile. If 'yes', then a 505 manually-crafted Kyuafile must be supplied with the 506 sources. If 'no', no Kyuafile is installed (useful for 507 subdirectories providing helper programs or data files 508 only). 509 510LOCALBASE The --prefix for the kyua package. 511 512 The value of LOCALBASE defaults to /usr/local . 513 514ATF_TESTS_C The names of the ATF C test programs to build. 515 516ATF_TESTS_CXX The names of the ATF C++ test programs to build. 517 518ATF_TESTS_SH The names of the ATF sh test programs to build. 519 520PLAIN_TESTS_C The names of the plain (legacy) programs to build. 521 522PLAIN_TESTS_CXX The names of the plain (legacy) test programs to build. 523 524PLAIN_TESTS_SH The names of the plain (legacy) test programs to build. 525 526TAP_PERL_INTERPRETER 527 Path to the Perl interpreter to be used for 528 TAP-compliant test programs that are written in Perl. 529 Refer to TAP_TESTS_PERL for details. 530 531TAP_TESTS_C The names of the TAP-compliant C test programs to build. 532 533TAP_TESTS_CXX The names of the TAP-compliant C++ test programs to 534 build. 535 536TAP_TESTS_PERL The names of the TAP-compliant Perl test programs to 537 build. The corresponding source files should end with 538 the .pl extension; the test program is marked as 539 requiring Perl; and TAP_PERL_INTERPRETER is used in the 540 built scripts as the interpreter of choice. 541 542TAP_TESTS_SH The names of the TAP-compliant sh test programs to 543 build. 544 545TESTS_SUBDIRS List of subdirectories containing tests into which to 546 recurse. Differs from SUBDIR in that these directories 547 get registered into the automatically-generated 548 Kyuafile (if any). 549 550NOT_FOR_TEST_SUITE 551 If defined, none of the built test programs get 552 installed under /usr/tests/ and no Kyuafile is 553 automatically generated. Should not be used within the 554 FreeBSD source tree but is provided for the benefit of 555 third-parties. 556 557The actual building of the test programs is performed by <bsd.prog.mk>. 558Please see the documentation above for this other file for additional 559details on the behavior of <bsd.test.mk>. 560