Annotation of src/share/mk/bsd.README, Revision 1.70
1.70 ! espie 1: # $OpenBSD: bsd.README,v 1.69 2017/07/09 18:28:44 espie Exp $
1.8 deraadt 2: # $NetBSD: bsd.README,v 1.17 1996/04/13 02:08:08 thorpej Exp $
1.1 deraadt 3: # @(#)bsd.README 5.1 (Berkeley) 5/11/90
4:
5: This is the README file for the new make "include" files for the BSD
6: source tree. The files are installed in /usr/share/mk, and are, by
7: convention, named with the suffix ".mk".
1.17 espie 8:
9: bsd.dep.mk - handle Makefile dependencies
10: bsd.lib.mk - support for building libraries
11: bsd.man.mk - installing manual pages and their links
12: bsd.obj.mk - creating 'obj' directories and cleaning up
13: bsd.own.mk - define common variables
14: bsd.port.mk - building ports
1.46 espie 15: bsd.port.arch.mk - glue for building ports with MD stuff
1.17 espie 16: bsd.port.subdir.mk - targets for building subdirectories for ports
17: bsd.prog.mk - building programs from source files
1.30 provos 18: bsd.regress.mk - regression tests
19: bsd.subdir.mk - targets for building subdirectories
1.17 espie 20: bsd.sys.mk - building bsd from the source tree
1.1 deraadt 21:
22: Note, this file is not intended to replace reading through the .mk
23: files for anything tricky.
24:
25: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
26:
27: RANDOM THINGS WORTH KNOWING:
28:
29: The files are simply C-style #include files, and pretty much behave like
30: you'd expect. The syntax is slightly different in that a single '.' is
31: used instead of the hash mark, i.e. ".include <bsd.prog.mk>".
32:
33: One difference that will save you lots of debugging time is that inclusion
34: of the file is normally done at the *end* of the Makefile. The reason for
35: this is because .mk files often modify variables and behavior based on the
36: values of variables set in the Makefile. To make this work, remember that
37: the FIRST target found is the target that is used, i.e. if the Makefile has:
38:
39: a:
40: echo a
41: a:
42: echo a number two
43:
44: the command "make a" will echo "a". To make things confusing, the SECOND
45: variable assignment is the overriding one, i.e. if the Makefile has:
46:
47: a= foo
48: a= bar
49:
50: b:
51: echo ${a}
52:
53: the command "make b" will echo "bar". This is for compatibility with the
54: way the V7 make behaved.
55:
1.23 espie 56: To make things even more confusing, make uses lazy evaluation. All
57: variables are expanded only when needed. Which means that, in
58:
59: a= foo
60:
61: b: $(a)
62: echo $(.ALLSRC)
63: echo $(a)
64:
65: foo:
66: touch foo
67:
68: a= bar
69:
1.68 espie 70: the command "make b" will echo "foo"; echo "bar". The first $(a) means
71: "foo", because it's needed to generate the dependency rule when it's read,
1.23 espie 72: but the second $(a) is only expanded when needed, at which point a contains
73: bar.
74:
1.1 deraadt 75: It's fairly difficult to make the BSD .mk files work when you're building
1.16 espie 76: multiple programs in a single directory. It's a lot easier to split up the
1.1 deraadt 77: programs than to deal with the problem. Most of the agony comes from making
1.16 espie 78: the "obj" directory stuff work right, not because we switched to a new version
1.1 deraadt 79: of make. So, don't get mad at us, figure out a better way to handle multiple
80: architectures so we can quit using the symbolic link stuff. (Imake doesn't
81: count.)
82:
1.66 espie 83: Dependencies are handled using the compiler's -M* options, resulting in
1.68 espie 84: lots of .d files. These are manually included through <bsd.dep.mk>.
85:
86: <bsd.dep.mk> also provides an empty depend target to <bsd.prog.mk> and
87: <bsd.lib.mk>, for backward compatibility.
1.1 deraadt 88:
89: The variable DESTDIR works as before. It's not set anywhere but will change
90: the tree where the file gets installed.
91:
92: The profiled libraries are no longer built in a different directory than
93: the regular libraries. A new suffix, ".po", is used to denote a profiled
94: object.
95:
96: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
97:
98: The include file <sys.mk> has the default rules for all makes, in the BSD
99: environment or otherwise. You probably don't want to touch this file.
100:
101: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
102:
103: The include file <bsd.man.mk> handles installing manual pages and their
104: links.
105:
106: It has a single target:
107:
108: maninstall:
109: Install the manual pages and their links.
110:
111: It sets/uses the following variables:
112:
113: MANDIR Base path for manual installation.
114:
115: MANGRP Manual group.
116:
117: MANOWN Manual owner.
118:
119: MANMODE Manual mode.
120:
1.64 deraadt 121: MANSUBDIR Subdirectory under the manual page section, i.e. "amd64"
122: or "sparc64" for machine specific manual pages.
1.1 deraadt 123:
1.4 niklas 124: MAN The manual pages to be installed (use a .1 - .9 suffix).
1.1 deraadt 125:
1.4 niklas 126: MLINKS List of manual page links (using a .1 - .9 suffix). The
1.1 deraadt 127: linked-to file must come first, the linked file second,
128: and there may be multiple pairs. The files are soft-linked.
1.40 espie 129:
1.68 espie 130: BEFOREMAN List of extra targets that must be already built before the
1.40 espie 131: man target can be run. Those targets must be real files (and
132: not .PHONY targets).
1.1 deraadt 133:
134: The include file <bsd.man.mk> includes a file named "../Makefile.inc" if
135: it exists.
136:
137: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
138:
1.8 deraadt 139: The include file <bsd.own.mk> contains source tree configuration parameters,
140: such as the owners, groups, etc. for both manual pages and binaries, and
141: a few global "feature configuration" parameters.
1.1 deraadt 142:
143: It has no targets.
144:
1.8 deraadt 145: To get system-specific configuration parameters, bsd.own.mk will try to
146: include the file specified by the "MAKECONF" variable. If MAKECONF is not
147: set, or no such file exists, the system make configuration file, /etc/mk.conf
148: is included. These files may define any of the variables described below.
149:
150: bsd.own.mk sets the following variables, if they are not already defined
151: (defaults are in brackets):
1.4 niklas 152:
153: BSDSRCDIR The real path to the system sources, so that 'make obj'
154: will work correctly. [/usr/src]
155:
156: BSDOBJDIR The real path to the system 'obj' tree, so that 'make obj'
157: will work correctly. [/usr/obj]
158:
159: BINGRP Binary group. [bin]
160:
1.10 deraadt 161: BINOWN Binary owner. [root]
1.4 niklas 162:
163: BINMODE Binary mode. [555]
164:
165: NONBINMODE Mode for non-executable files. [444]
166:
1.23 espie 167: DIRMODE Mode for new directories. [755]
168:
1.45 schwarze 169: MANDIR Base path for manual installation. [/usr/share/man/man]
1.4 niklas 170:
171: MANGRP Manual group. [bin]
172:
1.18 millert 173: MANOWN Manual owner. [root]
1.4 niklas 174:
175: MANMODE Manual mode. [${NONBINMODE}]
176:
177: LIBDIR Base path for library installation. [/usr/lib]
178:
179: LIBGRP Library group. [${BINGRP}]
180:
181: LIBOWN Library owner. [${BINOWN}]
182:
183: LIBMODE Library mode. [${NONBINMODE}]
184:
1.44 jmc 185: DOCDIR Base path for system documentation
1.4 niklas 186: installation. [/usr/share/doc]
187:
188: DOCGRP Documentation group. [bin]
189:
1.18 millert 190: DOCOWN Documentation owner. [root]
1.4 niklas 191:
192: DOCMODE Documentation mode. [${NONBINMODE}]
1.1 deraadt 193:
1.15 millert 194: INSTALL_STRIP The flag passed to the install program to cause the binary
1.1 deraadt 195: to be stripped. This is to be used when building your
196: own install script so that the entire system can be made
1.15 millert 197: stripped/not-stripped using a single knob. Note that
198: INSTALL_STRIP is not set if ${DEBUG} is defined. [-s]
1.1 deraadt 199:
1.15 millert 200: INSTALL_COPY The old usage of this flag is obsolescent since install(1)
201: now copies by default. However, it can also be used to
202: specify that a file not be copied unless it is different
203: (via the -p option). See install(1) for details. This
204: is to be used when building our own install script so
205: that the entire system can either be installed with copies,
206: or copy-if-different using a single knob. [-c]
1.4 niklas 207:
1.8 deraadt 208: Additionally, the following variables may be set by bsd.own.mk or in a
209: make configuration file to modify the behaviour of the system build
210: process (default values are in brackets along with comments, if set by
211: bsd.own.mk):
1.23 espie 212:
1.4 niklas 213: SKEY Compile in support for S/key authentication. [yes, set
214: unconditionally]
215:
216: SYS_INCLUDE Copy or symlink kernel include files into /usr/include.
217: Possible values are "symlinks" or "copies" (which is
218: the same as the variable being unset).
1.1 deraadt 219:
1.28 brad 220: NOPROFILE Do not build profiled versions of system libraries.
1.1 deraadt 221:
1.4 niklas 222: NOPIC Do not build PIC versions of system libraries, and
1.28 brad 223: do not build shared libraries.
1.48 pascal 224:
225: NOPIE Do not build PIE objects or executables.
1.1 deraadt 226:
1.22 niklas 227: DEBUG Add -g to assembly, C compiler and linking passes. Also
228: doesn't set STRIP to -s per default if defined.
1.27 espie 229:
230: WARNINGS Adds appropriate warning flags (defined in CDIAGFLAGS,
231: e.g., -Wall...) to compiles. [no]
1.19 millert 232:
233: SUDO Command to run when doing "make install" portion of
1.63 gsoares 234: "make build". If set to /usr/bin/doas, this allows one
235: to run "make build" as a user other than root (assuming
236: doas is setup for that user).
1.19 millert 237:
238: PIPE If set to "-pipe" gcc will be given the -pipe option
239: which can speed up compiles on machines with memory
240: to spare. Instead of using temp files, gcc uses pipes
241: for the temporary data.
1.20 kstailey 242:
243: GLOBAL_AUTOCONF_CACHE
244: Set to the name of a file that all cached GNU autoconf
245: test results will be saved in. Reduces redundant tests.
1.23 espie 246: Be careful! Redundant tests may not be redundant if you
247: are installing substantially updated gnu programs.
1.1 deraadt 248:
1.8 deraadt 249: bsd.own.mk is generally useful when building your own Makefiles so that
1.1 deraadt 250: they use the same default owners etc. as the rest of the tree.
251:
252: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
253:
254: The include file <bsd.prog.mk> handles building programs from one or
255: more source files, along with their manual pages. It has a limited number
256: of suffixes, consistent with the current needs of the BSD tree.
257:
1.68 espie 258: It has six targets:
1.1 deraadt 259:
260: all:
261: build the program and its manual page
262: clean:
263: remove the program, any object files and the files a.out,
264: Errs, errs, mklog, and core.
265: cleandir:
266: remove all of the files removed by the target clean, as
267: well as .depend, tags, and any manual pages.
1.8 deraadt 268: includes:
269: install any header files.
1.1 deraadt 270: install:
271: install the program and its manual pages; if the Makefile
272: does not itself define the target install, the targets
273: beforeinstall and afterinstall may also be used to cause
274: actions immediately before and after the install target
275: is executed.
276: tags:
277: create a tags file for the source files.
278:
279: It sets/uses the following variables:
280:
281: BINGRP Binary group.
282:
283: BINOWN Binary owner.
284:
285: BINMODE Binary mode.
286:
1.66 espie 287: BUILDFIRST Stuff that needs to be built before anything else, in
288: terms of dependencies.
289:
1.70 ! espie 290: BUILDAFTER Stuff that comes later (usually don't touch, defined correctly
1.66 espie 291: by <bsd.prog.mk> and <bsd.lib.mk>)
292:
1.1 deraadt 293: CLEANFILES Additional files to remove for the clean and cleandir targets.
294:
295: COPTS Additional flags to the compiler when creating C objects.
296:
297: LDADD Additional loader objects. Usually used for libraries.
1.53 deraadt 298: For example, to load with the crypto and utility
1.1 deraadt 299: libraries, use:
300:
1.53 deraadt 301: LDADD+=-lutil -lcrypto
1.1 deraadt 302:
303: LDFLAGS Additional loader flags.
304:
305: LINKS The list of binary links; should be full pathnames, the
306: linked-to file coming first, followed by the linked
307: file. The files are hard-linked. For example, to link
308: /bin/test and /bin/[, use:
309:
310: LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[
311:
1.4 niklas 312: MAN Manual pages (should end in .1 - .9). If no MAN variable is
1.1 deraadt 313: defined, "MAN=${PROG}.1" is assumed.
314:
315: PROG The name of the program to build. If not supplied, nothing
316: is built.
317:
1.6 mickey 318: SRCS List of source files to build the program. If it's not
1.1 deraadt 319: defined, it's assumed to be ${PROG}.c.
320:
321: DPADD Additional dependencies for the program. Usually used for
1.53 deraadt 322: libraries. For example, to depend on the crypto and
1.1 deraadt 323: utility libraries use:
324:
1.53 deraadt 325: DPADD+=${LIBCRYPTO} ${LIBUTIL}
1.1 deraadt 326:
327: The following libraries are predefined for DPADD:
328:
1.31 espie 329: LIBC /usr/lib/libc.a
330: LIBCRYPTO /usr/lib/libcrypto.a
1.1 deraadt 331: LIBCURSES /usr/lib/libcurses.a
1.26 millert 332: LIBEDIT /usr/lib/libedit.a
1.32 millert 333: LIBEVENT /usr/lib/libevent.a
1.42 miod 334: LIBEXPAT /usr/lib/libexpat.a
335: LIBFORM /usr/lib/libform.a
336: LIBFORMW /usr/lib/libformw.a
1.26 millert 337: LIBKEYNOTE /usr/lib/libkeynote.a
1.1 deraadt 338: LIBKVM /usr/lib/libkvm.a
1.26 millert 339: LIBL /usr/lib/libl.a
1.1 deraadt 340: LIBM /usr/lib/libm.a
1.42 miod 341: LIBMENU /usr/lib/libmenu.a
342: LIBMENUW /usr/lib/libmenuw.a
1.60 yasuoka 343: LIBRADIUS /usr/lib/libradius.a
1.42 miod 344: LIBOSSAUDIO /usr/lib/libossaudio.a
345: LIBPANEL /usr/lib/libpanel.a
346: LIBPANELW /usr/lib/libpanelw.a
1.31 espie 347: LIBPCAP /usr/lib/libpcap.a
1.21 millert 348: LIBPERL /usr/lib/libperl.a
1.42 miod 349: LIBPTHREAD /usr/lib/libpthread.a
1.26 millert 350: LIBRPCSVC /usr/lib/librpcsvc.a
351: LIBSKEY /usr/lib/libskey.a
1.42 miod 352: LIBSNDIO /usr/lib/libsndio.a
1.26 millert 353: LIBSSL /usr/lib/libssl.a
1.9 tholo 354: LIBTERMCAP /usr/lib/libtermcap.a
355: LIBTERMLIB /usr/lib/libtermlib.a
1.59 jsing 356: LIBTLS /usr/lib/libtls.a
1.31 espie 357: LIBUSB /usr/lib/libusbhid.a
1.1 deraadt 358: LIBUTIL /usr/lib/libutil.a
1.31 espie 359: LIBY /usr/lib/liby.a
1.13 deraadt 360: LIBZ /usr/lib/libz.a
1.31 espie 361: LIBARCH arch-dependent stuff
1.1 deraadt 362:
363: STRIP The flag passed to the install program to cause the binary
364: to be stripped.
365:
366: SUBDIR A list of subdirectories that should be built as well.
367: Each of the targets will execute the same target in the
368: subdirectories.
369:
370: The include file <bsd.prog.mk> includes the file named "../Makefile.inc"
371: if it exists, as well as the include file <bsd.man.mk>.
372:
373: Some simple examples:
374:
375: To build foo from foo.c with a manual page foo.1, use:
376:
377: PROG= foo
378:
379: .include <bsd.prog.mk>
380:
381: To build foo from foo.c with a manual page foo.2, add the line:
382:
383: MAN= foo.2
384:
385: If foo does not have a manual page at all, add the line:
386:
387: NOMAN= noman
388:
389: If foo has multiple source files, add the line:
390:
391: SRCS= a.c b.c c.c d.c
392:
1.68 espie 393: SRCS may contain lex and yacc files, in which case the framework will
394: convert these files to C and header files first, before building anything
395: else.
396:
397: SRCS may contain C++ files, in which case the C++ compiler will be used
398: for linking.
399:
400: If YFLAGS contains -d, the header file will be named like the C file,
401: and a proper rule tying both together will be generated. For instance, if
402: SRCS contains grammar.y, then effectively you will have
403:
404: grammar.c grammar.h: grammar.y
405: ${YACC.Y} -o grammar.c grammar.y
1.69 espie 406:
407:
408: <bsd.prog.mk> may be used to build several programs in a single directory.
409: Just define the list of programs as PROGS instead of using PROG.
410: For instance PROGS = foo bar
411:
412: Each program of the list, for instance foo, will use SRCS_foo instead
413: of SRCS to find its sources. SRCS_foo still defaults to foo.c, and
414: MAN still defaults to section 1 manpages: MAN = foo.1 bar.1.
415:
416: Each program can have its separate LDADD_foo and DPADD_foo definitions.
417: If not defined, these default to LDADD/DPADD.
418:
419: Some simple examples:
420: To build foo from foo.c and bar from bar.c with manual pages foo.1 and bar.1:
421:
422: PROGS = foo bar
423:
424: .include <bsd.prog.mk>
425:
426: If bar has manual page bar.8 instead, add the line:
427: MAN = foo.1 bar.8
428:
429: If bar has multiple source files, add the line:
430: SRCS_bar = a.c b.c c.c d.c
431:
432: Note that foo and bar may share some source files, like so:
433: SRCS_foo = foo.c common.c
434: SRCS_bar = bar.c common.c
1.68 espie 435:
1.1 deraadt 436: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
437:
438: The include file <bsd.subdir.mk> contains the default targets for building
1.68 espie 439: subdirectories. It has the same six targets as <bsd.prog.mk>: all,
440: clean, cleandir, includes, install, and tags. For all of
441: the directories listed in the variable SUBDIR, the specified directory
1.8 deraadt 442: will be visited and the target made. There is also a default target which
443: allows the command "make subdir" where subdir is any directory listed in
1.41 jmc 444: the variable SUBDIR.
1.2 deraadt 445:
446: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
447:
448: The include file <bsd.sys.mk> is used by <bsd.prog.mk> and
1.3 deraadt 449: <bsd.lib.mk>. It contains overrides that are used when building
1.14 millert 450: the OpenBSD source tree. For instance, if "PARALLEL" is defined by
1.3 deraadt 451: the program/library Makefile, it includes a set of rules for lex and
452: yacc that allow multiple lex and yacc targets to be built in parallel.
1.1 deraadt 453:
454: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
455:
456: The include file <bsd.lib.mk> has support for building libraries. It has
1.68 espie 457: the same seven targets as <bsd.prog.mk>: all, clean, cleandir,
1.47 jsg 458: includes, install, and tags. It has a limited number of suffixes,
1.8 deraadt 459: consistent with the current needs of the BSD tree.
1.1 deraadt 460:
461: It sets/uses the following variables:
1.66 espie 462:
463: BUILDFIRST/BUILDLATER
464: See <bsd.prog.mk>
1.1 deraadt 465:
466: LIB The name of the library to build.
467:
468: LIBDIR Target directory for libraries.
469:
470: LIBGRP Library group.
471:
472: LIBOWN Library owner.
473:
474: LIBMODE Library mode.
475:
476: LDADD Additional loader objects.
477:
1.4 niklas 478: MAN The manual pages to be installed (use a .1 - .9 suffix).
1.1 deraadt 479:
480: SRCS List of source files to build the library. Suffix types
481: .s, .c, and .f are supported. Note, .s files are preferred
482: to .c files of the same name. (This is not the default for
1.68 espie 483: POSIX make without bsd.lib.mk).
484:
485: The same support for yacc and lex files as <bsd.prog.mk>
486: is provided.
1.1 deraadt 487:
488: The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
489: if it exists, as well as the include file <bsd.man.mk>.
490:
491: It has rules for building profiled objects; profiled libraries are
492: built by default.
493:
494: Libraries are ranlib'd when made.
1.52 guenther 495:
496: In addition, a reduced version of a library, including just specific
497: objects that are compiled with additional options to reduce their
498: size may be built. This is used by the distrib/ tree and crunchgen
499: when building ramdisks. This sets/uses the following variables:
500:
501: DIST_LIB The path of the library to build. [lib${LIB}_d.a]
502:
503: DIST_OBJS The (sub)set of .o files to include in ${DIST_LIB}. [${OBJS}]
504:
505: DIST_CFLAGS Additional flags for the C compiler and assembler.
506: [-Os]
1.6 mickey 507:
![[BACK]](/icons/back.gif){kind=icon}
Return to bsd.README CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / share / mk