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