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