share/mk/bsd.README

   1 #       @(#)bsd.README  8.2 (Berkeley) 4/2/94
   2 # $FreeBSD: src/share/mk/bsd.README,v 1.25 2003/05/17 18:03:05 trhodes Exp $
   3
   4 This is the README file for the "include" files for the DragonFly
   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.custom.mk       - handle CPU flags for custom compilers
  20 bsd.cpu.gcc47.mk        - handle GCC 4.7 specific CPU flags & variables
  21 bsd.cpu.gcc80.mk        - handle GCC 8.0 specific CPU flags & variables
  22 bsd.cpu.mk              - handle CPU flags & variables
  23 bsd.crunchgen.mk        - building crunched binaries using crunchgen(1)
  24 bsd.dep.mk              - handle Makefile dependencies
  25 bsd.files.mk            - install of general purpose files
  26 bsd.hostlib.mk          - handle libraries built with host tools and libraries
  27 bsd.hostprog.mk         - handle programs built with host tools and libraries
  28 bsd.incs.mk             - install of include files
  29 bsd.init.mk             - initialization for the make include files
  30 bsd.kmod.mk             - building loadable kernel modules
  31 bsd.lib.mk              - support for building libraries
  32 bsd.libnames.mk         - define library names
  33 bsd.links.mk            - install of links (sym/hard)
  34 bsd.man.mk              - install of manual pages and their links
  35 bsd.nls.mk              - build and install of NLS catalogs
  36 bsd.obj.mk              - creating 'obj' directories and cleaning up
  37 bsd.own.mk              - define common variables
  38 bsd.prog.mk             - building programs from source files
  39 bsd.subdir.mk           - targets for building subdirectories
  40 bsd.sys.mk              - common settings used for building DragonFly sources
  41 sys.mk                  - default rules for all makes
  42
  43
  44 See also make(1) and mkdep(1).
  45
  46 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  47
  48 Random things worth knowing about this document:
  49
  50 If appropriate when documenting the variables the default value is
  51 indicated using square brackets e.g. [gzip].
  52 In some cases the default value depend on other values (e.g. system
  53 architecture).  In these cases the most common value is indicated.
  54
  55 This document contains some simple examples of the usage of the BSD make
  56 include files.  For more examples look at the makefiles in the DragonFly
  57 source tree.
  58
  59 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  60
  61 RANDOM THINGS WORTH KNOWING:
  62
  63 The files are like C-style #include files, and pretty much behave like
  64 you'd expect.  The syntax is slightly different in that a single '.' is
  65 used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
  66
  67 One difference that will save you lots of debugging time is that inclusion
  68 of the file is normally done at the *end* of the Makefile.  The reason for
  69 this is because .mk files often modify variables and behavior based on the
  70 values of variables set in the Makefile.  To make this work, remember that
  71 the FIRST target found is the target that is used, i.e. if the Makefile has:
  72
  73         a:
  74                 echo a
  75         a:
  76                 echo a number two
  77
  78 the command "make a" will echo "a".  To make things confusing, the SECOND
  79 variable assignment is the overriding one, i.e. if the Makefile has:
  80
  81         a=      foo
  82         a=      bar
  83
  84         b:
  85                 echo ${a}
  86
  87 the command "make b" will echo "bar".  This is for compatibility with the
  88 way the V7 make behaved.
  89
  90 It's fairly difficult to make the BSD .mk files work when you're building
  91 multiple programs in a single directory.  It's a lot easier split up the
  92 programs than to deal with the problem.  Most of the agony comes from making
  93 the "obj" directory stuff work right, not because we switch to a new version
  94 of make.  So, don't get mad at us, figure out a better way to handle multiple
  95 architectures so we can quit using the symbolic link stuff.  (Imake doesn't
  96 count.)
  97
  98 The file .depend in the source directory is expected to contain dependencies
  99 for the source files.  This file is read automatically by make after reading
 100 the Makefile.
 101
 102 The variable DESTDIR works as before.  It's not set anywhere but will change
 103 the tree where the file gets installed.
 104
 105 The profiled libraries are no longer built in a different directory than
 106 the regular libraries.  A new suffix, ".po", is used to denote a profiled
 107 object.
 108
 109 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 110
 111 The include file <sys.mk> has the default rules for all makes, in the BSD
 112 environment or otherwise.  You probably don't want to touch this file.
 113
 114 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 115
 116 The include file <bsd.man.mk> handles installing manual pages and their
 117 links.
 118
 119 It has three targets:
 120
 121         all-man:
 122                 build manual pages.
 123         maninstall:
 124                 install the manual pages and their links.
 125         manlint:
 126                 verify the validity of manual pages.
 127
 128 It sets/uses the following variables:
 129
 130 MANDIR          Base path for manual installation.
 131
 132 MANGRP          Manual group.
 133
 134 MANOWN          Manual owner.
 135
 136 MANMODE         Manual mode.
 137
 138 MANSUBDIR       Subdirectory under the manual page section, i.e. "/vax"
 139                 or "/tahoe" for machine specific manual pages.
 140
 141 MAN             The manual pages to be installed (use a .1 - .9 suffix).
 142
 143 MANINSTALLFLAGS Additional flags to pass to install(1).
 144
 145 MLINKS          List of manual page links (using a .1 - .9 suffix).  The
 146                 linked-to file must come first, the linked file second,
 147                 and there may be multiple pairs.  The files are hard-linked.
 148
 149 The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
 150 it exists.
 151
 152 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 153
 154 The include file <bsd.own.mk> contains the owners, groups, etc. for both
 155 manual pages and binaries.
 156
 157 It has no targets.
 158
 159 It sets/uses the following variables:
 160
 161 BINGRP          Binary group.
 162
 163 BINOWN          Binary owner.
 164
 165 BINMODE         Binary mode.
 166
 167 STRIP           The flag passed to the install program to cause the binary
 168                 to be stripped.  This is to be used when building your
 169                 own install script so that the entire system can be made
 170                 stripped/not-stripped using a single knob.
 171
 172 MANDIR          Base path for manual installation.
 173
 174 MANGRP          Manual group.
 175
 176 MANOWN          Manual owner.
 177
 178 MANMODE         Manual mode.
 179
 180 This file is generally useful when building your own Makefiles so that
 181 they use the same default owners etc. as the rest of the tree.
 182
 183 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 184
 185 The include file <bsd.prog.mk> handles building programs from one or
 186 more source files, along with their manual pages.  It has a limited number
 187 of suffixes, consistent with the current needs of the BSD tree.
 188
 189 It has seven targets:
 190
 191         all:
 192                 build the program and its manual page
 193         clean:
 194                 remove the program and any object files.
 195         cleandir:
 196                 remove all of the files removed by the target clean, as
 197                 well as .depend, tags, and any manual pages.
 198         depend:
 199                 make the dependencies for the source files, and store
 200                 them in the file .depend.
 201         install:
 202                 install the program and its manual pages; if the Makefile
 203                 does not itself define the target install, the targets
 204                 beforeinstall and afterinstall may also be used to cause
 205                 actions immediately before and after the install target
 206                 is executed.
 207         lint:
 208                 run lint on the source files
 209         tags:
 210                 create a tags file for the source files.
 211
 212 It sets/uses the following variables:
 213
 214 BINGRP          Binary group.
 215
 216 BINOWN          Binary owner.
 217
 218 BINMODE         Binary mode.
 219
 220 CLEANFILES      Additional files to remove and
 221 CLEANDIRS       additional directories to remove during clean and cleandir
 222                 targets.  "rm -f" and "rm -rf" used respectively.
 223
 224 COPTS           Additional flags to the compiler when creating C objects.
 225
 226 FILES           A list of non-executable files.
 227                 The installation is controlled by the FILESNAME, FILESOWN,
 228                 FILESGRP, FILESMODE, FILESDIR variables that can be
 229                 further specialized by <VAR>_<file>.
 230
 231 LDADD           Additional loader objects.  Usually used for libraries.
 232                 For example, to load with the compatibility and utility
 233                 libraries, use:
 234
 235                         LDFILES=-lutil -lcompat
 236
 237 LDFLAGS         Additional loader flags.
 238
 239 LINKS           The list of hard links; should be full pathnames, the
 240                 linked-to file coming first, followed by the linked file.
 241                 For example, to link "/bin/test" and "/bin/[", use:
 242
 243                         LINKS=  /bin/test /bin/[
 244
 245 SYMLINKS        The list of symbolic links.  The linked-to file comes
 246                 first (can be a relative path), followed by the linked
 247                 file (should be a full path).
 248
 249 MAN             Manual pages (should end in .1 - .9).  If no MAN variable
 250                 is defined, "MAN=${PROG}.1" is assumed.
 251
 252 PROG            The name of the program to build.  If not supplied, nothing
 253                 is built.
 254
 255 PROG_CXX        If defined, the name of the program to build.  Also
 256                 causes <bsd.prog.mk> to link the program with the
 257                 standard C++ library.  PROG_CXX overrides the value
 258                 of PROG if PROG is also set.
 259
 260 PROGNAME        The name that the above program will be installed as, if
 261                 different from ${PROG}.
 262
 263 SRCS            List of source files to build the program.  If SRCS is not
 264                 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is
 265                 defined, ${PROG_CXX}.cc.
 266
 267 DPADD           Additional dependencies for the program.  Usually used for
 268                 libraries.  For example, to depend on the compatibility and
 269                 utility libraries use:
 270
 271                         DPADD=  ${LIBCOMPAT} ${LIBUTIL}
 272
 273                 There is a predefined identifier for each (non-profiled,
 274                 non-shared) library and object.  Library file names are
 275                 transformed to identifiers by removing the extension and
 276                 converting to upper case.
 277
 278                 There are no special identifiers for profiled or shared
 279                 libraries or objects.  The identifiers for the standard
 280                 libraries are used in DPADD.  This works correctly iff all
 281                 the libraries are built at the same time.  Unfortunately,
 282                 it causes unnecessary relinks to shared libraries when
 283                 only the static libraries have changed.  Dependencies on
 284                 shared libraries should be only on the library version
 285                 numbers.
 286
 287 STRIP           The flag passed to the install program to cause the binary
 288                 to be stripped.  This is to be used when building your
 289                 own install script so that the entire system can be made
 290                 stripped/not-stripped using a single knob.
 291
 292 SUBDIR          A list of subdirectories that should be built as well.
 293                 Each of the targets will execute the same target in the
 294                 subdirectories.
 295
 296 SCRIPTS         A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
 297                 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN,
 298                 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be
 299                 further specialized by SCRIPTS<VAR>_<script>.
 300
 301 The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
 302 if it exists, as well as the include file <bsd.man.mk>.
 303
 304 Some simple examples:
 305
 306 To build foo from foo.c with a manual page foo.1, use:
 307
 308         PROG=   foo
 309
 310         .include <bsd.prog.mk>
 311
 312 To build foo from foo.c with a manual page foo.2, add the line:
 313
 314         MAN=    foo.2
 315
 316 If foo does not have a manual page at all, add the line:
 317
 318         NOMAN=  noman
 319
 320 If foo has multiple source files, add the line:
 321
 322         SRCS=   a.c b.c c.c d.c
 323
 324 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 325
 326 The include file <bsd.subdir.mk> contains the default targets for building
 327 subdirectories.  It has the same seven targets as <bsd.prog.mk>: all, clean,
 328 cleandir, depend, install, lint, and tags.  For all of the directories
 329 listed in the variable SUBDIRS, the specified directory will be visited
 330 and the target made.  There is also a default target which allows the
 331 command "make subdir" where subdir is any directory listed in the variable
 332 SUBDIRS.
 333
 334 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
 335
 336 The include file <bsd.lib.mk> has support for building libraries.  It has
 337 the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend,
 338 install, lint, and tags.  It has a limited number of suffixes, consistent
 339 with the current needs of the BSD tree.
 340
 341 It sets/uses the following variables:
 342
 343 LIBDIR          Target directory for libraries.
 344
 345 LINTLIBDIR      Target directory for lint libraries.
 346
 347 LIBGRP          Library group.
 348
 349 LIBOWN          Library owner.
 350
 351 LIBMODE         Library mode.
 352
 353 LDADD           Additional loader objects.
 354
 355 MAN             The manual pages to be installed (use a .1 - .9 suffix).
 356
 357 SRCS            List of source files to build the library.  Suffix types
 358                 .s, .c, and .f are supported.  Note, .s files are preferred
 359                 to .c files of the same name.  (This is not the default for
 360                 versions of make.)
 361
 362 The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
 363 if it exists, as well as the include file <bsd.man.mk>.
 364
 365 It has rules for building profiled objects; profiled libraries are
 366 built by default.
 367
 368 Libraries are ranlib'd before installation.