share/man/man5/bsd.port.arch.mk.5

   1 .\" $OpenBSD: bsd.port.arch.mk.5,v 1.7 2012/09/30 09:28:20 espie Exp $
   2 .\"
   3 .\" Copyright (c) 2011 Marc Espie
   4 .\"
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .Dd $Mdocdate: September 30 2012 $
  28 .Dt BSD.PORT.ARCH.MK 5
  29 .Os
  30 .Sh NAME
  31 .Nm bsd.port.arch.mk
  32 .Nd ports tree Makefile fragment, concerned with arch issues
  33 .Sh SYNOPSIS
  34 .Bd -literal
  35 # Set up such as
  36 MULTI_PACKAGES = -main -special
  37 ONLY_FOR_ARCHS-special = i386
  38 .Ed
  39 .Pp
  40 .Fd .include <bsd.port.arch.mk>
  41 .Bd -literal
  42 #some more lines such as
  43 \&.if ${BUILD_PACKAGES:M-special}
  44 CONFIGURE_ARGS += --enable-special
  45 \&.endif
  46 .Ed
  47 .Pp
  48 .Fd .include <bsd.port.mk>
  49 .Sh DESCRIPTION
  50 .Nm
  51 holds the logic used for arch-dependent builds in the ports tree.
  52 It is normally included as part of the larger
  53 .Xr bsd.port.mk 5 ,
  54 but it is also available separately for ports that require it.
  55 .Bl -bullet
  56 .It
  57 multi-packages ports that need to remove some subpackages based
  58 on pseudo-flavors or architecture constraints.
  59 .It
  60 ports that need to make explicit tests on arch-dependent constants.
  61 .El
  62 .Pp
  63 .Nm
  64 assumes the following variables are already defined:
  65 .Bl -tag -offset indent -compact -width ONLY_FOR_ARCH-<sub>
  66 .It MULTI_PACKAGES
  67 .It FLAVOR
  68 .It FLAVORS
  69 .It PSEUDO_FLAVORS
  70 .It Ev NOT_FOR_ARCHS[-<sub>]
  71 .It Ev ONLY_FOR_ARCHS[-<sub>]
  72 .El
  73 and optionally, if the default won't be appropriate
  74 .Bl -tag -offset indent -compact -width ONLY_FOR_ARCH-<sub>
  75 .It Ev NO_SHARED_LIBS
  76 .It Ev IGNORE[-<sub>]
  77 .El
  78 .Pp
  79 It will set up the following variables for use in the rest of the
  80 .Pa Makefile :
  81 .Bl -tag -offset indent -compact -width ONLY_FOR_ARCH-<sub>
  82 .It Ev ARCH
  83 .It Ev ALL_ARCHS
  84 .It Ev APM_ARCHS
  85 .It Ev BE_ARCHS
  86 .It Ev COMPILER_VERSION
  87 .It Ev GCC2_ARCHS
  88 .It Ev GCC3_ARCHS
  89 .It Ev GCC4_ARCHS
  90 .It Ev LE_ARCHS
  91 .It Ev LP64_ARCHS
  92 .It Ev NO_SHARED_ARCHS
  93 .It Ev NO_SHARED_LIBS
  94 .It Ev PROPERTIES
  95 .It Ev IGNORE-<sub>
  96 .It Ev BUILD_PACKAGES
  97 .El
  98 .Pp
  99 Most importantly,
 100 .Ev BUILD_PACKAGES
 101 will be correctly set up, taking
 102 .Ev ONLY_FOR_ARCHS[-<sub>]
 103 and
 104 .Ev NOT_FOR_ARCHS[-<sub>]
 105 limitations into account, as well as pseudo-flavors.
 106 .Pp
 107 Note that thanks to the way
 108 .Xr make 1
 109 variables are evaluated, a setup such as
 110 .Bd -literal -offset indent
 111 ONLY_FOR_ARCHS-foo = ${LP64_ARCHS}
 112 \&.include <bsd.port.arch.mk>
 113 .Ed
 114 .Pp
 115 is perfectly admissible, since
 116 .Ev ONLY_FOR_ARCHS-foo
 117 will be used only after
 118 .Ev LP64_ARCHS
 119 is defined.
 120 .Pp
 121 Also, you do not need to explicitly include
 122 .Pa bsd.port.arch.mk
 123 just to define
 124 .Bd -literal -offset indent
 125 ONLY_FOR_ARCHS = ${LP64_ARCHS}
 126 .Ed
 127 .Pp
 128 since
 129 .Pa bsd.port.mk
 130 does define arch constants before evaluating
 131 .Ev ONLY_FOR_ARCHS .
 132 A more detailed description of each variable is available in
 133 .Xr bsd.port.mk 5 .
 134 .Pp
 135 All the constant values
 136 .Ev ARCH , ALL_ARCHS , COMPILER_VERION , GCC2_ARCHS ,
 137 .Ev GCC3_ARCHS , GCC4_ARCHS , LP64_ARCHS , NO_SHARED_ARCHS
 138 and
 139 .Ev PROPERTIES
 140 are also available from
 141 .Ev MODULES
 142 and from
 143 .Pa ${.CURDIR}/../Makefile.inc .
 144 Note that due to historical accident,
 145 .Ev NO_SHARED_LIBS
 146 is not such a constant.
 147 Test
 148 .Ev PROPERTIES
 149 to assert whether a given platform supports shared libraries.
 150 .Sh SEE ALSO
 151 .Xr bsd.port.mk 5
 152 .Sh HISTORY
 153 .Nm
 154 was split from
 155 .Xr bsd.port.mk 5
 156 in
 157 .Ox 5.1 .