1# @(#)bsd.README 8.2 (Berkeley) 4/2/94 2# $FreeBSD: src/share/mk/bsd.README,v 1.25 2003/05/17 18:03:05 trhodes Exp $ 3 4This is the README file for the "include" files for the DragonFly 5source tree. The files are installed in /usr/share/mk, and are, by 6convention, named with the suffix ".mk". These files store several 7build options and should be handled with caution. 8 9Note, this file is not intended to replace reading through the .mk 10files for anything tricky. 11 12There are two main types of make include files. One type is the generally 13usable make include files, such as bsd.prog.mk and bsd.lib.mk. The other is 14the internal make include files, such as bsd.files.mk and bsd.man.mk, which 15can not/should not be used directly but are used by the other make include 16files. In most cases it is only interesting to include bsd.prog.mk or 17bsd.lib.mk. 18 19bsd.cpu.custom.mk - handle CPU flags for custom compilers 20bsd.cpu.gcc47.mk - handle GCC 4.7 specific CPU flags & variables 21bsd.cpu.gcc50.mk - handle GCC 5.0 specific CPU flags & variables 22bsd.cpu.gcc80.mk - handle GCC 8.0 specific CPU flags & variables 23bsd.cpu.mk - handle CPU flags & variables 24bsd.crunchgen.mk - building crunched binaries using crunchgen(1) 25bsd.dep.mk - handle Makefile dependencies 26bsd.doc.mk - building troff system documents 27bsd.files.mk - install of general purpose files 28bsd.hostlib.mk - 29bsd.hostprog.mk - 30bsd.incs.mk - install of include files 31bsd.init.mk - initialization for the make include files 32bsd.kmod.mk - building loadable kernel modules 33bsd.lib.mk - support for building libraries 34bsd.libnames.mk - define library names 35bsd.links.mk - install of links (sym/hard) 36bsd.man.mk - install of manual pages and their links 37bsd.nls.mk - build and install of NLS catalogs 38bsd.obj.mk - creating 'obj' directories and cleaning up 39bsd.own.mk - define common variables 40bsd.patch.mk - 41bsd.prog.mk - building programs from source files 42bsd.subdir.mk - targets for building subdirectories 43bsd.sys.mk - common settings used for building DragonFly sources 44sys.mk - default rules for all makes 45 46 47See also make(1), mkdep(1) and `PMake - A Tutorial', 48located in /usr/src/share/doc/psd/12.make. 49 50=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 51 52Random things worth knowing about this document: 53 54If appropriate when documenting the variables the default value is 55indicated using square brackets e.g. [gzip]. 56In some cases the default value depend on other values (e.g. system 57architecture). In these cases the most common value is indicated. 58 59This document contains some simple examples of the usage of the BSD make 60include files. For more examples look at the makefiles in the DragonFly 61source tree. 62 63=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 64 65RANDOM THINGS WORTH KNOWING: 66 67The files are like C-style #include files, and pretty much behave like 68you'd expect. The syntax is slightly different in that a single '.' is 69used instead of the hash mark, i.e. ".include <bsd.prog.mk>". 70 71One difference that will save you lots of debugging time is that inclusion 72of the file is normally done at the *end* of the Makefile. The reason for 73this is because .mk files often modify variables and behavior based on the 74values of variables set in the Makefile. To make this work, remember that 75the FIRST target found is the target that is used, i.e. if the Makefile has: 76 77 a: 78 echo a 79 a: 80 echo a number two 81 82the command "make a" will echo "a". To make things confusing, the SECOND 83variable assignment is the overriding one, i.e. if the Makefile has: 84 85 a= foo 86 a= bar 87 88 b: 89 echo ${a} 90 91the command "make b" will echo "bar". This is for compatibility with the 92way the V7 make behaved. 93 94It's fairly difficult to make the BSD .mk files work when you're building 95multiple programs in a single directory. It's a lot easier split up the 96programs than to deal with the problem. Most of the agony comes from making 97the "obj" directory stuff work right, not because we switch to a new version 98of make. So, don't get mad at us, figure out a better way to handle multiple 99architectures so we can quit using the symbolic link stuff. (Imake doesn't 100count.) 101 102The file .depend in the source directory is expected to contain dependencies 103for the source files. This file is read automatically by make after reading 104the Makefile. 105 106The variable DESTDIR works as before. It's not set anywhere but will change 107the tree where the file gets installed. 108 109The profiled libraries are no longer built in a different directory than 110the regular libraries. A new suffix, ".po", is used to denote a profiled 111object. 112 113=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 114 115The include file <sys.mk> has the default rules for all makes, in the BSD 116environment or otherwise. You probably don't want to touch this file. 117 118=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 119 120The include file <bsd.man.mk> handles installing manual pages and their 121links. 122 123It has three targets: 124 125 all-man: 126 build manual pages. 127 maninstall: 128 install the manual pages and their links. 129 manlint: 130 verify the validity of manual pages. 131 132It sets/uses the following variables: 133 134MANDIR Base path for manual installation. 135 136MANGRP Manual group. 137 138MANOWN Manual owner. 139 140MANMODE Manual mode. 141 142MANSUBDIR Subdirectory under the manual page section, i.e. "/vax" 143 or "/tahoe" for machine specific manual pages. 144 145MAN The manual pages to be installed (use a .1 - .9 suffix). 146 147MANINSTALLFLAGS Additional flags to pass to install(1). 148 149MLINKS List of manual page links (using a .1 - .9 suffix). The 150 linked-to file must come first, the linked file second, 151 and there may be multiple pairs. The files are soft-linked. 152 153The include file <bsd.man.mk> includes a file named "../Makefile.inc" if 154it exists. 155 156=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 157 158The include file <bsd.own.mk> contains the owners, groups, etc. for both 159manual pages and binaries. 160 161It has no targets. 162 163It sets/uses the following variables: 164 165BINGRP Binary group. 166 167BINOWN Binary owner. 168 169BINMODE Binary mode. 170 171STRIP The flag passed to the install program to cause the binary 172 to be stripped. This is to be used when building your 173 own install script so that the entire system can be made 174 stripped/not-stripped using a single knob. 175 176MANDIR Base path for manual installation. 177 178MANGRP Manual group. 179 180MANOWN Manual owner. 181 182MANMODE Manual mode. 183 184This file is generally useful when building your own Makefiles so that 185they use the same default owners etc. as the rest of the tree. 186 187=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 188 189The include file <bsd.prog.mk> handles building programs from one or 190more source files, along with their manual pages. It has a limited number 191of suffixes, consistent with the current needs of the BSD tree. 192 193It has seven targets: 194 195 all: 196 build the program and its manual page 197 clean: 198 remove the program and any object files. 199 cleandir: 200 remove all of the files removed by the target clean, as 201 well as .depend, tags, and any manual pages. 202 depend: 203 make the dependencies for the source files, and store 204 them in the file .depend. 205 install: 206 install the program and its manual pages; if the Makefile 207 does not itself define the target install, the targets 208 beforeinstall and afterinstall may also be used to cause 209 actions immediately before and after the install target 210 is executed. 211 lint: 212 run lint on the source files 213 tags: 214 create a tags file for the source files. 215 216It sets/uses the following variables: 217 218BINGRP Binary group. 219 220BINOWN Binary owner. 221 222BINMODE Binary mode. 223 224CLEANFILES Additional files to remove and 225CLEANDIRS additional directories to remove during clean and cleandir 226 targets. "rm -f" and "rm -rf" used respectively. 227 228COPTS Additional flags to the compiler when creating C objects. 229 230FILES A list of non-executable files. 231 The installation is controlled by the FILESNAME, FILESOWN, 232 FILESGRP, FILESMODE, FILESDIR variables that can be 233 further specialized by <VAR>_<file>. 234 235LDADD Additional loader objects. Usually used for libraries. 236 For example, to load with the compatibility and utility 237 libraries, use: 238 239 LDFILES=-lutil -lcompat 240 241LDFLAGS Additional loader flags. 242 243LINKS The list of binary links; should be full pathnames, the 244 linked-to file coming first, followed by the linked 245 file. The files are hard-linked. For example, to link 246 /bin/test and /bin/[, use: 247 248 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 249 250MAN Manual pages (should end in .1 - .9). If no MAN variable 251 is defined, "MAN=${PROG}.1" is assumed. 252 253PROG The name of the program to build. If not supplied, nothing 254 is built. 255 256PROG_CXX If defined, the name of the program to build. Also 257 causes <bsd.prog.mk> to link the program with the 258 standard C++ library. PROG_CXX overrides the value 259 of PROG if PROG is also set. 260 261PROGNAME The name that the above program will be installed as, if 262 different from ${PROG}. 263 264SRCS List of source files to build the program. If SRCS is not 265 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is 266 defined, ${PROG_CXX}.cc. 267 268DPADD Additional dependencies for the program. Usually used for 269 libraries. For example, to depend on the compatibility and 270 utility libraries use: 271 272 DPADD= ${LIBCOMPAT} ${LIBUTIL} 273 274 There is a predefined identifier for each (non-profiled, 275 non-shared) library and object. Library file names are 276 transformed to identifiers by removing the extension and 277 converting to upper case. 278 279 There are no special identifiers for profiled or shared 280 libraries or objects. The identifiers for the standard 281 libraries are used in DPADD. This works correctly iff all 282 the libraries are built at the same time. Unfortunately, 283 it causes unnecessary relinks to shared libraries when 284 only the static libraries have changed. Dependencies on 285 shared libraries should be only on the library version 286 numbers. 287 288STRIP The flag passed to the install program to cause the binary 289 to be stripped. This is to be used when building your 290 own install script so that the entire system can be made 291 stripped/not-stripped using a single knob. 292 293SUBDIR A list of subdirectories that should be built as well. 294 Each of the targets will execute the same target in the 295 subdirectories. 296 297SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 298 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN, 299 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be 300 further specialized by SCRIPTS<VAR>_<script>. 301 302The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 303if it exists, as well as the include file <bsd.man.mk>. 304 305Some simple examples: 306 307To build foo from foo.c with a manual page foo.1, use: 308 309 PROG= foo 310 311 .include <bsd.prog.mk> 312 313To build foo from foo.c with a manual page foo.2, add the line: 314 315 MAN= foo.2 316 317If foo does not have a manual page at all, add the line: 318 319 NOMAN= noman 320 321If foo has multiple source files, add the line: 322 323 SRCS= a.c b.c c.c d.c 324 325=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 326 327The include file <bsd.subdir.mk> contains the default targets for building 328subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean, 329cleandir, depend, install, lint, and tags. For all of the directories 330listed in the variable SUBDIRS, the specified directory will be visited 331and the target made. There is also a default target which allows the 332command "make subdir" where subdir is any directory listed in the variable 333SUBDIRS. 334 335=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 336 337The include file <bsd.lib.mk> has support for building libraries. It has 338the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend, 339install, lint, and tags. It has a limited number of suffixes, consistent 340with the current needs of the BSD tree. 341 342It sets/uses the following variables: 343 344LIBDIR Target directory for libraries. 345 346LINTLIBDIR Target directory for lint libraries. 347 348LIBGRP Library group. 349 350LIBOWN Library owner. 351 352LIBMODE Library mode. 353 354LDADD Additional loader objects. 355 356MAN The manual pages to be installed (use a .1 - .9 suffix). 357 358SRCS List of source files to build the library. Suffix types 359 .s, .c, and .f are supported. Note, .s files are preferred 360 to .c files of the same name. (This is not the default for 361 versions of make.) 362 363The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 364if it exists, as well as the include file <bsd.man.mk>. 365 366It has rules for building profiled objects; profiled libraries are 367built by default. 368 369Libraries are ranlib'd before installation. 370