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