bsd.README revision 114580
144743Smarkm# @(#)bsd.README 8.2 (Berkeley) 4/2/94 244743Smarkm# $FreeBSD: head/share/mk/bsd.README 114580 2003-05-03 15:48:12Z markm $ 344743Smarkm 444743SmarkmXXX This document is seriously out of date, it is currenly being revised. 544743Smarkm 644743SmarkmThis is the README file for the new make "include" files for the BSD 744743Smarkmsource tree. The files are installed in /usr/share/mk, and are, by 844743Smarkmconvention, named with the suffix ".mk". 944743Smarkm 1044743Smarkmbsd.dep.mk - handle Makefile dependencies 1144743Smarkmbsd.doc.mk - building troff system documents 1244743Smarkmbsd.info.mk - building GNU Info hypertext system 1344743Smarkmbsd.kmod.mk - building loadable kernel modules 1444743Smarkmbsd.lib.mk - support for building libraries 1544743Smarkmbsd.libnames.mk - define library names 1644743Smarkmbsd.man.mk - installing manual pages and their links 1744743Smarkmbsd.obj.mk - creating 'obj' directories and cleaning up 1844743Smarkmbsd.own.mk - define common variables 1944743Smarkmbsd.port.mk - building ports 2044743Smarkmbsd.port.subdir.mk - targets for building subdirectories for ports 2144743Smarkmbsd.prog.mk - building programs from source files 2244743Smarkmbsd.subdir.mk - targets for building subdirectories 2344743Smarkm 2444743Smarkm 2544743SmarkmNote, this file is not intended to replace reading through the .mk 2644743Smarkmfiles for anything tricky. 2744743Smarkm 2844743SmarkmSee also make(1), mkdep(1) and `PMake - A Tutorial', 2944743Smarkmlocated in /usr/share/doc/psd/12.make. 3044743Smarkm 3144743Smarkm=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 3244743Smarkm 3344743SmarkmRANDOM THINGS WORTH KNOWING: 3444743Smarkm 3544743SmarkmThe files are simply C-style #include files, and pretty much behave like 3644743Smarkmyou'd expect. The syntax is slightly different in that a single '.' is 3744743Smarkmused instead of the hash mark, i.e. ".include <bsd.prog.mk>". 3844743Smarkm 3944743SmarkmOne difference that will save you lots of debugging time is that inclusion 4044743Smarkmof the file is normally done at the *end* of the Makefile. The reason for 4144743Smarkmthis is because .mk files often modify variables and behavior based on the 4244743Smarkmvalues of variables set in the Makefile. To make this work, remember that 4344743Smarkmthe FIRST target found is the target that is used, i.e. if the Makefile has: 44 45 a: 46 echo a 47 a: 48 echo a number two 49 50the command "make a" will echo "a". To make things confusing, the SECOND 51variable assignment is the overriding one, i.e. if the Makefile has: 52 53 a= foo 54 a= bar 55 56 b: 57 echo ${a} 58 59the command "make b" will echo "bar". This is for compatibility with the 60way the V7 make behaved. 61 62It's fairly difficult to make the BSD .mk files work when you're building 63multiple programs in a single directory. It's a lot easier split up the 64programs than to deal with the problem. Most of the agony comes from making 65the "obj" directory stuff work right, not because we switch to a new version 66of make. So, don't get mad at us, figure out a better way to handle multiple 67architectures so we can quit using the symbolic link stuff. (Imake doesn't 68count.) 69 70The file .depend in the source directory is expected to contain dependencies 71for the source files. This file is read automatically by make after reading 72the Makefile. 73 74The variable DESTDIR works as before. It's not set anywhere but will change 75the tree where the file gets installed. 76 77The profiled libraries are no longer built in a different directory than 78the regular libraries. A new suffix, ".po", is used to denote a profiled 79object. 80 81=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 82 83The include file <sys.mk> has the default rules for all makes, in the BSD 84environment or otherwise. You probably don't want to touch this file. 85 86=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 87 88The include file <bsd.man.mk> handles installing manual pages and their 89links. 90 91It has three targets: 92 93 all-man: 94 build manual pages. 95 maninstall: 96 install the manual pages and their links. 97 manlint: 98 verify the validity of manual pages. 99 100It sets/uses the following variables: 101 102MANDIR Base path for manual installation. 103 104MANGRP Manual group. 105 106MANOWN Manual owner. 107 108MANMODE Manual mode. 109 110MANSUBDIR Subdirectory under the manual page section, i.e. "/vax" 111 or "/tahoe" for machine specific manual pages. 112 113MAN The manual pages to be installed (use a .1 - .9 suffix). 114 115MLINKS List of manual page links (using a .1 - .9 suffix). The 116 linked-to file must come first, the linked file second, 117 and there may be multiple pairs. The files are soft-linked. 118 119The include file <bsd.man.mk> includes a file named "../Makefile.inc" if 120it exists. 121 122=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 123 124The include file <bsd.own.mk> contains the owners, groups, etc. for both 125manual pages and binaries. 126 127It has no targets. 128 129It sets/uses the following variables: 130 131BINGRP Binary group. 132 133BINOWN Binary owner. 134 135BINMODE Binary mode. 136 137STRIP The flag passed to the install program to cause the binary 138 to be stripped. This is to be used when building your 139 own install script so that the entire system can be made 140 stripped/not-stripped using a single nob. 141 142MANDIR Base path for manual installation. 143 144MANGRP Manual group. 145 146MANOWN Manual owner. 147 148MANMODE Manual mode. 149 150This file is generally useful when building your own Makefiles so that 151they use the same default owners etc. as the rest of the tree. 152 153=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 154 155The include file <bsd.prog.mk> handles building programs from one or 156more source files, along with their manual pages. It has a limited number 157of suffixes, consistent with the current needs of the BSD tree. 158 159It has seven targets: 160 161 all: 162 build the program and its manual page 163 clean: 164 remove the program, any object files and the files a.out, 165 Errs, errs, mklog, and ${PROG}.core. 166 cleandir: 167 remove all of the files removed by the target clean, as 168 well as .depend, tags, and any manual pages. 169 depend: 170 make the dependencies for the source files, and store 171 them in the file .depend. 172 install: 173 install the program and its manual pages; if the Makefile 174 does not itself define the target install, the targets 175 beforeinstall and afterinstall may also be used to cause 176 actions immediately before and after the install target 177 is executed. 178 lint: 179 run lint on the source files 180 tags: 181 create a tags file for the source files. 182 183It sets/uses the following variables: 184 185BINGRP Binary group. 186 187BINOWN Binary owner. 188 189BINMODE Binary mode. 190 191CLEANFILES Additional files to remove and 192CLEANDIRS additional directories to remove during clean and cleandir 193 targets. "rm -f" and "rm -rf" used respectively. 194 195COPTS Additional flags to the compiler when creating C objects. 196 197FILES A list of non-executable files. 198 The installation is controlled by the FILESNAME, FILESOWN, 199 FILESGRP, FILESMODE, FILESDIR variables that can be 200 further specialized by FILES<VAR>_<file>. 201 202LDADD Additional loader objects. Usually used for libraries. 203 For example, to load with the compatibility and utility 204 libraries, use: 205 206 LDFILES=-lutil -lcompat 207 208LDFLAGS Additional loader flags. 209 210LINKS The list of binary links; should be full pathnames, the 211 linked-to file coming first, followed by the linked 212 file. The files are hard-linked. For example, to link 213 /bin/test and /bin/[, use: 214 215 LINKS= ${DESTDIR}/bin/test ${DESTDIR}/bin/[ 216 217MAN Manual pages (should end in .1 - .9). If no MAN variable 218 is defined, "MAN=${PROG}.1" is assumed. 219 220PROG The name of the program to build. If not supplied, nothing 221 is built. 222 223PROG_CXX If defined, the name of the program to build. Also 224 causes <bsd.prog.mk> to link the program with the 225 standard C++ library. PROG_CXX overrides the value 226 of PROG if PROG is also set. 227 228PROGNAME The name that the above program will be installed as, if 229 different from ${PROG}. 230 231SRCS List of source files to build the program. If SRCS is not 232 defined, it's assumed to be ${PROG}.c or, if PROG_CXX is 233 defined, ${PROG_CXX}.cc. 234 235DPADD Additional dependencies for the program. Usually used for 236 libraries. For example, to depend on the compatibility and 237 utility libraries use: 238 239 SRCLIB=${LIBCOMPAT} ${LIBUTIL} 240 241 There is a predefined identifier for each (non-profiled, 242 non-shared) library and object. Library file names are 243 transformed to identifiers by removing the extension and 244 converting to upper case. 245 246 There are no special identifiers for profiled or shared 247 libraries or objects. The identifiers for the standard 248 libraries are used in DPADD. This works correctly iff all 249 the libraries are built at the same time. Unfortunately, 250 it causes unnecessary relinks to shared libraries when 251 only the static libraries have changed. Dependencies on 252 shared libraries should be only on the library version 253 numbers. 254 255STRIP The flag passed to the install program to cause the binary 256 to be stripped. 257 258SUBDIR A list of subdirectories that should be built as well. 259 Each of the targets will execute the same target in the 260 subdirectories. 261 262SCRIPTS A list of interpreter scripts [file.{sh,csh,pl,awk,...}]. 263 The installation is controlled by the SCRIPTSNAME, SCRIPTSOWN, 264 SCRIPTSGRP, SCRIPTSMODE, SCRIPTSDIR variables that can be 265 further specialized by SCRIPTS<VAR>_<script>. 266 267The include file <bsd.prog.mk> includes the file named "../Makefile.inc" 268if it exists, as well as the include file <bsd.man.mk>. 269 270Some simple examples: 271 272To build foo from foo.c with a manual page foo.1, use: 273 274 PROG= foo 275 276 .include <bsd.prog.mk> 277 278To build foo from foo.c with a manual page foo.2, add the line: 279 280 MAN2= foo.2 281 282If foo does not have a manual page at all, add the line: 283 284 NOMAN= noman 285 286If foo has multiple source files, add the line: 287 288 SRCS= a.c b.c c.c d.c 289 290=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 291 292The include file <bsd.subdir.mk> contains the default targets for building 293subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean, 294cleandir, depend, install, lint, and tags. For all of the directories 295listed in the variable SUBDIRS, the specified directory will be visited 296and the target made. There is also a default target which allows the 297command "make subdir" where subdir is any directory listed in the variable 298SUBDIRS. 299 300=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 301 302The include file <bsd.lib.mk> has support for building libraries. It has 303the same seven targets as <bsd.prog.mk>: all, clean, cleandir, depend, 304install, lint, and tags. It has a limited number of suffixes, consistent 305with the current needs of the BSD tree. 306 307It sets/uses the following variables: 308 309LIBDIR Target directory for libraries. 310 311LINTLIBDIR Target directory for lint libraries. 312 313LIBGRP Library group. 314 315LIBOWN Library owner. 316 317LIBMODE Library mode. 318 319LDADD Additional loader objects. 320 321MAN The manual pages to be installed (use a .1 - .9 suffix). 322 323SRCS List of source files to build the library. Suffix types 324 .s, .c, and .f are supported. Note, .s files are preferred 325 to .c files of the same name. (This is not the default for 326 versions of make.) 327 328The include file <bsd.lib.mk> includes the file named "../Makefile.inc" 329if it exists, as well as the include file <bsd.man.mk>. 330 331It has rules for building profiled objects; profiled libraries are 332built by default. 333 334Libraries are ranlib'd before installation. 335