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