1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/build/docs/environment-variables.rst Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,49 @@
1.4 +.. _environment_variables:
1.5 +
1.6 +================================================
1.7 +Environment Variables Impacting the Build System
1.8 +================================================
1.9 +
1.10 +Various environment variables have an impact on the behavior of the
1.11 +build system. This document attempts to document them.
1.12 +
1.13 +AUTOCLOBBER
1.14 + If defines, the build system will automatically clobber as needed.
1.15 + The default behavior is to print a message and error out when a
1.16 + clobber is needed.
1.17 +
1.18 + This variable is typically defined in a :ref:`mozconfig <mozconfig>`
1.19 + file via ``mk_add_options``.
1.20 +
1.21 +REBUILD_CHECK
1.22 + If defined, the build system will print information about why
1.23 + certain files were rebuilt.
1.24 +
1.25 + This feature is disabled by default because it makes the build slower.
1.26 +
1.27 +MACH_NO_TERMINAL_FOOTER
1.28 + If defined, the terminal footer displayed when building with mach in
1.29 + a TTY is disabled.
1.30 +
1.31 +MACH_NO_WRITE_TIMES
1.32 + If defined, mach commands will not prefix output lines with the
1.33 + elapsed time since program start. This option is equivalent to
1.34 + passing ``--log-no-times`` to mach.
1.35 +
1.36 +MOZ_PSEUDO_DERECURSE
1.37 + Activate an *experimental* build mode where make directory traversal
1.38 + is derecursified. This mode should result in faster build times at
1.39 + the expense of busted builds from time-to-time. The end goal is for
1.40 + this build mode to be the default. At which time, this variable will
1.41 + likely go away.
1.42 +
1.43 + A value of ``1`` activates the mode with full optimizations.
1.44 +
1.45 + A value of ``no-parallel-export`` activates the mode without
1.46 + optimizations to the *export* tier, which are known to be slightly
1.47 + buggy.
1.48 +
1.49 + A value of ``no-skip`` activates the mode without optimizations to skip
1.50 + some directories during traversal.
1.51 +
1.52 + Values may be combined with a comma.
