Annotation of src/share/mk/bsd.README, Revision 1.87
1.87 ! thorpej 1: # $NetBSD: bsd.README,v 1.86 2001/12/31 23:11:05 thorpej Exp $
1.24 mikel 2: # @(#)bsd.README 8.2 (Berkeley) 4/2/94
1.1 cgd 3:
4: This is the README file for the new make "include" files for the BSD
5: source tree. The files are installed in /usr/share/mk, and are, by
1.11 jtc 6: convention, named with the suffix ".mk".
1.1 cgd 7:
8: Note, this file is not intended to replace reading through the .mk
9: files for anything tricky.
10:
11: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
12:
13: RANDOM THINGS WORTH KNOWING:
14:
15: The files are simply C-style #include files, and pretty much behave like
16: you'd expect. The syntax is slightly different in that a single '.' is
17: used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
18:
19: One difference that will save you lots of debugging time is that inclusion
20: of the file is normally done at the *end* of the Makefile. The reason for
21: this is because .mk files often modify variables and behavior based on the
22: values of variables set in the Makefile. To make this work, remember that
23: the FIRST target found is the target that is used, i.e. if the Makefile has:
24:
25: a:
26: echo a
27: a:
28: echo a number two
29:
30: the command "make a" will echo "a". To make things confusing, the SECOND
31: variable assignment is the overriding one, i.e. if the Makefile has:
32:
33: a= foo
34: a= bar
35:
36: b:
37: echo ${a}
38:
39: the command "make b" will echo "bar". This is for compatibility with the
40: way the V7 make behaved.
41:
42: It's fairly difficult to make the BSD .mk files work when you're building
1.75 agc 43: multiple programs in a single directory. It's a lot easier to split up the
1.1 cgd 44: programs than to deal with the problem. Most of the agony comes from making
1.36 ross 45: the "obj" directory stuff work right, not because we switched to a new version
1.1 cgd 46: of make. So, don't get mad at us, figure out a better way to handle multiple
47: architectures so we can quit using the symbolic link stuff. (Imake doesn't
48: count.)
49:
50: The file .depend in the source directory is expected to contain dependencies
51: for the source files. This file is read automatically by make after reading
52: the Makefile.
53:
54: The variable DESTDIR works as before. It's not set anywhere but will change
55: the tree where the file gets installed.
56:
57: The profiled libraries are no longer built in a different directory than
58: the regular libraries. A new suffix, ".po", is used to denote a profiled
1.21 christos 59: object, and ".so" denotes a shared (position-independent) object.
60:
1.45 lukem 61: The following variables that control how things are made/installed that
1.47 tv 62: are not set by default. These should not be set by Makefiles; they're for
63: the user to define in MAKECONF (see bsd.own.mk, below) or on the make(1)
64: command line:
1.21 christos 65:
1.45 lukem 66: BUILD If defined, 'make install' checks that the targets in the
67: source directories are up-to-date and remakes them if they
1.21 christos 68: are out of date, instead of blindly trying to install
1.79 wiz 69: out of date or non-existent targets.
1.21 christos 70:
1.45 lukem 71: UPDATE If defined, 'make install' only installs targets that are
72: more recently modified in the source directories that their
73: installed counterparts.
1.52 simonb 74:
1.83 perry 75: UNPRIVED If defined, don't set the owner/group/mode when installing
76: files or directories, and keep a metadata log of what
77: the owner/group/mode should be. This allows a
78: non-root "make install".
1.45 lukem 79:
1.86 thorpej 80: MKBFD If "no", don't build libbfd, libiberty, or any of
81: the things that depend on them (binutils/gas/ld,
82: gdb, dbsym, mdsetimage). Only meaningful if
83: USE_NEW_TOOLCHAIN is set.
84:
1.45 lukem 85: MKCATPAGES If "no", don't build or install the catman pages.
86:
87: MKDOC If "no", don't build or install the documentation.
1.86 thorpej 88:
89: MKGDB If "no", don't build gdb. Only meaningful if
90: USE_NEW_TOOLCHAIN is set.
91:
92: MKGCC If "no", don't build gcc or any of the gcc-related
93: libraries (libg2c, libgcc, libobjc, libstdc++).
94: Only meaningful if USE_NEW_TOOLCHAIN is set.
1.45 lukem 95:
1.47 tv 96: MKINFO If "no", don't build or install Info documentation from
97: Texinfo source files.
1.45 lukem 98:
99: MKLINT If "no", don't build or install the lint libraries.
100:
101: MKMAN If "no", don't build or install the man or catman pages.
1.46 lukem 102: Also acts as "MKCATPAGES=no"
1.45 lukem 103:
1.74 itojun 104: MKNLS If "no", don't build or install the NLS files and locale
105: definition files.
1.45 lukem 106:
1.55 sommerfe 107: MKOBJ If "no", don't enable the rule which creates objdirs.
108: "yes" by default.
109:
110: MKOBJDIRS If "no", don't create objdirs during a "make build".
111: "no" by default.
1.45 lukem 112:
113: MKPIC If "no", don't build or install shared libraries.
114:
115: MKPICINSTALL If "no", don't install the *_pic.a libraries.
116:
117: MKPROFILE If "no", don't build or install the profiling libraries.
118:
1.48 lukem 119: MKSHARE If "no", act as "MKCATPAGES=no MKDOC=no MKINFO=no MKMAN=no
120: MKNLS=no". I.e, don't build catman pages, documentation,
121: Info documentation, man pages, NLS files, ...
1.1 cgd 122:
123: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
124:
125: The include file <sys.mk> has the default rules for all makes, in the BSD
126: environment or otherwise. You probably don't want to touch this file.
1.71 itojun 127: If you intend to run a cross build, you will need to supply the following
128: host tools, and configure the following variables properly:
129:
130: OBJCOPY objcopy - copy and translate object files
131:
132: STRIP strip - Discard symbols from object files
133:
134: CONFIG config - build kernel compilation directories
135:
136: RPCGEN rpcgen - Remote Procedure Call (RPC) protocol compiler
137:
138: MKLOCALE mklocale - make LC_CTYPE locale files
1.80 jmc 139:
140: MTREE mtree - build directory tree from a spec file
1.1 cgd 141:
142: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
143:
144: The include file <bsd.man.mk> handles installing manual pages and their
145: links.
146:
1.21 christos 147: It has a two targets:
1.1 cgd 148:
149: maninstall:
1.21 christos 150: Install the manual page sources and their links.
151: catinstall:
152: Install the preformatted manual pages and their links.
1.1 cgd 153:
154: It sets/uses the following variables:
155:
156: MANDIR Base path for manual installation.
157:
158: MANGRP Manual group.
159:
160: MANOWN Manual owner.
161:
162: MANMODE Manual mode.
163:
164: MANSUBDIR Subdirectory under the manual page section, i.e. "/vax"
165: or "/tahoe" for machine specific manual pages.
166:
1.15 cgd 167: MAN The manual pages to be installed (use a .1 - .9 suffix).
1.1 cgd 168:
1.15 cgd 169: MLINKS List of manual page links (using a .1 - .9 suffix). The
1.1 cgd 170: linked-to file must come first, the linked file second,
171: and there may be multiple pairs. The files are soft-linked.
172:
173: The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
174: it exists.
175:
176: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
177:
1.17 thorpej 178: The include file <bsd.own.mk> contains source tree configuration parameters,
179: such as the owners, groups, etc. for both manual pages and binaries, and
180: a few global "feature configuration" parameters.
1.1 cgd 181:
182: It has no targets.
183:
1.29 cjs 184: To get system-specific configuration parameters, bsd.own.mk will try to
185: include the file specified by the "MAKECONF" variable. If MAKECONF is not
186: set, or no such file exists, the system make configuration file, /etc/mk.conf
187: is included. These files may define any of the variables described below.
1.17 thorpej 188:
189: bsd.own.mk sets the following variables, if they are not already defined
190: (defaults are in brackets):
1.15 cgd 191:
192: BSDSRCDIR The real path to the system sources, so that 'make obj'
193: will work correctly. [/usr/src]
194:
195: BSDOBJDIR The real path to the system 'obj' tree, so that 'make obj'
196: will work correctly. [/usr/obj]
197:
1.34 lukem 198: BINGRP Binary group. [wheel]
1.15 cgd 199:
1.34 lukem 200: BINOWN Binary owner. [root]
1.15 cgd 201:
202: BINMODE Binary mode. [555]
203:
204: NONBINMODE Mode for non-executable files. [444]
205:
206: MANDIR Base path for manual installation. [/usr/share/man/cat]
207:
1.34 lukem 208: MANGRP Manual group. [wheel]
1.15 cgd 209:
1.34 lukem 210: MANOWN Manual owner. [root]
1.15 cgd 211:
212: MANMODE Manual mode. [${NONBINMODE}]
213:
1.21 christos 214: MANINSTALL Manual installation type: maninstall, catinstall, or both
1.76 fair 215:
216: LDSTATIC Control program linking; if set blank, link everything
217: dynamically. If set to "-static", link everything statically.
218: If not set, programs link according to their makefile.
1.21 christos 219:
1.15 cgd 220: LIBDIR Base path for library installation. [/usr/lib]
221:
1.85 lukem 222: SHLIBDIR If ${USE_SHLIBDIR} is "yes", use ${SHLIBDIR} instead of
223: ${LIBDIR} as the base path for shared library installation.
224: [/usr/lib]
225:
226: _LIBSODIR Set to ${SHLIBDIR} if ${USE_SHLIBDIR} is "yes",
227: otherwise set to ${LIBDIR}
228:
229: SHLINKDIR Base path for shared linker. [/usr/libexec]
230:
1.15 cgd 231: LINTLIBDIR Base path for lint(1) library installation. [/usr/libdata/lint]
232:
233: LIBGRP Library group. [${BINGRP}]
234:
235: LIBOWN Library owner. [${BINOWN}]
236:
237: LIBMODE Library mode. [${NONBINMODE}]
238:
239: DOCDIR Base path for system documentation (e.g. PSD, USD, etc.)
240: installation. [/usr/share/doc]
1.62 simonb 241:
242: HTMLDOCDIR Base path for html system documentation installation.
243: [/usr/share/doc/html]
1.15 cgd 244:
1.34 lukem 245: DOCGRP Documentation group. [wheel]
1.15 cgd 246:
1.34 lukem 247: DOCOWN Documentation owner. [root]
1.15 cgd 248:
249: DOCMODE Documentation mode. [${NONBINMODE}]
250:
1.84 kleink 251: NLSDIR Base path for Native Language Support files installation.
1.15 cgd 252: [/usr/share/nls]
1.1 cgd 253:
1.84 kleink 254: NLSGRP Native Language Support files group. [wheel]
1.1 cgd 255:
1.84 kleink 256: NLSOWN Native Language Support files owner. [root]
1.1 cgd 257:
1.84 kleink 258: NLSMODE Native Language Support files mode. [${NONBINMODE}]
1.1 cgd 259:
1.32 mikel 260: STRIPFLAG The flag passed to the install program to cause the binary
1.1 cgd 261: to be stripped. This is to be used when building your
262: own install script so that the entire system can be made
1.15 cgd 263: stripped/not-stripped using a single knob. [-s]
1.1 cgd 264:
1.2 cgd 265: COPY The flag passed to the install program to cause the binary
266: to be copied rather than moved. This is to be used when
267: building our own install script so that the entire system
268: can either be installed with copies, or with moves using
1.15 cgd 269: a single knob. [-c]
270:
1.17 thorpej 271: Additionally, the following variables may be set by bsd.own.mk or in a
272: make configuration file to modify the behaviour of the system build
273: process (default values are in brackets along with comments, if set by
274: bsd.own.mk):
1.15 cgd 275:
1.64 thorpej 276: MKCRYPTO If set to "no", no cryptography support will be built
277: into the system. Defaults to "yes".
278:
279: NOCRYPTO If set, it is equivalent to setting MKCRYPTO to "no".
280:
1.66 itojun 281: MKCRYPTO_IDEA If set to "yes", IDEA support will be built into
282: libcrypto_idea.a. Defaults to "no".
1.64 thorpej 283:
1.66 itojun 284: MKCRYPTO_RC5 If set to "yes", RC5 support will be built into
285: libcrypto_rc5.a. Defaults to "no".
1.64 thorpej 286:
287: MKKERBEROS If set to "no", disables building Kerberos (v4 or v5)
288: support into various system utilities that support it.
289: Defaults to "yes". NOTE: This does not affect the
290: building of the Kerberos libraries or infrastructure
291: programs themselves. To completely disable Kerberos,
292: set MKCRYPTO to "no".
293:
294: NOKERBEROS If set, it is equivalent to setting MKKERBEROS to "no".
1.2 cgd 295:
1.15 cgd 296: SKEY Compile in support for S/key authentication. [yes, set
297: unconditionally]
298:
299: MANZ Compress manual pages at installation time.
300:
301: SYS_INCLUDE Copy or symlink kernel include files into /usr/include.
302: Possible values are "symlinks" or "copies" (which is
303: the same as the variable being unset).
1.1 cgd 304:
1.15 cgd 305: NOPROFILE Do not build profiled versions of system libraries
1.1 cgd 306:
1.15 cgd 307: NOPIC Do not build PIC versions of system libraries, and
308: do not build shared libraries. [set if ${MACHINE_ARCH}
1.65 jlam 309: is "sh3" and ${OBJECT_FMT} is "COFF", unset otherwise.]
1.1 cgd 310:
1.40 perry 311: NOLINT Do not build lint libraries.
1.33 jonathan 312:
1.50 thorpej 313: OBJECT_FMT Object file format. [set to "ELF" on architectures that
314: use ELF -- currently if ${MACHINE_ARCH} is "alpha",
315: "mipsel", "mipseb", "powerpc", "sparc", "sparc64",
1.77 simonb 316: "i386" and some m68k machines, or set to "a.out" on
317: other architectures].
1.33 jonathan 318:
1.78 simonb 319: MKSOFTFLOAT If "yes", build with options to enable the compiler to
320: generate output containing library calls for floating
321: point and possibly soft-float library support. Defaults
322: to "no".
1.1 cgd 323:
1.17 thorpej 324: bsd.own.mk is generally useful when building your own Makefiles so that
1.1 cgd 325: they use the same default owners etc. as the rest of the tree.
326:
327: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
328:
329: The include file <bsd.prog.mk> handles building programs from one or
330: more source files, along with their manual pages. It has a limited number
331: of suffixes, consistent with the current needs of the BSD tree.
332:
1.16 jtc 333: It has eight targets:
1.1 cgd 334:
335: all:
336: build the program and its manual page
337: clean:
338: remove the program, any object files and the files a.out,
1.24 mikel 339: Errs, errs, mklog, and ${PROG}.core.
1.1 cgd 340: cleandir:
341: remove all of the files removed by the target clean, as
342: well as .depend, tags, and any manual pages.
1.42 lukem 343: `distclean' is a synonym for `cleandir'.
1.1 cgd 344: depend:
345: make the dependencies for the source files, and store
346: them in the file .depend.
1.16 jtc 347: includes:
348: install any header files.
1.1 cgd 349: install:
350: install the program and its manual pages; if the Makefile
351: does not itself define the target install, the targets
352: beforeinstall and afterinstall may also be used to cause
353: actions immediately before and after the install target
354: is executed.
355: lint:
356: run lint on the source files
357: tags:
358: create a tags file for the source files.
359:
360: It sets/uses the following variables:
361:
362: BINGRP Binary group.
363:
364: BINOWN Binary owner.
365:
366: BINMODE Binary mode.
367:
368: CLEANFILES Additional files to remove for the clean and cleandir targets.
369:
370: COPTS Additional flags to the compiler when creating C objects.
1.35 lukem 371:
372: CPPFLAGS Additional flags to the C pre-processor
1.1 cgd 373:
374: LDADD Additional loader objects. Usually used for libraries.
375: For example, to load with the compatibility and utility
376: libraries, use:
377:
1.5 jtc 378: LDADD+=-lutil -lcompat
1.1 cgd 379:
380: LDFLAGS Additional loader flags.
381:
382: LINKS The list of binary links; should be full pathnames, the
383: linked-to file coming first, followed by the linked
384: file. The files are hard-linked. For example, to link
385: /bin/test and /bin/[, use:
386:
387: LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[
1.19 perry 388:
389: SYMLINKS The list of symbolic links; should be full pathnames.
1.20 perry 390: Syntax is identical to LINKS. Note that DESTDIR is not
391: automatically included in the link.
1.1 cgd 392:
1.15 cgd 393: MAN Manual pages (should end in .1 - .9). If no MAN variable is
1.8 cgd 394: defined, "MAN=${PROG}.1" is assumed.
1.1 cgd 395:
396: PROG The name of the program to build. If not supplied, nothing
397: is built.
398:
1.87 ! thorpej 399: PROG_CXX If defined, causes <bsd.prog.mk> to link the program with
! 400: the C++ compiler rather than the C compiler.
! 401:
1.21 christos 402: PROGNAME The name that the above program will be installed as, if
403: different from ${PROG}.
404:
1.37 tv 405: SRCS List of source files to build the program. If SRCS is not
1.1 cgd 406: defined, it's assumed to be ${PROG}.c.
407:
408: DPADD Additional dependencies for the program. Usually used for
409: libraries. For example, to depend on the compatibility and
410: utility libraries use:
411:
1.5 jtc 412: DPADD+=${LIBCOMPAT} ${LIBUTIL}
1.1 cgd 413:
414: The following libraries are predefined for DPADD:
415:
1.21 christos 416: LIBCRT0?= ${DESTDIR}/usr/lib/crt0.o
417: LIBC?= ${DESTDIR}/usr/lib/libc.a
418: LIBC_PIC?= ${DESTDIR}/usr/lib/libc_pic.a
419: LIBCOMPAT?= ${DESTDIR}/usr/lib/libcompat.a
420: LIBCRYPT?= ${DESTDIR}/usr/lib/libcrypt.a
421: LIBCURSES?= ${DESTDIR}/usr/lib/libcurses.a
422: LIBDBM?= ${DESTDIR}/usr/lib/libdbm.a
423: LIBDES?= ${DESTDIR}/usr/lib/libdes.a
424: LIBEDIT?= ${DESTDIR}/usr/lib/libedit.a
1.73 blymn 425: LIBFORM?= ${DESTDIR}/usr/lib/libform.a
1.21 christos 426: LIBGCC?= ${DESTDIR}/usr/lib/libgcc.a
427: LIBGNUMALLOC?= ${DESTDIR}/usr/lib/libgnumalloc.a
1.70 itojun 428: LIBINTL?= ${DESTDIR}/usr/lib/libintl.a
1.49 itojun 429: LIBIPSEC?= ${DESTDIR}/usr/lib/libipsec.a
1.21 christos 430: LIBKDB?= ${DESTDIR}/usr/lib/libkdb.a
431: LIBKRB?= ${DESTDIR}/usr/lib/libkrb.a
432: LIBKVM?= ${DESTDIR}/usr/lib/libkvm.a
433: LIBL?= ${DESTDIR}/usr/lib/libl.a
434: LIBM?= ${DESTDIR}/usr/lib/libm.a
1.53 blymn 435: LIBMENU?= ${DESTDIR}/usr/lib/libmenu.a
1.21 christos 436: LIBMP?= ${DESTDIR}/usr/lib/libmp.a
1.25 christos 437: LIBNTP?= ${DESTDIR}/usr/lib/libntp.a
1.21 christos 438: LIBPC?= ${DESTDIR}/usr/lib/libpc.a
439: LIBPCAP?= ${DESTDIR}/usr/lib/libpcap.a
440: LIBPLOT?= ${DESTDIR}/usr/lib/libplot.a
1.26 kleink 441: LIBPOSIX?= ${DESTDIR}/usr/lib/libposix.a
1.21 christos 442: LIBRESOLV?= ${DESTDIR}/usr/lib/libresolv.a
443: LIBRPCSVC?= ${DESTDIR}/usr/lib/librpcsvc.a
444: LIBSKEY?= ${DESTDIR}/usr/lib/libskey.a
445: LIBTERMCAP?= ${DESTDIR}/usr/lib/libtermcap.a
446: LIBTELNET?= ${DESTDIR}/usr/lib/libtelnet.a
447: LIBUTIL?= ${DESTDIR}/usr/lib/libutil.a
448: LIBWRAP?= ${DESTDIR}/usr/lib/libwrap.a
449: LIBY?= ${DESTDIR}/usr/lib/liby.a
450: LIBZ?= ${DESTDIR}/usr/lib/libz.a
451:
1.87 ! thorpej 452: HAVE_GCC3 If defined and PROG_CXX is defined by the program's
! 453: Makefile, causes <bsd.prog.mk> to pull in additional
! 454: C++ support libraries required for programs compiled
! 455: with GNU C++ 3.x. This is intended as a temporary
! 456: measure to ease the transition to GCC 3.x.
1.1 cgd 457:
458: SHAREDSTRINGS If defined, a new .c.o rule is used that results in shared
1.12 christos 459: strings, using xstr(1). Note that this will not work with
460: parallel makes.
1.1 cgd 461:
1.59 jlam 462: STRIPFLAG The flag passed to the install program to cause the binary
1.1 cgd 463: to be stripped.
464:
465: SUBDIR A list of subdirectories that should be built as well.
466: Each of the targets will execute the same target in the
467: subdirectories.
468:
1.21 christos 469: SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}].
470: These are installed exactly like programs.
471:
472: SCRIPTSNAME The name that the above program will be installed as, if
473: different from ${SCRIPTS}. These can be further specialized
474: by setting SCRIPTSNAME_<script>.
475:
476: FILES A list of files to install. The installation is controlled
477: by the FILESNAME, FILESOWN, FILESGRP, FILESMODE, FILESDIR
478: variables that can be further specialized by FILES<VAR>_<file>
479:
1.85 lukem 480: SHLINKDIR Target directory for shared linker.
481:
1.1 cgd 482: The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
483: if it exists, as well as the include file <bsd.man.mk>.
484:
485: Some simple examples:
486:
487: To build foo from foo.c with a manual page foo.1, use:
488:
489: PROG= foo
490:
491: .include <bsd.prog.mk>
492:
493: To build foo from foo.c with a manual page foo.2, add the line:
494:
1.9 cgd 495: MAN= foo.2
1.1 cgd 496:
497: If foo does not have a manual page at all, add the line:
498:
1.75 agc 499: MKMAN= no
1.1 cgd 500:
501: If foo has multiple source files, add the line:
502:
503: SRCS= a.c b.c c.c d.c
504:
505: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
506:
507: The include file <bsd.subdir.mk> contains the default targets for building
1.16 jtc 508: subdirectories. It has the same eight targets as <bsd.prog.mk>: all,
509: clean, cleandir, depend, includes, install, lint, and tags. For all of
1.72 sommerfe 510: the directories listed in the variable SUBDIR, the specified directory
1.16 jtc 511: will be visited and the target made. There is also a default target which
512: allows the command "make subdir" where subdir is any directory listed in
1.72 sommerfe 513: the variable SUBDIR.
514:
515: As a special case, the use of a token .WAIT as an entry in SUBDIR acts
516: as a synchronization barrier when multiple make jobs are run; subdirs
517: before the .WAIT must complete before any subdirs after .WAIT are
1.75 agc 518: started. See make(1) for some caveats on use of .WAIT and other
519: special sources.
1.21 christos 520:
521: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
522:
1.23 christos 523: The include file <bsd.links.mk> handles the LINKS and SYMLINKS variables
524: and is included from from bsd.lib.mk and bsd.prog.mk.
525:
526: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
527:
528: The include file <bsd.files.mk> handles the FILES variables and is included
529: from bsd.lib.mk and bsd.prog.mk.
1.21 christos 530:
531: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
532:
1.29 cjs 533: The include file <bsd.inc.mk> defines the includes target and uses two
534: variables:
1.21 christos 535:
1.81 wiz 536: INCS The list of include files
1.21 christos 537:
1.81 wiz 538: INCSDIR The location to install the include files.
539:
540: INCSNAME Target name of the include file, if only one; same as
541: FILESNAME, but for include files.
542:
543: INCSNAME_<file> The name file <file> should be installed as, if not <file>,
544: same as FILESNAME_<file>, but for include files.
1.39 cgd 545:
546: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
547:
548: The include file <bsd.kinc.mk> defines the many targets (includes,
549: subdirectories, etc.), and is used by kernel makefiles to handle
550: include file installation. It is intended to be included alone, by
551: kernel Makefiles. Please see bsd.kinc.mk for more details, and keep
552: the documentation in that file up to date.
1.13 christos 553:
554: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
555:
1.47 tv 556: The include file <bsd.info.mk> is used to generate and install GNU Info
557: documentation from respective Texinfo source files. It defines three
558: implicit targets (.txi.info, .texi.info, and .texinfo.info), and uses the
559: following variables:
560:
561: TEXINFO List of Texinfo source files. Info documentation will
562: consist of single files with the extension replaced by
563: .info.
564:
565: INFOFLAGS Flags to pass to makeinfo. []
566:
567: INSTALL_INFO Name of install-info program. [install-info]
568:
569: MAKEINFO Name of makeinfo program. [makeinfo]
570:
571: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
572:
1.13 christos 573: The include file <bsd.sys.mk> is used by <bsd.prog.mk> and
1.14 cgd 574: <bsd.lib.mk>. It contains overrides that are used when building
575: the NetBSD source tree. For instance, if "PARALLEL" is defined by
576: the program/library Makefile, it includes a set of rules for lex and
577: yacc that allow multiple lex and yacc targets to be built in parallel.
1.69 sommerfe 578:
579: Other variables of note (incomplete list):
580:
1.82 lukem 581: WARNS Crank up gcc warning options; the distinct levels are:
582: WARNS=1
583: WARNS=2
584: WARNS=3
1.69 sommerfe 585:
586: FORMAT_AUDIT If FORMAT_AUDIT is set, and WFORMAT is set and > 1, turn on
587: WFORMAT -Wnetbsd-format-audit for extra-stringent format checking.
1.75 agc 588: WFORMAT belongs in individual makefiles and/or
589: Makefile.inc files. (set WFORMAT=1 in individual
590: makefiles if a program is not security critical and is
591: doing bizarre things with format strings which would
592: be even uglier if rewritten) FORMAT_AUDIT should go in
593: mk.conf if you're doing format-string auditing.
1.69 sommerfe 594: FORMAT_AUDIT may go away in time.
1.1 cgd 595:
596: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
597:
598: The include file <bsd.lib.mk> has support for building libraries. It has
1.16 jtc 599: the same eight targets as <bsd.prog.mk>: all, clean, cleandir, depend,
1.44 erh 600: includes, install, lint, and tags. Additionally, it has a checkver target
601: which checks for installed shared object libraries whose version is greater
602: that the version of the source. It has a limited number of suffixes,
1.16 jtc 603: consistent with the current needs of the BSD tree.
1.1 cgd 604:
605: It sets/uses the following variables:
1.10 cgd 606:
607: LIB The name of the library to build.
1.1 cgd 608:
609: LIBDIR Target directory for libraries.
1.85 lukem 610:
611: SHLIBDIR Target directory for shared libraries if ${USE_SHLIBDIR}
612: is "yes".
613:
614: USE_SHLIBDIR If "yes", use ${SHLIBDIR} instead of ${LIBDIR}
615: as the path to install shared libraries to.
1.1 cgd 616:
617: LINTLIBDIR Target directory for lint libraries.
618:
619: LIBGRP Library group.
620:
621: LIBOWN Library owner.
622:
623: LIBMODE Library mode.
624:
625: LDADD Additional loader objects.
626:
1.15 cgd 627: MAN The manual pages to be installed (use a .1 - .9 suffix).
1.47 tv 628:
629: MKLINKLIB If "no", act as "MKPICINSTALL=no MKPROFILE=no".
630: Also:
631: - don't install the .a libraries
632: - don't install _pic.a libraries on PIC systems
633: - don't build .a libraries on PIC systems
634: - don't install the .so symlink on ELF systems
635: I.e, only install the shared library (and the .so.major
636: symlink on ELF).
1.54 simonb 637:
638: MKPICLIB If "no", don't build _pic.a libraries, and build the
639: shared object libraries from the .a libraries. A
640: symlink is installed in ${DESTDIR}/usr/lib for the
641: _pic.a library pointing to the .a library.
1.44 erh 642:
643: NOCHECKVER_<library>
644: NOCHECKVER If set, disables checking for installed shared object
645: libraries with versions greater than the source. A
646: particular library name, without the "lib" prefix, may
647: be appended to the variable name to disable the check for
648: only that library.
1.1 cgd 649:
650: SRCS List of source files to build the library. Suffix types
651: .s, .c, and .f are supported. Note, .s files are preferred
652: to .c files of the same name. (This is not the default for
653: versions of make.)
654:
655: The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
656: if it exists, as well as the include file <bsd.man.mk>.
657:
658: It has rules for building profiled objects; profiled libraries are
659: built by default.
660:
1.4 cgd 661: Libraries are ranlib'd when made.
1.56 sommerfe 662:
663: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
664:
665: The include file <bsd.obj.mk> defines targets related to the creation
666: and use of separated object and source directories.
667:
1.63 sjg 668: If an environment variable named MAKEOBJDIRPREFIX is set, make(1) uses
669: ${MAKEOBJDIRPREFIX}${.CURDIR} as the name of the object directory if
1.75 agc 670: it exists. Otherwise make(1) looks for the existence of a
1.63 sjg 671: subdirectory (or a symlink to a directory) of the source directory
672: into which built targets should be placed. If an environment variable
673: named MAKEOBJDIR is set, make(1) uses its value as the name of the
674: object directory; failing that, make first looks for a subdirectory
675: named "obj.${MACHINE}", and if that doesn't exist, it looks for "obj".
1.56 sommerfe 676:
677: Object directories are not created automatically by make(1) if they
678: don't exist; you need to run a separate "make obj". (This will happen
679: during a top-level build if "MKOBJDIRS" is set to a value other than
1.58 sommerfe 680: "no"). When the source directory is a subdirectory of ${BSDSRCDIR} --
681: and this is determined by a simple string prefix comparison -- object
682: directories are created in a separate object directory tree, and a
683: symlink to the object directory in that tree is created in the source
684: directory; otherwise, "make obj" assumes that you're not in the main
685: source tree and that it's not safe to use a separate object tree.
1.56 sommerfe 686:
687: Several variables used by <bsd.obj.mk> control exactly what
688: directories and links get created during a "make obj":
689:
690: MAKEOBJDIR If set, this is the component name of the object
691: directory.
692:
693: OBJMACHINE If this is set but MAKEOBJDIR is not set, creates
694: object directories or links named "obj.${MACHINE}";
695: otherwise, just creates ones named "obj".
696:
697: USR_OBJMACHINE If set, and the current directory is a subdirectory of
698: ${BSDSRCDIR}, create object directory in the
699: corresponding subdirectory of ${BSDOBJDIR}.${MACHINE};
700: otherwise, create it in the corresponding subdirectory
701: of ${BSDOBJDIR}
1.63 sjg 702:
703: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
704:
705: The include file <bsd.kernobj.mk> defines variables related to the
706: location of kernel sources and object directories.
707:
708: KERNSRCDIR Is the location of the top of the kernel src.
709: It defaults to ${BSDSRCDIR}/sys, but the top-level
710: Makefile.inc sets it to ${ABSTOP}/sys (ABSTOP is the
711: absolute path to the directory where the top-level
712: Makefile.inc was found.
713:
714: KERNARCHDIR Is the location of the machine dependent kernel
715: sources. It defaults to arch/${MACHINE}
716:
717: KERNCONFDIR Is where the configuration files for kernels are
718: found; default is ${KERNSRCDIR}/${KERNARCHDIR}/conf.
719:
720: KERNOBJDIR Is the kernel build directory. The kernel GENERIC for
721: instance will be compiled in ${KERNOBJDIR}/GENERIC.
722: The default value is
723: ${MAKEOBJDIRPREFIX}${KERNSRCDIR}/${KERNARCHDIR}/compile
724: if it exists or the target 'obj' is being made.
725: Otherwise the default is
726: ${KERNSRCDIR}/${KERNARCHDIR}/compile.
727:
728: It is important that Makefiles (such as those under src/distrib) that
729: wish to find compiled kernels use bsd.kernobj.mk and ${KERNOBJDIR}
730: rather than make assumptions about the location of the compiled kernel.
1.30 agc 731:
732: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
CVSweb <webmaster@jp.NetBSD.org>