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 := $(CURDIR)
  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 ifeq (,$(strip $(AUTOCONF)))
  97 AUTOCONF=$(error Couldn't find autoconf 2.13)
  98 endif
  99
 100 MKDIR := mkdir
 101 SH := /bin/sh
 102 ifndef MAKE
 103 MAKE := gmake
 104 endif
 105 PERL ?= perl
 106 PYTHON ?= python
 107
 108 RUN_AUTOCONF_LOCALLY = 1
 109 CONFIG_GUESS_SCRIPT := $(wildcard $(TOPSRCDIR)/build/autoconf/config.guess)
 110 ifdef CONFIG_GUESS_SCRIPT
 111   CONFIG_GUESS = $(shell $(CONFIG_GUESS_SCRIPT))
 112 endif
 113
 114
 115 ####################################
 116 # Sanity checks
 117
 118 ifneq (,$(filter MINGW%,$(shell uname -s)))
 119 # check for CRLF line endings
 120 ifneq (0,$(shell $(PERL) -e 'binmode(STDIN); while (<STDIN>) { if (/\r/) { print "1"; exit } } print "0"' < $(TOPSRCDIR)/client.mk))
 121 $(error This source tree appears to have Windows-style line endings. To \
 122 convert it to Unix-style line endings, run \
 123 "python mozilla/build/win32/mozilla-dos2unix.py")
 124 endif
 125 endif
 126
 127 ####################################
 128 # Load mozconfig Options
 129
 130 # See build pages, http://www.mozilla.org/build/ for how to set up mozconfig.
 131
 132 MOZCONFIG_LOADER := build/autoconf/mozconfig2client-mk
 133 MOZCONFIG_FINDER := build/autoconf/mozconfig-find
 134 MOZCONFIG_MODULES := build/unix/uniq.pl
 135
 136
 137
 138 run_for_side_effects := \
 139   $(shell $(TOPSRCDIR)/$(MOZCONFIG_LOADER) $(TOPSRCDIR) $(TOPSRCDIR)/.mozconfig.mk > $(TOPSRCDIR)/.mozconfig.out)
 140
 141 include $(TOPSRCDIR)/.mozconfig.mk
 142
 143 ifdef MOZ_BUILD_PROJECTS
 144
 145 ifndef MOZ_OBJDIR
 146   $(error When MOZ_BUILD_PROJECTS is set, you must set MOZ_OBJDIR)
 147 endif
 148 ifdef MOZ_CURRENT_PROJECT
 149   OBJDIR = $(MOZ_OBJDIR)/$(MOZ_CURRENT_PROJECT)
 150   MOZ_MAKE = $(MAKE) $(MOZ_MAKE_FLAGS) -C $(OBJDIR)
 151   BUILD_PROJECT_ARG = MOZ_BUILD_APP=$(MOZ_CURRENT_PROJECT)
 152 else
 153   OBJDIR = $(error Cannot find the OBJDIR when MOZ_CURRENT_PROJECT is not set.)
 154   MOZ_MAKE = $(error Cannot build in the OBJDIR when MOZ_CURRENT_PROJECT is not set.)
 155 endif
 156
 157 else # MOZ_BUILD_PROJECTS
 158
 159 ifdef MOZ_OBJDIR
 160   OBJDIR = $(MOZ_OBJDIR)
 161   MOZ_MAKE = $(MAKE) $(MOZ_MAKE_FLAGS) -C $(OBJDIR)
 162 else
 163   OBJDIR := $(TOPSRCDIR)
 164   MOZ_MAKE := $(MAKE) $(MOZ_MAKE_FLAGS)
 165 endif
 166
 167 endif # MOZ_BUILD_PROJECTS
 168
 169 # 'configure' scripts generated by autoconf.
 170 CONFIGURES := $(TOPSRCDIR)/configure
 171 CONFIGURES += $(TOPSRCDIR)/js/src/configure
 172
 173 #######################################################################
 174 # Rules
 175 #
 176
 177 # The default rule is build
 178 build::
 179
 180 # Print out any options loaded from mozconfig.
 181 all build clean depend distclean export libs install realclean::
 182         @if test -f .mozconfig.out; then \
 183           cat .mozconfig.out; \
 184           rm -f .mozconfig.out; \
 185         else true; \
 186         fi
 187
 188 # Windows equivalents
 189 build_all: build
 190 build_all_dep: alldep
 191 build_all_depend: alldep
 192 clobber clobber_all: clean
 193
 194 # Do everything from scratch
 195 everything: clean build
 196
 197 ####################################
 198 # Profile-Guided Optimization
 199 #  To use this, you should set the following variables in your mozconfig
 200 #    mk_add_options PROFILE_GEN_SCRIPT=/path/to/profile-script
 201 #
 202 #  The profile script should exercise the functionality to be included
 203 #  in the profile feedback.
 204 #
 205 #  This is up here, outside of the MOZ_CURRENT_PROJECT logic so that this
 206 #  is usable in multi-pass builds, where you might not have a runnable
 207 #  application until all the build passes and postflight scripts have run.
 208 ifdef MOZ_OBJDIR
 209   PGO_OBJDIR = $(MOZ_OBJDIR)
 210 else
 211   PGO_OBJDIR := $(TOPSRCDIR)
 212 endif
 213
 214 profiledbuild::
 215         $(MAKE) -f $(TOPSRCDIR)/client.mk build MOZ_PROFILE_GENERATE=1
 216         OBJDIR=${PGO_OBJDIR} $(PROFILE_GEN_SCRIPT)
 217         $(MAKE) -f $(TOPSRCDIR)/client.mk maybe_clobber_profiledbuild
 218         $(MAKE) -f $(TOPSRCDIR)/client.mk build MOZ_PROFILE_USE=1
 219
 220 #####################################################
 221 # Build date unification
 222
 223 ifdef MOZ_UNIFY_BDATE
 224 ifndef MOZ_BUILD_DATE
 225 ifdef MOZ_BUILD_PROJECTS
 226 MOZ_BUILD_DATE = $(shell $(PYTHON) $(TOPSRCDIR)/toolkit/xre/make-platformini.py --print-buildid)
 227 export MOZ_BUILD_DATE
 228 endif
 229 endif
 230 endif
 231
 232 #####################################################
 233 # Preflight, before building any project
 234
 235 build alldep preflight_all::
 236 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_PREFLIGHT_ALL),,1))
 237 # Don't run preflight_all for individual projects in multi-project builds
 238 # (when MOZ_CURRENT_PROJECT is set.)
 239 ifndef MOZ_BUILD_PROJECTS
 240 # Building a single project, OBJDIR is usable.
 241         set -e; \
 242         for mkfile in $(MOZ_PREFLIGHT_ALL); do \
 243           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight_all TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 244         done
 245 else
 246 # OBJDIR refers to the project-specific OBJDIR, which is not available at
 247 # this point when building multiple projects.  Only MOZ_OBJDIR is available.
 248         set -e; \
 249         for mkfile in $(MOZ_PREFLIGHT_ALL); do \
 250           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight_all TOPSRCDIR=$(TOPSRCDIR) MOZ_OBJDIR=$(MOZ_OBJDIR) MOZ_BUILD_PROJECTS="$(MOZ_BUILD_PROJECTS)"; \
 251         done
 252 endif
 253 endif
 254
 255 # If we're building multiple projects, but haven't specified which project,
 256 # loop through them.
 257
 258 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_BUILD_PROJECTS),,1))
 259 configure depend build install export libs clean realclean distclean alldep preflight postflight maybe_clobber_profiledbuild upload sdk::
 260         set -e; \
 261         for app in $(MOZ_BUILD_PROJECTS); do \
 262           $(MAKE) -f $(TOPSRCDIR)/client.mk $@ MOZ_CURRENT_PROJECT=$$app; \
 263         done
 264
 265 else
 266
 267 # MOZ_CURRENT_PROJECT: either doing a single-project build, or building an
 268 # individual project in a multi-project build.
 269
 270 ####################################
 271 # Configure
 272
 273 CONFIG_STATUS = $(wildcard $(OBJDIR)/config.status)
 274 CONFIG_CACHE  = $(wildcard $(OBJDIR)/config.cache)
 275
 276 ifdef RUN_AUTOCONF_LOCALLY
 277 EXTRA_CONFIG_DEPS := \
 278         $(TOPSRCDIR)/aclocal.m4 \
 279         $(wildcard $(TOPSRCDIR)/build/autoconf/*.m4) \
 280         $(TOPSRCDIR)/js/src/aclocal.m4 \
 281         $(NULL)
 282
 283 $(CONFIGURES): %: %.in $(EXTRA_CONFIG_DEPS)
 284         @echo Generating $@ using autoconf
 285         cd $(@D); $(AUTOCONF)
 286 endif
 287
 288 CONFIG_STATUS_DEPS := \
 289         $(wildcard $(CONFIGURES)) \
 290         $(TOPSRCDIR)/allmakefiles.sh \
 291         $(TOPSRCDIR)/.mozconfig.mk \
 292         $(wildcard $(TOPSRCDIR)/nsprpub/configure) \
 293         $(wildcard $(TOPSRCDIR)/config/milestone.txt) \
 294         $(wildcard $(TOPSRCDIR)/config/chrome-versions.sh) \
 295   $(wildcard $(addsuffix confvars.sh,$(wildcard $(TOPSRCDIR)/*/))) \
 296         $(NULL)
 297
 298 # configure uses the program name to determine @srcdir@. Calling it without
 299 #   $(TOPSRCDIR) will set @srcdir@ to "."; otherwise, it is set to the full
 300 #   path of $(TOPSRCDIR).
 301 ifeq ($(TOPSRCDIR),$(OBJDIR))
 302   CONFIGURE = ./configure
 303 else
 304   CONFIGURE = $(TOPSRCDIR)/configure
 305 endif
 306
 307 ifdef MOZ_TOOLS
 308   CONFIGURE = $(TOPSRCDIR)/configure
 309 endif
 310
 311 configure-files: $(CONFIGURES)
 312
 313 configure:: configure-files
 314 ifdef MOZ_BUILD_PROJECTS
 315         @if test ! -d $(MOZ_OBJDIR); then $(MKDIR) $(MOZ_OBJDIR); else true; fi
 316 endif
 317         @if test ! -d $(OBJDIR); then $(MKDIR) $(OBJDIR); else true; fi
 318         @echo cd $(OBJDIR);
 319         @echo $(CONFIGURE) $(CONFIGURE_ARGS)
 320         @cd $(OBJDIR) && $(BUILD_PROJECT_ARG) $(CONFIGURE_ENV_ARGS) $(CONFIGURE) $(CONFIGURE_ARGS) \
 321           || ( echo "*** Fix above errors and then restart with\
 322                \"$(MAKE) -f client.mk build\"" && exit 1 )
 323         @touch $(OBJDIR)/Makefile
 324
 325 $(OBJDIR)/Makefile $(OBJDIR)/config.status: $(CONFIG_STATUS_DEPS)
 326         @$(MAKE) -f $(TOPSRCDIR)/client.mk configure
 327
 328 ifneq (,$(CONFIG_STATUS))
 329 $(OBJDIR)/config/autoconf.mk: $(TOPSRCDIR)/config/autoconf.mk.in
 330         cd $(OBJDIR); \
 331           CONFIG_FILES=config/autoconf.mk ./config.status
 332 endif
 333
 334
 335 ####################################
 336 # Depend
 337
 338 depend:: $(OBJDIR)/Makefile $(OBJDIR)/config.status
 339         $(MOZ_MAKE) export && $(MOZ_MAKE) depend
 340
 341 ####################################
 342 # Preflight
 343
 344 build alldep preflight::
 345 ifdef MOZ_PREFLIGHT
 346         set -e; \
 347         for mkfile in $(MOZ_PREFLIGHT); do \
 348           $(MAKE) -f $(TOPSRCDIR)/$$mkfile preflight TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 349         done
 350 endif
 351
 352 ####################################
 353 # Build it
 354
 355 build::  $(OBJDIR)/Makefile $(OBJDIR)/config.status
 356         $(MOZ_MAKE)
 357
 358 ####################################
 359 # Other targets
 360
 361 # Pass these target onto the real build system
 362 install export libs clean realclean distclean alldep maybe_clobber_profiledbuild upload sdk:: $(OBJDIR)/Makefile $(OBJDIR)/config.status
 363         $(MOZ_MAKE) $@
 364
 365 ####################################
 366 # Postflight
 367
 368 build alldep postflight::
 369 ifdef MOZ_POSTFLIGHT
 370         set -e; \
 371         for mkfile in $(MOZ_POSTFLIGHT); do \
 372           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 373         done
 374 endif
 375
 376 endif # MOZ_CURRENT_PROJECT
 377
 378 ####################################
 379 # Postflight, after building all projects
 380
 381 build alldep postflight_all::
 382 ifeq (,$(MOZ_CURRENT_PROJECT)$(if $(MOZ_POSTFLIGHT_ALL),,1))
 383 # Don't run postflight_all for individual projects in multi-project builds
 384 # (when MOZ_CURRENT_PROJECT is set.)
 385 ifndef MOZ_BUILD_PROJECTS
 386 # Building a single project, OBJDIR is usable.
 387         set -e; \
 388         for mkfile in $(MOZ_POSTFLIGHT_ALL); do \
 389           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight_all TOPSRCDIR=$(TOPSRCDIR) OBJDIR=$(OBJDIR) MOZ_OBJDIR=$(MOZ_OBJDIR); \
 390         done
 391 else
 392 # OBJDIR refers to the project-specific OBJDIR, which is not available at
 393 # this point when building multiple projects.  Only MOZ_OBJDIR is available.
 394         set -e; \
 395         for mkfile in $(MOZ_POSTFLIGHT_ALL); do \
 396           $(MAKE) -f $(TOPSRCDIR)/$$mkfile postflight_all TOPSRCDIR=$(TOPSRCDIR) MOZ_OBJDIR=$(MOZ_OBJDIR) MOZ_BUILD_PROJECTS="$(MOZ_BUILD_PROJECTS)"; \
 397         done
 398 endif
 399 endif
 400
 401 cleansrcdir:
 402         @cd $(TOPSRCDIR); \
 403         if [ -f Makefile ]; then \
 404           $(MAKE) distclean ; \
 405         else \
 406           echo "Removing object files from srcdir..."; \
 407           rm -fr `find . -type d \( -name .deps -print -o -name CVS \
 408                   -o -exec test ! -d {}/CVS \; \) -prune \
 409                   -o \( -name '*.[ao]' -o -name '*.so' \) -type f -print`; \
 410            build/autoconf/clean-config.sh; \
 411         fi;
 412
 413 echo-variable-%:
 414         @echo $($*)
 415
 416 # This makefile doesn't support parallel execution. It does pass
 417 # MOZ_MAKE_FLAGS to sub-make processes, so they will correctly execute
 418 # in parallel.
 419 .NOTPARALLEL:
 420
 421 .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