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