share/mk/bsd.README

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