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