• file
• revisions
• annotate
• diff
• comparison
• raw

build/docs/mozinfo.rst@6474c204b198 (annotated)

build/docs/mozinfo.rst

Wed, 31 Dec 2014 06:09:35 +0100

author

Michael Schloh von Bennewitz <michael@schloh.com>

date

Wed, 31 Dec 2014 06:09:35 +0100

changeset 0

6474c204b198

permissions

-rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

michael@0	1	.. _mozinfo:
michael@0	2
michael@0	3	=======
michael@0	4	mozinfo
michael@0	5	=======
michael@0	6
michael@0	7	``mozinfo`` is a solution for representing a subset of build
michael@0	8	configuration and run-time data.
michael@0	9
michael@0	10	``mozinfo`` data is typically accessed through a ``mozinfo.json`` file
michael@0	11	which is written to the :term:`object directory` during build
michael@0	12	configuration. The code for writing this file lives in
michael@0	13	:py:mod:`mozbuild.mozinfo`.
michael@0	14
michael@0	15	``mozinfo.json`` is an object/dictionary of simple string values.
michael@0	16
michael@0	17	The attributes in ``mozinfo.json`` are used for many purposes. One use
michael@0	18	is to filter tests for applicability to the current build. For more on
michael@0	19	this, see :ref:`test_manifests`.
michael@0	20
michael@0	21	.. _mozinfo_attributes:
michael@0	22
michael@0	23	mozinfo.json Attributes
michael@0	24	=================================
michael@0	25
michael@0	26	``mozinfo`` currently records the following attributes.
michael@0	27
michael@0	28	appname
michael@0	29	The application being built.
michael@0	30
michael@0	31	Value comes from ``MOZ_APP_NAME`` from ``config.status``.
michael@0	32
michael@0	33	Optional.
michael@0	34
michael@0	35	asan
michael@0	36	Whether address sanitization is enabled.
michael@0	37
michael@0	38	Values are ``true`` and ``false``.
michael@0	39
michael@0	40	Always defined.
michael@0	41
michael@0	42	bin_suffix
michael@0	43	The file suffix for binaries produced with this build.
michael@0	44
michael@0	45	Values may be an empty string, as not all platforms have a binary
michael@0	46	suffix.
michael@0	47
michael@0	48	Always defined.
michael@0	49
michael@0	50	bits
michael@0	51	The number of bits in the CPU this build targets.
michael@0	52
michael@0	53	Values are typically ``32`` or ``64``.
michael@0	54
michael@0	55	Universal Mac builds do not have this key defined.
michael@0	56
michael@0	57	Unkown processor architectures (see ``processor`` below) may not have
michael@0	58	this key defined.
michael@0	59
michael@0	60	Optional.
michael@0	61
michael@0	62	buildapp
michael@0	63	The path to the XUL application being built.
michael@0	64
michael@0	65	For desktop Firefox, this is ``browser``. For Fennec, it's
michael@0	66	``mobile/android``. For B2G, it's ``b2g``.
michael@0	67
michael@0	68	crashreporter
michael@0	69	Whether the crash reporter is enabled for this build.
michael@0	70
michael@0	71	Values are ``true`` and ``false``.
michael@0	72
michael@0	73	Always defined.
michael@0	74
michael@0	75	datareporting
michael@0	76	Whether data reporting (MOZ_DATA_REPORTING) is enabled for this build.
michael@0	77
michael@0	78	Values are ``true`` and ``false``.
michael@0	79
michael@0	80	Always defined.
michael@0	81
michael@0	82	debug
michael@0	83	Whether this is a debug build.
michael@0	84
michael@0	85	Values are ``true`` and ``false``.
michael@0	86
michael@0	87	Always defined.
michael@0	88
michael@0	89	healthreport
michael@0	90	Whether the Health Report feature is enabled.
michael@0	91
michael@0	92	Values are ``true`` and ``false``.
michael@0	93
michael@0	94	Always defined.
michael@0	95
michael@0	96	mozconfig
michael@0	97	The path of the :ref:`mozconfig file <mozconfig>` used to produce this build.
michael@0	98
michael@0	99	Optional.
michael@0	100
michael@0	101	os
michael@0	102	The operating system the build is produced for. Values for tier-1
michael@0	103	supported platforms are ``linux``, ``win``, ``mac``, ``b2g``, and
michael@0	104	``android``. For other platforms, the value is the lowercase version
michael@0	105	of the ``OS_TARGET`` variable from ``config.status``.
michael@0	106
michael@0	107	Always defined.
michael@0	108
michael@0	109	processor
michael@0	110	Information about the processor architecture this build targets.
michael@0	111
michael@0	112	Values come from ``TARGET_CPU``, however some massaging may be
michael@0	113	performed.
michael@0	114
michael@0	115	If the build is a universal build on Mac (it targets both 32-bit and
michael@0	116	64-bit), the value is ``universal-x86-x86_64``.
michael@0	117
michael@0	118	If the value starts with ``arm``, the value is ``arm``.
michael@0	119
michael@0	120	If the value starts with a string of the form ``i[3-9]86]``, the
michael@0	121	value is ``x86``.
michael@0	122
michael@0	123	Always defined.
michael@0	124
michael@0	125	tests_enabled
michael@0	126	Whether tests are enabled for this build.
michael@0	127
michael@0	128	Values are ``true`` and ``false``.
michael@0	129
michael@0	130	Always defined.
michael@0	131
michael@0	132	toolkit
michael@0	133	The widget toolkit in case. The value comes from the
michael@0	134	``MOZ_WIDGET_TOOLKIT`` ``config.status`` variable.
michael@0	135
michael@0	136	Always defined.
michael@0	137
michael@0	138	topsrcdir
michael@0	139	The path to the source directory the build came from.
michael@0	140
michael@0	141	Always defined.
michael@0	142
michael@0	143	wave
michael@0	144	Whether Wave audio support is enabled.
michael@0	145
michael@0	146	Values are ``true`` and ``false``.
michael@0	147
michael@0	148	Always defined.
michael@0	149
michael@0	150	webm
michael@0	151	Whether WebM support is enabled.
michael@0	152
michael@0	153	Values are ``true`` and ``false``.
michael@0	154
michael@0	155	Always defined.