pkgsrc/mk/buildlink2
rh 8c4d9ffa48 Add *RECOMMENDED variables as discussed on tech-pkg@ to allow for a more
fine-grained distinction between required versions of pre-requisites
(DEPENDS) and versions that are recommended for security or library ABI
consistency reasons (RECOMMENDED).

  The contents of ${RECOMMENDED} are added to DEPENDS unless
IGNORE_RECOMMENDED is set to YES, in which case a warning will be printed
and IGNORE_RECOMMENDED will be added to BUILD_DEFS.

  Add a corresponding BUILDLINK_RECOMMENDED.<pkg> variable for use with
buildlink2 and buildlink3.
2004-01-14 06:57:45 +00:00
..
bsd.buildlink2.mk Add *RECOMMENDED variables as discussed on tech-pkg@ to allow for a more 2004-01-14 06:57:45 +00:00
buildlink2.txt More ideas: _STRIPFLAG_CC, _STRIPFLAG_INSTALL, compiler optimization flags. 2002-12-27 20:34:53 +00:00
fake-la Remove libraries from the output if they don't exist. 2003-12-30 12:09:27 +00:00
gen-transform.sh Merge pkgviews-mk branch into the HEAD by running: 2003-09-02 06:59:37 +00:00
ld-logic Rewrite wrapper scripts so that it is possible to add wrapper-specific 2002-12-26 17:08:55 +00:00
ld-post-cache Rewrite wrapper scripts so that it is possible to add wrapper-specific 2002-12-26 17:08:55 +00:00
libtool-do-install Rewrite wrapper scripts so that it is possible to add wrapper-specific 2002-12-26 17:08:55 +00:00
libtool-fix-la Merge pkgviews-mk branch into the HEAD by running: 2003-09-02 06:59:37 +00:00
libtool-logic Output warnings to stderr, not to stdout (duh!) 2003-01-07 07:34:39 +00:00
libtool-post-cache Add some libtool workarounds for software authors that don't follow the 2002-12-26 17:17:32 +00:00
libtool.sh Merge pkgviews-mk branch into the HEAD by running: 2003-09-02 06:59:37 +00:00
logic Fix indentation for case statement. 2003-01-10 09:41:53 +00:00
NOTES Merge pkgviews-mk branch into the HEAD by running: 2003-09-02 06:59:37 +00:00
post-cache Rewrite wrapper scripts so that it is possible to add wrapper-specific 2002-12-26 17:08:55 +00:00
pre-cache Rewrite wrapper scripts so that it is possible to add wrapper-specific 2002-12-26 17:08:55 +00:00
private-pre-cache Rewrite wrapper scripts so that it is possible to add wrapper-specific 2002-12-26 17:08:55 +00:00
README Rewrite wrapper scripts so that it is possible to add wrapper-specific 2002-12-26 17:08:55 +00:00
wrapper.sh Merge pkgviews-mk branch into the HEAD by running: 2003-09-02 06:59:37 +00:00

$NetBSD: README,v 1.5 2002/12/26 17:08:56 jlam Exp $

For more general information about the use of buildlink2, see the file
buildlink2.txt in this directory.

 0 buildlink2 Wrapper Script System
 ==================================

The purpose of the buildlink2 wrapper script system is to replace calls to
compiler tool with scripts that tranlate any arguments into their buildlink
equivalents, then invoke the actual compiler tools with the translated
arguments.  The pkgsrc/mk/buildlink2 directory contains bits of the wrapper
script system for the buildlink2 framework.  The wrapper script system is
composed of three parts: the main wrapper script, the "cache", and the
"logic" script.

 0.1 Main wrapper script
 =======================

The main wrapper script for a compiler tool (cc, ld, as, etc.) is
generated from wrapper.sh, except for the libtool wrapper script which is
generated from libtool.sh.  The wrapper scripts share a common set of logic
files that translate arguments into their buildlink equivalents.

 0.2 Cache
 =========

The cache is a giant Bourne shell "case" statement that stores
pre-translated arguments from previous wrapper invocations.  This allows
speedy translation of already-seen arguments without having to run the
utilities needed to perform a translation from scratch.  There are two
caches: the common cache and a wrapper-specific cache.  The common cache
is used by all wrapper scripts.  The wrapper-specific cache is read before
the common cache and contains wrapper-specific argument translation that
shouldn't be used by other wrapper scripts.

 0.3 Logic script
 ================

The logic script contains a large "case" statement that handles the
actual translation of an argument into its buildlink equivalent.  The logic
script also invokes a wrapper-specific logic script which may contain extra
commands that perform further translation of an argument after the main
translation has been performed by the logic script.  Finally, the logic
script may save the translations results into a cache file if requested by
the wrapper script.