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.cpu.mk              - sets CPU/arch-related variables
  20 bsd.crunchgen.mk        - building crunched binaries using crunchgen(1)
  21 bsd.dep.mk              - handle Makefile dependencies
  22 bsd.doc.mk              - building troff system documents
  23 bsd.files.mk            - install of general purpose files
  24 bsd.incs.mk             - install of include files
  25 bsd.info.mk             - building GNU Info hypertext system
  26 bsd.init.mk             - initialization for the make include files
  27 bsd.kmod.mk             - building loadable kernel modules
  28 bsd.lib.mk              - support for building libraries
  29 bsd.libnames.mk         - define library names
  30 bsd.links.mk            - install of links (sym/hard)
  31 bsd.man.mk              - install of manual pages and their links
  32 bsd.nls.mk              - build and install of NLS catalogs
  33 bsd.obj.mk              - creating 'obj' directories and cleaning up
  34 bsd.own.mk              - define common variables
  35 bsd.port.mk             - building ports
  36 bsd.port.post.mk        - building ports
  37 bsd.port.pre.mk         - building ports
  38 bsd.port.subdir.mk      - targets for building subdirectories for ports
  39 bsd.prog.mk             - building programs from source files
  40 bsd.snmpmod.mk          - building modules for the SNMP daemon bsnmpd
  41 bsd.subdir.mk           - targets for building subdirectories
  42 bsd.sys.mk              - common settings used for building FreeBSD sources
  43 bsd.test.mk             - building test programs from source files
  44 sys.mk                  - default rules for all makes
  45
  46 This file does not document bsd.port*.mk.  They are documented in ports(7).
  47
  48 See also make(1), mkdep(1), style.Makefile(5) and `PMake - A
  49 Tutorial', located in /usr/share/doc/psd/12.make.
  50
  51 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  52
  53 Random things worth knowing about this document:
  54
  55 If appropriate when documenting the variables the default value is
  56 indicated using square brackets e.g. [gzip].
  57 In some cases the default value depend on other values (e.g. system
  58 architecture).  In these cases the most common value is indicated.
  59
  60 This document contains some simple examples of the usage of the BSD make
  61 include files.  For more examples look at the makefiles in the FreeBSD
  62 source tree.
  63
  64 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  65
  66 RANDOM THINGS WORTH KNOWING:
  67
  68 The files are like C-style #include files, and pretty much behave like
  69 you'd expect.  The syntax is slightly different in that a single '.' is
  70 used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
  71
  72 One difference that will save you lots of debugging time is that inclusion
  73 of the file is normally done at the *end* of the Makefile.  The reason for
  74 this is because .mk files often modify variables and behavior based on the
  75 values of variables set in the Makefile.  To make this work, remember that
  76 the 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
  83 the command "make a" will echo "a".  To make things confusing, the SECOND
  84 variable 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
  92 the command "make b" will echo "bar".  This is for compatibility with the
  93 way the V7 make behaved.
  94
  95 It's fairly difficult to make the BSD .mk files work when you're building
  96 multiple programs in a single directory.  It's a lot easier to split up
  97 the programs than to deal with the problem.  Most of the agony comes from
  98 making the "obj" directory stuff work right, not because we switch to a new
  99 version of make.  So, don't get mad at us, figure out a better way to handle
 100 multiple architectures so we can quit using the symbolic link stuff.
 101 (Imake doesn't count.)
 102
 103 The file .depend in the source directory is expected to contain dependencies
 104 for the source files.  This file is read automatically by make after reading
 105 the Makefile.
 106
 107 The variable DESTDIR works as before.  It's not set anywhere but will change
 108 the tree where the file gets installed.
 109
 110 The profiled libraries are no longer built in a different directory than
 111 the regular libraries.  A new suffix, ".po", is used to denote a profiled
 112 object.
 113
 114 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 115
 116 The include file <sys.mk> has the default rules for all makes, in the BSD
 117 environment or otherwise.  You probably don't want to touch this file.
 118
 119 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 120
 121 The include file <bsd.man.mk> handles installing manual pages and their
 122 links.
 123
 124 It 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
 133 It sets/uses the following variables:
 134
 135 MANDIR          Base path for manual installation.
 136
 137 MANGRP          Manual group.
 138
 139 MANOWN          Manual owner.
 140
 141 MANMODE         Manual mode.
 142
 143 MANSUBDIR       Subdirectory under the manual page section, i.e. "/vax"
 144                 or "/tahoe" for machine specific manual pages.
 145
 146 MAN             The manual pages to be installed (use a .1 - .9 suffix).
 147
 148 MLINKS          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
 152 The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
 153 it exists.
 154
 155 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 156
 157 The include file <bsd.own.mk> contains the owners, groups, etc. for both
 158 manual pages and binaries.
 159
 160 It has no targets.
 161
 162 It sets/uses the following variables:
 163
 164 BINGRP          Binary group.
 165
 166 BINOWN          Binary owner.
 167
 168 BINMODE         Binary mode.
 169
 170 MANDIR          Base path for manual installation.
 171
 172 MANGRP          Manual group.
 173
 174 MANOWN          Manual owner.
 175
 176 MANMODE         Manual mode.
 177
 178 This file is generally useful when building your own Makefiles so that
 179 they use the same default owners etc. as the rest of the tree.
 180
 181 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 182
 183 The include file <bsd.prog.mk> handles building programs from one or
 184 more source files, along with their manual pages.  It has a limited number
 185 of suffixes, consistent with the current needs of the BSD tree.
 186
 187 It 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
 210 It sets/uses the following variables:
 211
 212 BINGRP          Binary group.
 213
 214 BINOWN          Binary owner.
 215
 216 BINMODE         Binary mode.
 217
 218 CLEANFILES      Additional files to remove and
 219 CLEANDIRS       additional directories to remove during clean and cleandir
 220                 targets.  "rm -f" and "rm -rf" used respectively.
 221
 222 CFLAGS          Flags to the compiler when creating C objects.
 223
 224 FILES           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
 229 LDADD           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
 235 LDFLAGS         Additional loader flags.
 236
 237 LINKS           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
 244 MAN             Manual pages (should end in .1 - .9).  If no MAN variable
 245                 is defined, "MAN=${PROG}.1" is assumed.
 246
 247 PROG            The name of the program to build.  If not supplied, nothing
 248                 is built.
 249
 250 PROG_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
 255 PROGS           When used with <bsd.progs.mk>, allow building multiple
 256 PROGS_CXX       PROG and PROG_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                 - INTERNALPROG (no installation)
 276                 - LDADD
 277                 - LDFLAGS
 278                 - LINKS
 279                 - MAN
 280                 - MLINKS
 281                 - NO_WERROR
 282                 - PROGNAME
 283                 - SRCS
 284                 - STRIP
 285                 - WARNS
 286
 287 PROGNAME        The name that the above program will be installed as, if
 288                 different from ${PROG}.
 289
 290 SRCS            List of source files to build the program.  If SRCS is not
 291                 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
 292                 defined, ${PROG_CXX}.cc.
 293
 294 DPADD           Additional dependencies for the program.  Usually used for
 295                 libraries.  For example, to depend on the compatibility and
 296                 utility libraries use:
 297
 298                         DPADD=${LIBCOMPAT} ${LIBUTIL}
 299
 300                 There is a predefined identifier for each (non-profiled,
 301                 non-shared) library and object.  Library file names are
 302                 transformed to identifiers by removing the extension and
 303                 converting to upper case.
 304
 305                 There are no special identifiers for profiled or shared
 306                 libraries or objects.  The identifiers for the standard
 307                 libraries are used in DPADD.  This works correctly iff all
 308                 the libraries are built at the same time.  Unfortunately,
 309                 it causes unnecessary relinks to shared libraries when
 310                 only the static libraries have changed.  Dependencies on
 311                 shared libraries should be only on the library version
 312                 numbers.
 313
 314 STRIP           The flag passed to the install program to cause the binary
 315                 to be stripped.  This is to be used when building your
 316                 own install script so that the entire system can be made
 317                 stripped/not-stripped using a single nob.
 318
 319 SUBDIR          A list of subdirectories that should be built as well.
 320                 Each of the targets will execute the same target in the
 321                 subdirectories.
 322
 323 SCRIPTS         A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
 324                 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
 325                 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
 326                 further specialized by SCRIPTS<VAR>_<script>.
 327
 328 The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
 329 if it exists, as well as the include file <bsd.man.mk>.
 330
 331 Some simple examples:
 332
 333 To build foo from foo.c with a manual page foo.1, use:
 334
 335         PROG=   foo
 336
 337         .include <bsd.prog.mk>
 338
 339 To build foo from foo.c with a manual page foo.2, add the line:
 340
 341         MAN=    foo.2
 342
 343 If foo does not have a manual page at all, add the line:
 344
 345         MAN=
 346
 347 If foo has multiple source files, add the line:
 348
 349         SRCS=   a.c b.c c.c d.c
 350
 351 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 352
 353 The include file, <bsd.snmpmod.mk>, handles building MIB modules for bsnmpd
 354 from one or more source files, along with their manual pages.  It has a
 355 limited number of suffixes, consistent with the current needs of the BSD
 356 tree.
 357
 358 bsd.snmpmod.mk leverages bsd.lib.mk for building MIB modules and
 359 bsd.files.mk for installing MIB description and definition files.
 360
 361 It implements the following additional targets:
 362
 363         smilint:
 364                 execute smilint on the MIBs defined by BMIBS.
 365
 366                 The net-mgmt/libsmi package must be installed before
 367                 executing this target. The net-mgmt/net-snmp package
 368                 should be installed as well to reduce false positives
 369                 from smilint.
 370
 371 It sets/uses the following variables:
 372
 373 BMIBS           The MIB definitions to install.
 374
 375 BMIBSDIR        The directory where the MIB definitions are installed.
 376                 This defaults to `${SHAREDIR}/snmp/mibs`.
 377
 378 DEFS            The MIB description files to install.
 379
 380 DEFSDIR         The directory where MIB description files are installed.
 381                 This defaults to `${SHAREDIR}/snmp/defs`.
 382
 383 EXTRAMIBDEFS    Extra MIB description files to use as input when
 384                 generating ${MOD}_oid.h and ${MOD}_tree.[ch].
 385
 386 EXTRAMIBSYMS    Extra MIB definition files used only for extracting
 387                 symbols.
 388
 389                 EXTRAMIBSYMS are useful when resolving inter-module
 390                 dependencies and are useful with files containing only
 391                 enum-definitions.
 392
 393                 See ${MOD}_oid.h for more details.
 394
 395 LOCALBASE       The package root where smilint and the net-snmp
 396                 definitions can be found
 397
 398 MOD             The bsnmpd module name.
 399
 400 SMILINT         smilint binary to use with the smilint make target.
 401
 402 SMILINT_FLAGS   flags to pass to smilint.
 403
 404 SMIPATH         A colon-separated directory path where MIBs definitions
 405                 can be found. See "SMIPATH" in smi_config for more
 406                 details.
 407
 408 XSYM            MIB names to extract symbols for. See ${MOD}_oid.h for
 409                 more details.
 410
 411 It generates the following files:
 412
 413 ${MOD}_tree.c   A source file and header which programmatically describes
 414 ${MOD}_tree.h   the MIB (type, OID name, ACCESS attributes, etc).
 415
 416                 The files are generated via "gensnmptree -p".
 417
 418                 See gensnmptree(1) for more details.
 419
 420 ${MOD}_oid.h    A header which programmatically describes the MIB root and
 421                 MIB tables.
 422
 423                 The files are generated via "gensnmptree -e".
 424
 425                 See gensnmptree(1) for more details.
 426
 427 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 428
 429 The include file <bsd.subdir.mk> contains the default targets for building
 430 subdirectories.  It has the same seven targets as <bsd.prog.mk>: all, clean,
 431 cleandir, depend, install, lint, and tags.  For all of the directories
 432 listed in the variable SUBDIRS, the specified directory will be visited
 433 and the target made.  There is also a default target which allows the
 434 command "make subdir" where subdir is any directory listed in the variable
 435 SUBDIRS.
 436
 437 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 438
 439 The include file <bsd.lib.mk> has support for building libraries.  It has
 440 the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
 441 install, lint, and tags.  It has a limited number of suffixes, consistent
 442 with the current needs of the BSD tree.
 443
 444 It sets/uses the following variables:
 445
 446 LIB             The name of the library to build.
 447
 448 LIB_CXX         The name of the library to build. It also causes
 449                 <bsd.lib.mk> to link the library with the
 450                 standard C++ library.  LIB_CXX overrides the value
 451                 of LIB if LIB is also set.
 452
 453 LIBDIR          Target directory for libraries.
 454
 455 LINTLIBDIR      Target directory for lint libraries.
 456
 457 LIBGRP          Library group.
 458
 459 LIBOWN          Library owner.
 460
 461 LIBMODE         Library mode.
 462
 463 LDADD           Additional loader objects.
 464
 465 MAN             The manual pages to be installed (use a .1 - .9 suffix).
 466
 467 SRCS            List of source files to build the library.  Suffix types
 468                 .s, .c, and .f are supported.  Note, .s files are preferred
 469                 to .c files of the same name.  (This is not the default for
 470                 versions of make.)
 471
 472 SHLIB_LDSCRIPT  Template file to generate shared library linker script.
 473                 If not defined, a simple symlink is created to the real
 474                 shared object.
 475
 476 LIBRARIES_ONLY  Do not build or install files other than the library.
 477
 478 The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
 479 if it exists, as well as the include file <bsd.man.mk>.
 480
 481 It has rules for building profiled objects; profiled libraries are
 482 built by default.
 483
 484 Libraries are ranlib'd before installation.
 485
 486 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 487
 488 The include file <bsd.test.mk> handles building one or more test programs
 489 intended to be used in the FreeBSD Test Suite under /usr/tests/.
 490
 491 It has seven targets:
 492
 493         all:
 494                 build the test programs.
 495         check:
 496                 runs the test programs from CHECKDIR with kyua test.
 497
 498                 The beforecheck and aftercheck targets will be invoked, if
 499                 defined, to execute commands before and after the realcheck
 500                 target has been executed, respectively.
 501
 502                 The devel/kyua package must be installed before invoking this
 503                 target.
 504
 505                 See CHECKDIR for more details.
 506         clean:
 507                 remove the test programs and any object files.
 508         cleandir:
 509                 remove all of the files removed by the target clean, as
 510                 well as .depend and tags.
 511         depend:
 512                 make the dependencies for the source files, and store
 513                 them in the file .depend.
 514         install:
 515                 install the test programs and their data files; if the
 516                 Makefile does not itself define the target install, the
 517                 targets beforeinstall and afterinstall may also be used
 518                 to cause actions immediately before and after the
 519                 install target is executed.
 520         lint:
 521                 run lint on the source files.
 522         tags:
 523                 create a tags file for the source files.
 524
 525 It sets/uses the following variables, among many others:
 526
 527 TESTSBASE       Installation prefix for tests. Defaults to /usr/tests
 528
 529 TESTSDIR        Path to the installed tests.  Must be a subdirectory of
 530                 TESTSBASE and the subpath should match the relative
 531                 location of the tests within the src tree.
 532
 533                 The value of TESTSDIR defaults to
 534                 ${TESTSBASE}/${RELDIR:H} , e.g. /usr/tests/bin/ls when
 535                 included from bin/ls/tests .
 536
 537 CHECKDIR        The directory that 'make check' executes tests from.
 538
 539                 The value of CHECKDIR defaults to .OBJDIR.
 540
 541 KYUAFILE        If 'auto' (the default), generate a Kyuafile out of the
 542                 test programs defined in the Makefile.  If 'yes', then a
 543                 manually-crafted Kyuafile must be supplied with the
 544                 sources.  If 'no', no Kyuafile is installed (useful for
 545                 subdirectories providing helper programs or data files
 546                 only).
 547
 548 LOCALBASE       The --prefix for the kyua package.
 549
 550                 The value of LOCALBASE defaults to /usr/local .
 551
 552 ATF_TESTS_C     The names of the ATF C test programs to build.
 553
 554 ATF_TESTS_CXX   The names of the ATF C++ test programs to build.
 555
 556 ATF_TESTS_SH    The names of the ATF sh test programs to build.
 557
 558 PLAIN_TESTS_C   The names of the plain (legacy) programs to build.
 559
 560 PLAIN_TESTS_CXX The names of the plain (legacy) test programs to build.
 561
 562 PLAIN_TESTS_SH  The names of the plain (legacy) test programs to build.
 563
 564 TAP_PERL_INTERPRETER
 565                 Path to the Perl interpreter to be used for
 566                 TAP-compliant test programs that are written in Perl.
 567                 Refer to TAP_TESTS_PERL for details.
 568
 569 TAP_TESTS_C     The names of the TAP-compliant C test programs to build.
 570
 571 TAP_TESTS_CXX   The names of the TAP-compliant C++ test programs to
 572                 build.
 573
 574 TAP_TESTS_PERL  The names of the TAP-compliant Perl test programs to
 575                 build.  The corresponding source files should end with
 576                 the .pl extension; the test program is marked as
 577                 requiring Perl; and TAP_PERL_INTERPRETER is used in the
 578                 built scripts as the interpreter of choice.
 579
 580 TAP_TESTS_SH    The names of the TAP-compliant sh test programs to
 581                 build.
 582
 583 TESTS_SUBDIRS   List of subdirectories containing tests into which to
 584                 recurse.  Differs from SUBDIR in that these directories
 585                 get registered into the automatically-generated
 586                 Kyuafile (if any).
 587
 588 NOT_FOR_TEST_SUITE
 589                 If defined, none of the built test programs get
 590                 installed under /usr/tests/ and no Kyuafile is
 591                 automatically generated.  Should not be used within the
 592                 FreeBSD source tree but is provided for the benefit of
 593                 third-parties.
 594
 595 The actual building of the test programs is performed by <bsd.prog.mk>.
 596 Please see the documentation above for this other file for additional
 597 details on the behavior of <bsd.test.mk>.