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