[Midnightbsd-cvs] src [10282] trunk/share/mk/bsd.README: update readme
laffer1 at midnightbsd.org
laffer1 at midnightbsd.org
Sun Jun 3 09:51:05 EDT 2018
Revision: 10282
http://svnweb.midnightbsd.org/src/?rev=10282
Author: laffer1
Date: 2018-06-03 09:51:04 -0400 (Sun, 03 Jun 2018)
Log Message:
-----------
update readme
Modified Paths:
--------------
trunk/share/mk/bsd.README
Property Changed:
----------------
trunk/share/mk/bsd.README
Modified: trunk/share/mk/bsd.README
===================================================================
--- trunk/share/mk/bsd.README 2018-06-03 13:48:00 UTC (rev 10281)
+++ trunk/share/mk/bsd.README 2018-06-03 13:51:04 UTC (rev 10282)
@@ -1,6 +1,6 @@
# @(#)bsd.README 8.2 (Berkeley) 4/2/94
-# $FreeBSD: src/share/mk/bsd.README,v 1.28 2004/12/21 08:46:54 ru Exp $
-# $MidnightBSD: src/share/mk/bsd.README,v 1.5 2009/04/15 02:11:37 laffer1 Exp $
+# $FreeBSD: stable/10/share/mk/bsd.README 318165 2017-05-10 23:14:09Z jhb $
+# $MidnightBSD$
This is the README file for the "include" files for the MidnightBSD
source tree. The files are installed in /usr/share/mk, and are by
@@ -18,6 +18,7 @@
bsd.lib.mk.
bsd.cpu.mk - sets CPU/arch-related variables
+bsd.crunchgen.mk - building crunched binaries using crunchgen(1)
bsd.dep.mk - handle Makefile dependencies
bsd.doc.mk - building troff system documents
bsd.files.mk - install of general purpose files
@@ -33,15 +34,16 @@
bsd.obj.mk - creating 'obj' directories and cleaning up
bsd.own.mk - define common variables
bsd.patch.mk - archite's patch generation code
+bsd.mport.options.mk - building ports
bsd.port.mk - building ports
bsd.port.post.mk - building ports
bsd.port.pre.mk - building ports
-bsd.mport.options.mk - building ports
bsd.port.subdir.mk - targets for building subdirectories for ports
bsd.prog.mk - building programs from source files
bsd.snmpmod.mk - building modules for the SNMP daemon bsnmpd
bsd.subdir.mk - targets for building subdirectories
bsd.sys.mk - common settings used for building MidnightBSD sources
+bsd.test.mk - building test programs from source files
sys.mk - default rules for all makes
This file does not document bsd.port*.mk. They are documented in ports(7).
@@ -231,7 +233,7 @@
For example, to load with the compatibility and utility
libraries, use:
- LDFILES=-lutil -lcompat
+ LDADD=-lutil -lcompat
LDFLAGS Additional loader flags.
@@ -253,6 +255,38 @@
standard C++ library. PROG_CXX overrides the value
of PROG if PROG is also set.
+PROGS When used with <bsd.progs.mk>, allow building multiple
+PROGS_CXX PROG and PROG_CXX in one Makefile. To define
+ individual variables for each program the VAR.prog
+ syntax should be used. For example:
+
+ PROGS= foo bar
+ SRCS.foo= foo_src.c
+ LDADD.foo= -lutil
+ SRCS.bar= bar_src.c
+
+ The supported variables are:
+ - BINDIR
+ - BINGRP
+ - BINMODE
+ - BINOWN
+ - CFLAGS
+ - CXXFLAGS
+ - DEBUG_FLAGS
+ - DPADD
+ - DPSRCS
+ - INTERNALPROG (no installation)
+ - LDADD
+ - LDFLAGS
+ - LINKS
+ - MAN
+ - MLINKS
+ - NO_WERROR
+ - PROGNAME
+ - SRCS
+ - STRIP
+ - WARNS
+
PROGNAME The name that the above program will be installed as, if
different from ${PROG}.
@@ -264,7 +298,7 @@
libraries. For example, to depend on the compatibility and
utility libraries use:
- SRCLIB=${LIBCOMPAT} ${LIBUTIL}
+ DPADD=${LIBCOMPAT} ${LIBUTIL}
There is a predefined identifier for each (non-profiled,
non-shared) library and object. Library file names are
@@ -311,7 +345,7 @@
If foo does not have a manual page at all, add the line:
- NO_MAN=
+ MAN=
If foo has multiple source files, add the line:
@@ -319,6 +353,82 @@
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+The include file, <bsd.snmpmod.mk>, handles building MIB modules for bsnmpd
+from one or more source files, along with their manual pages. It has a
+limited number of suffixes, consistent with the current needs of the BSD
+tree.
+
+bsd.snmpmod.mk leverages bsd.lib.mk for building MIB modules and
+bsd.files.mk for installing MIB description and definition files.
+
+It implements the following additional targets:
+
+ smilint:
+ execute smilint on the MIBs defined by BMIBS.
+
+ The net-mgmt/libsmi package must be installed before
+ executing this target. The net-mgmt/net-snmp package
+ should be installed as well to reduce false positives
+ from smilint.
+
+It sets/uses the following variables:
+
+BMIBS The MIB definitions to install.
+
+BMIBSDIR The directory where the MIB definitions are installed.
+ This defaults to `${SHAREDIR}/snmp/mibs`.
+
+DEFS The MIB description files to install.
+
+DEFSDIR The directory where MIB description files are installed.
+ This defaults to `${SHAREDIR}/snmp/defs`.
+
+EXTRAMIBDEFS Extra MIB description files to use as input when
+ generating ${MOD}_oid.h and ${MOD}_tree.[ch].
+
+EXTRAMIBSYMS Extra MIB definition files used only for extracting
+ symbols.
+
+ EXTRAMIBSYMS are useful when resolving inter-module
+ dependencies and are useful with files containing only
+ enum-definitions.
+
+ See ${MOD}_oid.h for more details.
+
+LOCALBASE The package root where smilint and the net-snmp
+ definitions can be found
+
+MOD The bsnmpd module name.
+
+SMILINT smilint binary to use with the smilint make target.
+
+SMILINT_FLAGS flags to pass to smilint.
+
+SMIPATH A colon-separated directory path where MIBs definitions
+ can be found. See "SMIPATH" in smi_config for more
+ details.
+
+XSYM MIB names to extract symbols for. See ${MOD}_oid.h for
+ more details.
+
+It generates the following files:
+
+${MOD}_tree.c A source file and header which programmatically describes
+${MOD}_tree.h the MIB (type, OID name, ACCESS attributes, etc).
+
+ The files are generated via "gensnmptree -p".
+
+ See gensnmptree(1) for more details.
+
+${MOD}_oid.h A header which programmatically describes the MIB root and
+ MIB tables.
+
+ The files are generated via "gensnmptree -e".
+
+ See gensnmptree(1) for more details.
+
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+
The include file <bsd.subdir.mk> contains the default targets for building
subdirectories. It has the same seven targets as <bsd.prog.mk>: all, clean,
cleandir, depend, install, lint, and tags. For all of the directories
@@ -336,6 +446,13 @@
It sets/uses the following variables:
+LIB The name of the library to build.
+
+LIB_CXX The name of the library to build. It also causes
+ <bsd.lib.mk> to link the library with the
+ standard C++ library. LIB_CXX overrides the value
+ of LIB if LIB is also set.
+
LIBDIR Target directory for libraries.
LINTLIBDIR Target directory for lint libraries.
@@ -356,7 +473,7 @@
versions of make.)
SHLIB_LDSCRIPT Template file to generate shared library linker script.
- Unless used, a simple symlink is created to the real
+ If not defined, a simple symlink is created to the real
shared object.
LIBRARIES_ONLY Do not build or install files other than the library.
@@ -368,3 +485,116 @@
built by default.
Libraries are ranlib'd before installation.
+
+=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
+
+The include file <bsd.test.mk> handles building one or more test programs
+intended to be used in the MidnightBSD Test Suite under /usr/tests/.
+
+It has seven targets:
+
+ all:
+ build the test programs.
+ check:
+ runs the test programs from CHECKDIR with kyua test.
+
+ The beforecheck and aftercheck targets will be invoked, if
+ defined, to execute commands before and after the realcheck
+ target has been executed, respectively.
+
+ The devel/kyua package must be installed before invoking this
+ target.
+
+ See CHECKDIR for more details.
+ clean:
+ remove the test programs and any object files.
+ cleandir:
+ remove all of the files removed by the target clean, as
+ well as .depend and tags.
+ depend:
+ make the dependencies for the source files, and store
+ them in the file .depend.
+ install:
+ install the test programs and their data files; if the
+ Makefile does not itself define the target install, the
+ targets beforeinstall and afterinstall may also be used
+ to cause actions immediately before and after the
+ install target is executed.
+ lint:
+ run lint on the source files.
+ tags:
+ create a tags file for the source files.
+
+It sets/uses the following variables, among many others:
+
+TESTSBASE Installation prefix for tests. Defaults to /usr/tests
+
+TESTSDIR Path to the installed tests. Must be a subdirectory of
+ TESTSBASE and the subpath should match the relative
+ location of the tests within the src tree.
+
+ The value of TESTSDIR defaults to
+ ${TESTSBASE}/${RELDIR:H} , e.g. /usr/tests/bin/ls when
+ included from bin/ls/tests .
+
+CHECKDIR The directory that 'make check' executes tests from.
+
+ The value of CHECKDIR defaults to .OBJDIR.
+
+KYUAFILE If 'auto' (the default), generate a Kyuafile out of the
+ test programs defined in the Makefile. If 'yes', then a
+ manually-crafted Kyuafile must be supplied with the
+ sources. If 'no', no Kyuafile is installed (useful for
+ subdirectories providing helper programs or data files
+ only).
+
+LOCALBASE The --prefix for the kyua package.
+
+ The value of LOCALBASE defaults to /usr/local .
+
+ATF_TESTS_C The names of the ATF C test programs to build.
+
+ATF_TESTS_CXX The names of the ATF C++ test programs to build.
+
+ATF_TESTS_SH The names of the ATF sh test programs to build.
+
+PLAIN_TESTS_C The names of the plain (legacy) programs to build.
+
+PLAIN_TESTS_CXX The names of the plain (legacy) test programs to build.
+
+PLAIN_TESTS_SH The names of the plain (legacy) test programs to build.
+
+TAP_PERL_INTERPRETER
+ Path to the Perl interpreter to be used for
+ TAP-compliant test programs that are written in Perl.
+ Refer to TAP_TESTS_PERL for details.
+
+TAP_TESTS_C The names of the TAP-compliant C test programs to build.
+
+TAP_TESTS_CXX The names of the TAP-compliant C++ test programs to
+ build.
+
+TAP_TESTS_PERL The names of the TAP-compliant Perl test programs to
+ build. The corresponding source files should end with
+ the .pl extension; the test program is marked as
+ requiring Perl; and TAP_PERL_INTERPRETER is used in the
+ built scripts as the interpreter of choice.
+
+TAP_TESTS_SH The names of the TAP-compliant sh test programs to
+ build.
+
+TESTS_SUBDIRS List of subdirectories containing tests into which to
+ recurse. Differs from SUBDIR in that these directories
+ get registered into the automatically-generated
+ Kyuafile (if any).
+
+NOT_FOR_TEST_SUITE
+ If defined, none of the built test programs get
+ installed under /usr/tests/ and no Kyuafile is
+ automatically generated. Should not be used within the
+ MidnightBSD source tree but is provided for the benefit of
+ third-parties.
+
+The actual building of the test programs is performed by <bsd.prog.mk>.
+Please see the documentation above for this other file for additional
+details on the behavior of <bsd.test.mk>.
Property changes on: trunk/share/mk/bsd.README
___________________________________________________________________
Added: svn:keywords
## -0,0 +1 ##
+MidnightBSD=%H
\ No newline at end of property
More information about the Midnightbsd-cvs
mailing list