[BACK]Return to bsd.README CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / share / mk

Annotation of src/share/mk/bsd.README, Revision 1.85

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

CVSweb <webmaster@jp.NetBSD.org>