mozconfigs.rst (1596B)
1 .. _mozconfig: 2 3 =============== 4 mozconfig Files 5 =============== 6 7 mozconfig files are used to configure how a build works. 8 9 mozconfig files are actually shell scripts. They are executed in a 10 special context with specific variables and functions exposed to them. 11 12 API 13 === 14 15 Functions 16 --------- 17 18 The following special functions are available to a mozconfig script. 19 20 ac_add_options 21 ^^^^^^^^^^^^^^ 22 23 This function is used to declare extra options/arguments to pass into 24 configure. 25 26 e.g.:: 27 28 ac_add_options --disable-tests 29 ac_add_options --enable-optimize 30 31 mk_add_options 32 ^^^^^^^^^^^^^^ 33 34 This function is used to inject statements into client.mk for execution. 35 It is typically used to define variables, notably the object directory. 36 37 e.g.:: 38 39 mk_add_options AUTOCLOBBER=1 40 41 Special mk_add_options Variables 42 -------------------------------- 43 44 For historical reasons, the method for communicating certain 45 well-defined variables is via mk_add_options(). In this section, we 46 document what those special variables are. 47 48 MOZ_OBJDIR 49 ^^^^^^^^^^ 50 51 This variable is used to define the :term:`object directory` for the current 52 build. 53 54 Finding the active mozconfig 55 ============================ 56 57 Multiple mozconfig files can exist to provide different configuration 58 options for different tasks. The rules for finding the active mozconfig 59 are defined in the 60 :py:func:`mozboot.mozconfig.find_mozconfig` method. 61 62 .. automodule:: mozboot.mozconfig 63 :members: find_mozconfig 64 65 Loading the active mozconfig 66 ---------------------------- 67 68 .. autoclass:: mozbuild.mozconfig.MozconfigLoader 69 :members: read_mozconfig