Deleted Added
full compact
bsd.README (256281) bsd.README (264483)
1# @(#)bsd.README 8.2 (Berkeley) 4/2/94
1# @(#)bsd.README 8.2 (Berkeley) 4/2/94
2# $FreeBSD: stable/10/share/mk/bsd.README 245561 2013-01-17 17:27:10Z brooks $
2# $FreeBSD: stable/10/share/mk/bsd.README 264483 2014-04-14 23:51:57Z jmmv $
3
4This is the README file for the "include" files for the FreeBSD
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.

--- 23 unchanged lines hidden (view full) ---

34bsd.port.mk - building ports
35bsd.port.post.mk - building ports
36bsd.port.pre.mk - building ports
37bsd.port.subdir.mk - targets for building subdirectories for ports
38bsd.prog.mk - building programs from source files
39bsd.snmpmod.mk - building modules for the SNMP daemon bsnmpd
40bsd.subdir.mk - targets for building subdirectories
41bsd.sys.mk - common settings used for building FreeBSD sources
3
4This is the README file for the "include" files for the FreeBSD
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.

--- 23 unchanged lines hidden (view full) ---

34bsd.port.mk - building ports
35bsd.port.post.mk - building ports
36bsd.port.pre.mk - building ports
37bsd.port.subdir.mk - targets for building subdirectories for ports
38bsd.prog.mk - building programs from source files
39bsd.snmpmod.mk - building modules for the SNMP daemon bsnmpd
40bsd.subdir.mk - targets for building subdirectories
41bsd.sys.mk - common settings used for building FreeBSD sources
42bsd.test.mk - building test programs from source files
42sys.mk - default rules for all makes
43
44This file does not document bsd.port*.mk. They are documented in ports(7).
45
46See also make(1), mkdep(1), style.Makefile(5) and `PMake - A
47Tutorial', located in /usr/share/doc/psd/12.make.
48
49=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

--- 310 unchanged lines hidden (view full) ---

360
361The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
362if it exists, as well as the include file <bsd.man.mk>.
363
364It has rules for building profiled objects; profiled libraries are
365built by default.
366
367Libraries are ranlib'd before installation.
43sys.mk - default rules for all makes
44
45This file does not document bsd.port*.mk. They are documented in ports(7).
46
47See also make(1), mkdep(1), style.Makefile(5) and `PMake - A
48Tutorial', located in /usr/share/doc/psd/12.make.
49
50=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=

--- 310 unchanged lines hidden (view full) ---

361
362The include file <bsd.lib.mk> includes the file named "../Makefile.inc"
363if it exists, as well as the include file <bsd.man.mk>.
364
365It has rules for building profiled objects; profiled libraries are
366built by default.
367
368Libraries are ranlib'd before installation.
369
370=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
371
372The include file <bsd.test.mk> handles building one or more test programs
373intended to be used in the FreeBSD Test Suite under /usr/tests/.
374
375It has seven targets:
376
377 all:
378 build the test programs.
379 clean:
380 remove the test programs and any object files.
381 cleandir:
382 remove all of the files removed by the target clean, as
383 well as .depend and tags.
384 depend:
385 make the dependencies for the source files, and store
386 them in the file .depend.
387 install:
388 install the test programs and their data files; if the
389 Makefile does not itself define the target install, the
390 targets beforeinstall and afterinstall may also be used
391 to cause actions immediately before and after the
392 install target is executed.
393 lint:
394 run lint on the source files.
395 tags:
396 create a tags file for the source files.
397 test:
398 runs the test programs from the object directory; if the
399 Makefile does not itself define the target test, the
400 targets beforetest and aftertest may also be used to
401 cause actions immediately before and after the test
402 target is executed.
403
404It sets/uses the following variables, among many others:
405
406TESTDIR Path to the installed tests. Must be a subdirectory of
407 TESTSBASE and the subpath should match the relative
408 location of the tests within the src tree.
409
410KYUAFILE If 'auto' (the default), generate a Kyuafile out of the
411 test programs defined in the Makefile. If 'yes', then a
412 manually-crafted Kyuafile must be supplied with the
413 sources. If 'no', no Kyuafile is installed (useful for
414 subdirectories providing helper programs or data files
415 only).
416
417ATF_TESTS_C The names of the ATF C test programs to build.
418
419ATF_TESTS_CXX The names of the ATF C++ test programs to build.
420
421ATF_TESTS_SH The names of the ATF sh test programs to build.
422
423PLAIN_TESTS_C The names of the plain (legacy) programs to build.
424
425PLAIN_TESTS_CXX The names of the plain (legacy) test programs to build.
426
427PLAIN_TESTS_SH The names of the plain (legacy) test programs to build.
428
429TAP_PERL_INTERPRETER
430 Path to the Perl interpreter to be used for
431 TAP-compliant test programs that are written in Perl.
432 Refer to TAP_TESTS_PERL for details.
433
434TAP_TESTS_C The names of the TAP-compliant C test programs to build.
435
436TAP_TESTS_CXX The names of the TAP-compliant C++ test programs to
437 build.
438
439TAP_TESTS_PERL The names of the TAP-compliant Perl test programs to
440 build. The corresponding source files should end with
441 the .pl extension; the test program is marked as
442 requiring Perl; and TAP_PERL_INTERPRETER is used in the
443 built scripts as the interpreter of choice.
444
445TAP_TESTS_SH The names of the TAP-compliant sh test programs to
446 build.
447
448TESTS_SUBDIRS List of subdirectories containing tests into which to
449 recurse. Differs from SUBDIR in that these directories
450 get registered into the automatically-generated
451 Kyuafile (if any).
452
453NOT_FOR_TEST_SUITE
454 If defined, none of the built test programs get
455 installed under /usr/tests/ and no Kyuafile is
456 automatically generated. Should not be used within the
457 FreeBSD source tree but is provided for the benefit of
458 third-parties.
459
460The actual building of the test programs is performed by <bsd.prog.mk>.
461Please see the documentation above for this other file for additional
462details on the behavior of <bsd.test.mk>.