client.mk

   1 # ***** BEGIN LICENSE BLOCK *****
   2 # Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3 #
   4 # The contents of this file are subject to the Mozilla Public License Version
   5 # 1.1 (the "License"); you may not use this file except in compliance with
   6 # the License. You may obtain a copy of the License at
   7 # http://www.mozilla.org/MPL/
   8 #
   9 # Software distributed under the License is distributed on an "AS IS" basis,
  10 # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11 # for the specific language governing rights and limitations under the
  12 # License.
  13 #
  14 # The Original Code is mozilla.org code.
  15 #
  16 # The Initial Developer of the Original Code is
  17 # Netscape Communications Corporation.
  18 # Portions created by the Initial Developer are Copyright (C) 1998
  19 # the Initial Developer. All Rights Reserved.
  20 #
  21 # Contributor(s):
  22 #   Stephen Lamm
  23 #   Benjamin Smedberg <bsmedberg@covad.net>
  24 #   Chase Phillips <chase@mozilla.org>
  25 #   Mark Mentovai <mark@moxienet.com>
  26 #
  27 # Alternatively, the contents of this file may be used under the terms of
  28 # either the GNU General Public License Version 2 or later (the "GPL"), or
  29 # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30 # in which case the provisions of the GPL or the LGPL are applicable instead
  31 # of those above. If you wish to allow use of your version of this file only
  32 # under the terms of either the GPL or the LGPL, and not to allow others to
  33 # use your version of this file under the terms of the MPL, indicate your
  34 # decision by deleting the provisions above and replace them with the notice
  35 # and other provisions required by the GPL or the LGPL. If you do not delete
  36 # the provisions above, a recipient may use your version of this file under
  37 # the terms of any one of the MPL, the GPL or the LGPL.
  38 #
  39 # ***** END LICENSE BLOCK *****
  40
  41 # Build a mozilla application.
  42 #
  43 # To build a tree,
  44 #    1. hg clone ssh://hg.mozilla.org/mozilla-central mozilla
  45 #    2. cd mozilla
  46 #    3. create your .mozconfig file with
  47 #       ac_add_options --enable-application=browser
  48 #    4. gmake -f client.mk
  49 #
  50 # Other targets (gmake -f client.mk [targets...]),
  51 #    build
  52 #    clean (realclean is now the same as clean)
  53 #    distclean
  54 #
  55 # See http://developer.mozilla.org/en/docs/Build_Documentation for
  56 # more information.
  57 #
  58 # Options:
  59 #   MOZ_BUILD_PROJECTS   - Build multiple projects in subdirectories
  60 #                          of MOZ_OBJDIR
  61 #   MOZ_OBJDIR           - Destination object directory
  62 #   MOZ_MAKE_FLAGS       - Flags to pass to $(MAKE)
  63 #   MOZ_PREFLIGHT_ALL  } - Makefiles to run before any project in
  64 #   MOZ_PREFLIGHT      }   MOZ_BUILD_PROJECTS, before each project, after
  65 #   MOZ_POSTFLIGHT     }   each project, and after all projects; these
  66 #   MOZ_POSTFLIGHT_ALL }   variables contain space-separated lists
  67 #   MOZ_UNIFY_BDATE      - Set to use the same bdate for each project in
  68 #                          MOZ_BUILD_PROJECTS
  69 #
  70 #######################################################################
  71 # Defines
  72 #
  73 CVS = cvs
  74 comma := ,
  75
  76 CWD := $(shell pwd)
  77 ifneq (1,$(words $(CWD)))
  78 $(error The mozilla directory cannot be located in a path with spaces.)
  79 endif
  80
  81 ifeq "$(CWD)" "/"
  82 CWD   := /.
  83 endif
  84
  85 ifndef TOPSRCDIR
  86 ifeq (,$(wildcard client.mk))
  87 $(error Must run from the client.mk directory, or specify TOPSRCDIR)
  88 endif
  89 TOPSRCDIR = $(CWD)
  90 endif
  91
  92 # try to find autoconf 2.13 - discard errors from 'which'
  93 # MacOS X 10.4 sends "no autoconf*" errors to stdout, discard those via grep
  94 AUTOCONF ?= $(shell which autoconf-2.13 autoconf2.13 autoconf213 2>/dev/null | grep -v '^no autoconf' | head -1)
  95
  96 MKDIR := mkdir
  97 SH := /bin/sh
  98 ifndef MAKE
  99 MAKE := gmake
 100 endif
 101 PERL ?= perl
 102 PYTHON ?= python
 103
 104 RUN_AUTOCONF_LOCALLY = 1
 105 CONFIG_GUESS_SCRIPT := $(wildcard $(TOPSRCDIR)/build/autoconf/config.guess)
 106 ifdef CONFIG_GUESS_SCRIPT
 107   CONFIG_GUESS = $(shell $(CONFIG_GUESS_SCRIPT))
 108 endif
 109
 110
 111 ####################################
 112 # Sanity checks
 113
 114 ifneq (,$(filter MINGW%,$(shell uname -s)))
 115 # check for CRLF line endings
 116 ifneq (0,$(shell $(PERL) -e 'binmode(STDIN); while (<STDIN>) { if (/\r/) { print "1"; exit } } print "0"' < $(TOPSRCDIR)/client.mk))
 117 $(error This source tree appears to have Windows-style line endings. To \
 118 convert it to Unix-style line endings, run \
 119 "python mozilla/build/win32/mozilla-dos2unix.py")
 120 endif
 121 endif
 122
 123 ####################################
 124 # Load mozconfig Options
 125
 126 # See build pages, http://www.mozilla.org/build/ for how to set up mozconfig.
 127
 128 MOZCONFIG_LOADER := build/autoconf/mozconfig2client-mk
 129 MOZCONFIG_FINDER := build/autoconf/mozconfig-find
 130 MOZCONFIG_MODULES := build/unix/uniq.pl
 131
 132
 133
 134 run_for_side_effects := \
 135   $(shell $(TOPSRCDIR)/$(MOZCONFIG_LOADER) $(TOPSRCDIR) $(TOPSRCDIR)/.mozconfig.mk > $(TOPSRCDIR)/.mozconfig.out)
 136
 137 include $(TOPSRCDIR)/.mozconfig.mk
 138
 139 ifdef MOZ_BUILD_PROJECTS
 140
 141 ifndef MOZ_OBJDIR
 142   $(error When MOZ_BUILD_PROJECTS is set, you must set MOZ_OBJDIR)
 143 endif
 144 ifdef MOZ_CURRENT_PROJECT
 145   OBJDIR = $(MOZ_OBJDIR)/$(MOZ_CURRENT_PROJECT)
 146   MOZ_MAKE = $(MAKE) $(MOZ_MAKE_FLAGS) -C $(OBJDIR)
 147   BUILD_PROJECT_ARG = MOZ_BUILD_APP=$(MOZ_CURRENT_PROJECT)
 148 else
 149   OBJDIR = $(error Cannot find the OBJDIR when MOZ_CURRENT_PROJECT is not set.)
 150   MOZ_MAKE = $(error Cannot build in the OBJDIR when MOZ_CURRENT_PROJECT is not set.)
 151 endif
 152
 153 else # MOZ_BUILD_PROJECTS
 154
 155 ifdef MOZ_OBJDIR
 156   OBJDIR = $(MOZ_OBJDIR)
 157   MOZ_MAKE = $(MAKE) $(MOZ_MAKE_FLAGS) -C $(OBJDIR)
 158 else
 159   OBJDIR := $(TOPSRCDIR)
 160   MOZ_MAKE := $(MAKE) $(MOZ_MAKE_FLAGS)
 161 endif
 162
 163 endif # MOZ_BUILD_PROJECTS
 164
 165 # 'configure' scripts generated by autoconf.
 166 CONFIGURES := $(TOPSRCDIR)/configure
 167 CONFIGURES += $(TOPSRCDIR)/nsprpub/configure
 168
 169 #######################################################################
 170 # Rules
 171 #
 172
 173 # The default rule is build
 174 build::
 175
 176 # Print out any options loaded from mozconfig.
 177 all build clean depend distclean export libs install realclean::
 178         @if test -f .mozconfig.out; then \
 179           cat .mozconfig.out; \
 180           rm -f .mozconfig.out; \
 181         else true; \
 182         fi
 183
 184 # Windows equivalents
 185 build_all: build
 186 build_all_dep: alldep
 187 build_all_depend: alldep
 188 clobber clobber_all: clean
 189
 190 # Do everything from scratch
 191 everything: clean build
 192
 193 ####################################
 194 # Profile-Guided Optimization
 195 #  To use this, you should set the following variables in your mozconfig
 196 #    mk_add_options PROFILE_GEN_SCRIPT=/path/to/profile-script
 197 #
 198 #  The profile script should exercise the functionality to be included
 199 #  in the profile feedback.
 200 #
 201 #  This is up here, outside of the MOZ_CURRENT_PROJECT logic so that this
 202 #  is usable in multi-pass builds, where you might not have a runnable
 203 #  application until all the build passes and postflight scripts have run.
 204 ifdef MOZ_OBJDIR
 205   PGO_OBJDIR = $(MOZ_OBJDIR)
 206 else
 207   PGO_OBJDIR := $(TOPSRCDIR)
 208 endif
 209
 210 profiledbuild::
 211         $(MAKE) -f $(TOPSRCDIR)/client.mk build MOZ_PROFILE_GENERATE=1
 212         OBJDIR=${PGO_OBJDIR} $(PROFILE_GEN_SCRIPT)
 213         $(MAKE) -f $(TOPSRCDIR)/client.mk maybe_clobber_profiledbuild
 214         $(MAKE) -f $(TOPSRCDIR)/client.mk build MOZ_PROFILE_USE=1
 215
 216 #####################################################
 217 # Build date unification
 218
 219 ifdef MOZ_UNIFY_BDATE
 220 ifndef MOZ_BUILD_DATE
 221 ifdef MOZ_BUILD_PROJECTS
 222 MOZ_BUILD_DATE = $(shell $(PYTHON) $(TOPSRCDIR)/toolkit/xre/make-platformini.py --print-buildid)
 223 export MOZ_BUILD_DATE
 224 endif
 225 endif
 226 endif
 227
 228 #####################################################
 229 # Preflight, before building any project
 230
 231 build alldep preflight_all::
 232 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_PREFLIGHT_ALL),,1))
 233 # Don't run preflight_all for individual projects in multi-project builds
 234 # (when MOZ_CURRENT_PROJECT is set.)
 235 ifndef MOZ_BUILD_PROJECTS
 236 # Building a single project, OBJDIR is usable.
 237         set -e; \
 238         for mkfile in $(MOZ_PREFLIGHT_ALL); do \
 239           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight_all TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 240         done
 241 else
 242 # OBJDIR refers to the project-specific OBJDIR, which is not available at
 243 # this point when building multiple projects.  Only MOZ_OBJDIR is available.
 244         set -e; \
 245         for mkfile in $(MOZ_PREFLIGHT_ALL); do \
 246           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight_all TOPSRCDIR=$(TOPSRCDIR) MOZ_OBJDIR=$(MOZ_OBJDIR) MOZ_BUILD_PROJECTS="$(MOZ_BUILD_PROJECTS)"; \
 247         done
 248 endif
 249 endif
 250
 251 # If we're building multiple projects, but haven't specified which project,
 252 # loop through them.
 253
 254 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_BUILD_PROJECTS),,1))
 255 configure depend build install export libs clean realclean distclean alldep preflight postflight maybe_clobber_profiledbuild::
 256         set -e; \
 257         for app in $(MOZ_BUILD_PROJECTS); do \
 258           $(MAKE) -f $(TOPSRCDIR)/client.mk $@ MOZ_CURRENT_PROJECT=$$app; \
 259         done
 260
 261 else
 262
 263 # MOZ_CURRENT_PROJECT: either doing a single-project build, or building an
 264 # individual project in a multi-project build.
 265
 266 ####################################
 267 # Configure
 268
 269 CONFIG_STATUS = $(wildcard $(OBJDIR)/config.status)
 270 CONFIG_CACHE  = $(wildcard $(OBJDIR)/config.cache)
 271
 272 ifdef RUN_AUTOCONF_LOCALLY
 273 EXTRA_CONFIG_DEPS := \
 274         $(TOPSRCDIR)/aclocal.m4 \
 275         $(wildcard $(TOPSRCDIR)/build/autoconf/*.m4) \
 276         $(NULL)
 277
 278 $(CONFIGURES): %: %.in $(EXTRA_CONFIG_DEPS)
 279         @echo Generating $@ using autoconf
 280         cd $(@D); $(AUTOCONF)
 281 endif
 282
 283 CONFIG_STATUS_DEPS := \
 284         $(wildcard $(CONFIGURES)) \
 285         $(TOPSRCDIR)/allmakefiles.sh \
 286         $(TOPSRCDIR)/.mozconfig.mk \
 287         $(wildcard $(TOPSRCDIR)/directory/c-sdk/configure) \
 288         $(wildcard $(TOPSRCDIR)/config/milestone.txt) \
 289         $(wildcard $(TOPSRCDIR)/config/chrome-versions.sh) \
 290   $(wildcard $(addsuffix confvars.sh,$(wildcard $(TOPSRCDIR)/*/))) \
 291         $(NULL)
 292
 293 # configure uses the program name to determine @srcdir@. Calling it without
 294 #   $(TOPSRCDIR) will set @srcdir@ to "."; otherwise, it is set to the full
 295 #   path of $(TOPSRCDIR).
 296 ifeq ($(TOPSRCDIR),$(OBJDIR))
 297   CONFIGURE = ./configure
 298 else
 299   CONFIGURE = $(TOPSRCDIR)/configure
 300 endif
 301
 302 ifdef MOZ_TOOLS
 303   CONFIGURE = $(TOPSRCDIR)/configure
 304 endif
 305
 306 configure-files: $(CONFIGURES)
 307
 308 configure:: configure-files
 309 ifdef MOZ_BUILD_PROJECTS
 310         @if test ! -d $(MOZ_OBJDIR); then $(MKDIR) $(MOZ_OBJDIR); else true; fi
 311 endif
 312         @if test ! -d $(OBJDIR); then $(MKDIR) $(OBJDIR); else true; fi
 313         @echo cd $(OBJDIR);
 314         @echo $(CONFIGURE) $(CONFIGURE_ARGS)
 315         @cd $(OBJDIR) && $(BUILD_PROJECT_ARG) $(CONFIGURE_ENV_ARGS) $(CONFIGURE) $(CONFIGURE_ARGS) \
 316           || ( echo "*** Fix above errors and then restart with\
 317                \"$(MAKE) -f client.mk build\"" && exit 1 )
 318         @touch $(OBJDIR)/Makefile
 319
 320 $(OBJDIR)/Makefile $(OBJDIR)/config.status: $(CONFIG_STATUS_DEPS)
 321         @$(MAKE) -f $(TOPSRCDIR)/client.mk configure
 322
 323 ifneq (,$(CONFIG_STATUS))
 324 $(OBJDIR)/config/autoconf.mk: $(TOPSRCDIR)/config/autoconf.mk.in
 325         cd $(OBJDIR); \
 326           CONFIG_FILES=config/autoconf.mk ./config.status
 327 endif
 328
 329
 330 ####################################
 331 # Depend
 332
 333 depend:: $(OBJDIR)/Makefile $(OBJDIR)/config.status
 334         $(MOZ_MAKE) export && $(MOZ_MAKE) depend
 335
 336 ####################################
 337 # Preflight
 338
 339 build alldep preflight::
 340 ifdef MOZ_PREFLIGHT
 341         set -e; \
 342         for mkfile in $(MOZ_PREFLIGHT); do \
 343           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 344         done
 345 endif
 346
 347 ####################################
 348 # Build it
 349
 350 build::  $(OBJDIR)/Makefile $(OBJDIR)/config.status
 351         $(MOZ_MAKE)
 352
 353 ####################################
 354 # Other targets
 355
 356 # Pass these target onto the real build system
 357 install export libs clean realclean distclean alldep maybe_clobber_profiledbuild:: $(OBJDIR)/Makefile $(OBJDIR)/config.status
 358         $(MOZ_MAKE) $@
 359
 360 ####################################
 361 # Postflight
 362
 363 build alldep postflight::
 364 ifdef MOZ_POSTFLIGHT
 365         set -e; \
 366         for mkfile in $(MOZ_POSTFLIGHT); do \
 367           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 368         done
 369 endif
 370
 371 endif # MOZ_CURRENT_PROJECT
 372
 373 ####################################
 374 # Postflight, after building all projects
 375
 376 build alldep postflight_all::
 377 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_POSTFLIGHT_ALL),,1))
 378 # Don't run postflight_all for individual projects in multi-project builds
 379 # (when MOZ_CURRENT_PROJECT is set.)
 380 ifndef MOZ_BUILD_PROJECTS
 381 # Building a single project, OBJDIR is usable.
 382         set -e; \
 383         for mkfile in $(MOZ_POSTFLIGHT_ALL); do \
 384           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight_all TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 385         done
 386 else
 387 # OBJDIR refers to the project-specific OBJDIR, which is not available at
 388 # this point when building multiple projects.  Only MOZ_OBJDIR is available.
 389         set -e; \
 390         for mkfile in $(MOZ_POSTFLIGHT_ALL); do \
 391           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight_all TOPSRCDIR=$(TOPSRCDIR) MOZ_OBJDIR=$(MOZ_OBJDIR) MOZ_BUILD_PROJECTS="$(MOZ_BUILD_PROJECTS)"; \
 392         done
 393 endif
 394 endif
 395
 396 cleansrcdir:
 397         @cd $(TOPSRCDIR); \
 398         if [ -f Makefile ]; then \
 399           $(MAKE) distclean ; \
 400         else \
 401           echo "Removing object files from srcdir..."; \
 402           rm -fr `find . -type d \( -name .deps -print -o -name CVS \
 403                   -o -exec test ! -d {}/CVS \; \) -prune \
 404                   -o \( -name '*.[ao]' -o -name '*.so' \) -type f -print`; \
 405            build/autoconf/clean-config.sh; \
 406         fi;
 407
 408 echo-variable-%:
 409         @echo $($*)
 410
 411 .PHONY: checkout real_checkout depend build profiledbuild maybe_clobber_profiledbuild export libs alldep install clean realclean distclean cleansrcdir pull_all build_all clobber clobber_all pull_and_build_all everything configure preflight_all preflight postflight postflight_all