mk/install.mk

   1 #
   2 #       install* installcheck installdirs
   3 #       install-docs*
   4 #
   5 #    Some of the above targets have a version that
   6 #    recursively invokes that target in sub-directories.
   7 #    This relies on the importing Makefile setting SUBDIRS
   8 #
   9 #    The recursive targets are marked with a * above
  10 #
  11
  12 ##################################################################
  13 #               GNU Standard targets
  14 #
  15 #       Every Makefile should define the following targets
  16 #
  17 # `install'
  18 #      Compile the program and copy the executables, libraries, and so on
  19 #      to the file names where they should reside for actual use. If
  20 #      there is a simple test to verify that a program is properly
  21 #      installed, this target should run that test.
  22 #
  23 #      The commands should create all the directories in which files are
  24 #      to be installed, if they don't already exist. This includes the
  25 #      directories specified as the values of the variables prefix and
  26 #      exec_prefix , as well as all subdirectories that are needed. One
  27 #      way to do this is by means of an installdirs target as described
  28 #      below.
  29 #
  30 #      Use `-' before any command for installing a man page, so that make
  31 #      will ignore any errors.  This is in case there are systems that
  32 #      don't have the Unix man page documentation system installed.
  33 #
  34 # The following targets are suggested as conventional names, for programs
  35 # in which they are useful.
  36 #
  37 # installcheck
  38 #      Perform installation tests (if any). The user must build and
  39 #      install the program before running the tests. You should not
  40 #      assume that `$(bindir)' is in the search path.
  41 #
  42 # installdirs
  43 #      It's useful to add a target named `installdirs' to create the
  44 #      directories where files are installed, and their parent
  45 #      directories. There is a script called `mkinstalldirs' which is
  46 #      convenient for this; find it in the Texinfo package.
  47 #      (GHC: we use a close relative of the suggested script, situated
  48 #       in glafp-utils/mkdirhier -- SOF)
  49
  50
  51
  52 # ---------------------------------------------------------------------------
  53 # Symbolic links
  54
  55 # links to programs: we sometimes install a program as
  56 # <name>-<version> with a link from <name> to the real program.
  57
  58 ifneq "$(LINK)" ""
  59
  60 ifeq "$(LINK_TARGET)" ""
  61 ifneq "$(HS_PROG)" ""
  62 LINK_TARGET = $(HS_PROG)
  63 else
  64 ifneq "$(C_PROG)" ""
  65 LINK_TARGET = $(C_PROG)
  66 else
  67 $(error Cannot deduce LINK_TARGET)
  68 endif
  69 endif
  70 endif
  71
  72 #
  73 # install links to script drivers.
  74 #
  75 install ::
  76         @$(INSTALL_DIR) $(bindir)
  77         @if ( $(PERL) -e '$$fn="$(bindir)/$(LINK)"; exit ((! -f $$fn || -l $$fn) ? 0 : 1);' ); then \
  78            echo "Creating a symbolic link from $(LINK_TARGET) to $(LINK) in $(bindir)"; \
  79            $(RM) $(bindir)/$(LINK); \
  80            $(LN_S) $(LINK_TARGET) $(bindir)/$(LINK); \
  81          else \
  82            echo "Creating a symbolic link from $(LINK_TARGET) to $(LINK) in $(bindir) failed: \`$(bindir)/$(LINK)' already exists"; \
  83            echo "Perhaps remove \`$(bindir)/$(LINK)' manually?"; \
  84            exit 1; \
  85          fi;
  86
  87 endif # LINK
  88
  89
  90 ###########################################
  91 #
  92 #       Targets: install install-strip
  93 #
  94 ###########################################
  95
  96 # For each of these variables that is defined, you
  97 # get one install rule
  98 #
  99 #       INSTALL_PROGS        executable programs in $(bindir)
 100 #       INSTALL_SCRIPTS      executable scripts in $(bindir)
 101 #       INSTALL_LIBS         platform-dependent libraries in $(libdir) (ranlib'ed)
 102 #       INSTALL_LIB_SCRIPTS  platform-dependent scripts   in $(libdir)
 103 #       INSTALL_LIBEXECS     platform-dependent execs in $(libdir)
 104 #       INSTALL_DATAS        platform-independent files in $(datadir)
 105 #       INSTALL_IFACES       platform-dependent interface files in $(ifacedir)
 106 #
 107 # If the installation directory variable is undefined, the install rule simply
 108 # emits a suitable error message.
 109 #
 110 # Remember, too, that the installation directory variables ($(bindir) and
 111 # friends can be overridden from their original settings in mk/config.mk.in
 112 # || mk/build.mk
 113 #
 114 .PHONY: install install-docs installdirs install-strip install-dirs install-docs show-install
 115
 116 show-install :
 117         @echo "bindir = $(bindir)"
 118         @echo "libdir = $(libdir)"
 119         @echo "libexecdir = $(libexecdir)  # by default, same as libdir"
 120         @echo "datadir = $(datadir)  # unused for ghc project"
 121
 122 #
 123 # Sometimes useful to separate out the creation of install directories
 124 # from the installation itself.
 125 #
 126 install-dirs ::
 127         @$(INSTALL_DIR) $(bindir)
 128         @$(INSTALL_DIR) $(libdir)
 129         @$(INSTALL_DIR) $(libexecdir)
 130         @$(INSTALL_DIR) $(datadir)
 131
 132 # Better do this first...
 133 # but we won't for the moment, do it on-demand from
 134 # within the various install targets instead.
 135 #install:: install-dirs
 136
 137 #
 138 # Setting user/group ownership for the installed entities
 139 #
 140 ifneq "$(INSTALL_OWNER)" ""
 141 SRC_INSTALL_OPTS += -o $(INSTALL_OWNER)
 142 endif
 143 ifneq "$(INSTALL_GROUP)" ""
 144 SRC_INSTALL_OPTS += -g $(INSTALL_GROUP)
 145 endif
 146
 147
 148 ifneq "$(strip $(INSTALL_PROGS))" ""
 149
 150 #
 151 # Here's an interesting one - when using the win32 version
 152 # of install (provided via the cygwin toolkit), we have to
 153 # supply the .exe suffix, *if* there's no other suffix.
 154 #
 155 # The rule below does this by ferreting out the suffix of each
 156 # entry in the INSTALL_PROGS list. If there's no suffix, use
 157 # $(exeext).
 158 #
 159 INSTALL_PROGS := $(foreach p, $(INSTALL_PROGS), $(addsuffix $(if $(suffix $(p)),,$(exeext)), $(basename $(p))))
 160
 161 install:: $(INSTALL_PROGS)
 162         @$(INSTALL_DIR) $(bindir)
 163         @for i in $(INSTALL_PROGS); do \
 164                     echo $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i $(bindir); \
 165                     $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i $(bindir) ;  \
 166                     if test "$(darwin_TARGET_OS)" = "1"; then \
 167                       sh $(FPTOOLS_TOP)/mk/fix_install_names.sh $(libdir) $(bindir)/$$i ; \
 168                     fi ; \
 169         done
 170 endif
 171
 172 #
 173 # Just like INSTALL_PROGS, but prefix with install sites bin/lib/data and
 174 # install without stripping.
 175 #
 176 ifneq "$(strip $(INSTALL_SCRIPTS))" ""
 177 install:: $(INSTALL_SCRIPTS)
 178         @$(INSTALL_DIR) $(bindir)
 179         for i in $(INSTALL_SCRIPTS); do \
 180                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(bindir); \
 181         done
 182 endif
 183
 184 ifneq "$(strip $(INSTALL_LIB_SCRIPTS))" ""
 185 install:: $(INSTALL_LIB_SCRIPTS)
 186         @$(INSTALL_DIR) $(libdir)
 187         for i in $(INSTALL_LIB_SCRIPTS); do \
 188                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(libdir); \
 189         done
 190 endif
 191
 192 ifneq "$(strip $(INSTALL_LIBEXEC_SCRIPTS))" ""
 193 install:: $(INSTALL_LIBEXEC_SCRIPTS)
 194         @$(INSTALL_DIR) $(libexecdir)
 195         for i in $(INSTALL_LIBEXEC_SCRIPTS); do \
 196                 $(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i $(libexecdir); \
 197         done
 198 endif
 199
 200 ifneq "$(strip $(INSTALL_LIBS))" ""
 201 install:: $(INSTALL_LIBS)
 202         @$(INSTALL_DIR) $(libdir)
 203         for i in $(INSTALL_LIBS); do \
 204                 case $$i in \
 205                   *.a) \
 206                     $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(libdir); \
 207                     $(RANLIB) $(libdir)/`basename $$i` ;; \
 208                   *.dll) \
 209                     $(INSTALL_DATA) -s $(INSTALL_OPTS) $$i $(libdir) ;; \
 210                   *.so) \
 211                     $(INSTALL_SHLIB) $(INSTALL_OPTS) $$i $(libdir) ;; \
 212                   *.dylib) \
 213                     $(INSTALL_SHLIB) $(INSTALL_OPTS) $$i $(libdir); \
 214                     install_name_tool -id $(libdir)/`basename $$i` $(libdir)/`basename $$i` ;; \
 215                   *) \
 216                     $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(libdir); \
 217                 esac; \
 218         done
 219 endif
 220
 221 ifneq "$(strip $(INSTALL_LIBEXECS))" ""
 222 #
 223 # See above comment next to defn of INSTALL_PROGS for what
 224 # the purpose of this one-liner is.
 225 #
 226 INSTALL_LIBEXECS := $(foreach p, $(INSTALL_LIBEXECS), $(addsuffix $(subst _,,$(subst __,$(exeext),_$(suffix $(p))_)), $(basename $(p))))
 227
 228 install:: $(INSTALL_LIBEXECS)
 229         @$(INSTALL_DIR) $(libexecdir)
 230         -for i in $(INSTALL_LIBEXECS); do \
 231                 $(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i $(libexecdir); \
 232                 if test "$(darwin_TARGET_OS)" = "1"; then \
 233                         sh $(FPTOOLS_TOP)/mk/fix_install_names.sh $(libdir) $(libexecdir)/`basename $$i` ; \
 234                 fi ; \
 235         done
 236 endif
 237
 238 ifneq "$(strip $(INSTALL_DATAS))" ""
 239 install:: $(INSTALL_DATAS)
 240         @$(INSTALL_DIR) $(datadir)
 241         for i in $(INSTALL_DATAS); do \
 242                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(datadir); \
 243         done
 244 endif
 245
 246 ifneq "$(strip $(INSTALL_HEADERS))" ""
 247 install:: $(INSTALL_HEADERS)
 248         @$(INSTALL_DIR) $(headerdir)
 249         for i in $(INSTALL_HEADERS); do \
 250                 $(INSTALL_HEADER) $(INSTALL_OPTS) $$i $(headerdir); \
 251         done
 252 endif
 253
 254 ifneq "$(strip $(INSTALL_IFACES))" ""
 255 install:: $(INSTALL_IFACES)
 256         @$(INSTALL_DIR) $(ifacedir)
 257         for i in $(INSTALL_IFACES); do \
 258                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(ifacedir); \
 259         done
 260 endif
 261
 262 ifneq "$(strip $(INSTALL_IFACES_WITH_DIRS))" ""
 263 install:: $(INSTALL_IFACES_WITH_DIRS)
 264         @$(INSTALL_DIR) $(ifacedir)
 265         for i in $(INSTALL_IFACES_WITH_DIRS); do \
 266                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(ifacedir)/`dirname $$i`; \
 267         done
 268 endif
 269
 270 ifneq "$(strip $(INSTALL_INCLUDES))" ""
 271 install:: $(INSTALL_INCLUDES)
 272         @$(INSTALL_DIR) $(includedir)
 273         for i in $(INSTALL_INCLUDES); do \
 274                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(includedir); \
 275         done
 276 endif
 277
 278 ifneq "$(strip $(INSTALL_DOCS))" ""
 279 ifneq "$(XMLDocWays)" ""
 280 install-docs:: $(INSTALL_DOCS)
 281         @$(INSTALL_DIR) $(datadir)
 282         for i in $(INSTALL_DOCS); do \
 283                 $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(datadir); \
 284         done
 285 endif
 286 endif
 287
 288 # TODO: The following could be an entry for an Obfuscated Makefile Contest...
 289 ifneq "$(strip $(INSTALL_XML_DOC))" ""
 290 ifneq "$(XMLDocWays)" ""
 291 install-docs:: $(foreach i,$(XMLDocWays),$(INSTALL_XML_DOC)$(patsubst %.html-no-chunks,%.html,$(patsubst %.html,%/index.html,.$(i))))
 292         @$(INSTALL_DIR) $(datadir)
 293         @for i in $(XMLDocWays); do \
 294                 if [ $$i = "html" ]; then \
 295                         $(INSTALL_DIR) $(datadir)/html; \
 296                         $(INSTALL_DIR) $(datadir)/html/$(INSTALL_XML_DOC); \
 297                         echo "( cd $(INSTALL_XML_DOC) && $(CP) * $(datadir)/html/$(INSTALL_XML_DOC) )" ; \
 298                         ( cd $(INSTALL_XML_DOC) && $(CP) * $(datadir)/html/$(INSTALL_XML_DOC) ) ; \
 299                 else \
 300                         $(INSTALL_DIR) $(datadir)/doc; \
 301                         echo $(INSTALL_DATA) $(INSTALL_OPTS) $(INSTALL_XML_DOC)`echo .$$i | sed s/\.html-no-chunks/.html/` $(datadir)/doc; \
 302                         $(INSTALL_DATA) $(INSTALL_OPTS) $(INSTALL_XML_DOC)`echo .$$i | sed s/\.html-no-chunks/.html/` $(datadir)/doc; \
 303                 fi; \
 304                 if [ $$i = "html-no-chunks" ]; then \
 305                         echo $(CP) $(FPTOOLS_CSS_ABS) $(datadir)/doc; \
 306                         $(CP) $(FPTOOLS_CSS_ABS) $(datadir)/doc; \
 307                 fi \
 308         done
 309 endif
 310 endif
 311
 312 #
 313 # install-strip is from the GNU Makefile standard.
 314 #
 315 ifneq "$(way)" ""
 316 install-strip::
 317         @$(MAKE) EXTRA_INSTALL_OPTS='-s' install
 318 endif
 319