gecko-dev/build/docs/index.rst

============
Build System
============

Important Concepts
==================
.. toctree::
   :maxdepth: 1

   glossary
   build-overview
   supported-configurations
   Mozconfig Files <mozconfigs>
   mozbuild-files
   mozbuild-symbols
   files-metadata
   Profile Guided Optimization <pgo>
   slow
   environment-variables
   build-targets
   python
   test_manifests
   mozinfo
   preprocessor
   jar-manifests
   defining-binaries
   defining-xpcom-components
   toolchains
   locales
   unified-builds
   cross-compile
   rust
   sparse
   Support for projects building with GN <gn>
   telemetry
   sccache-dist
   test_certificates

integrated development environment (IDE)
========================================
.. toctree::
   :maxdepth: 1

   androideclipse
   cppeclipse
   visualstudio

mozbuild
========

mozbuild is a Python package containing a lot of the code for the
Mozilla build system.

.. toctree::
   :maxdepth: 1

   mozbuild/index
Bug 939367 - Allow Sphinx docs to come from all over the tree; r=glandium --HG-- extra : rebase_source : 1c1a444a78c0dfce110db3890e29543eeb67f3aa 2013-11-20 20:37:22 +00:00			`============`
			`Build System`
			`============`
Bug 917988 - Sphinx managed build system documentation; add mach build-docs; r=bsmedberg --HG-- rename : python/mozbuild/dumbmake/README.rst => build/docs/mozbuild/dumbmake.rst rename : python/mozbuild/mozbuild/frontend/README.rst => build/docs/mozbuild/frontend.rst rename : python/mozbuild/README.rst => build/docs/mozbuild/index.rst 2013-09-20 22:46:43 +00:00
			`Important Concepts`
			`==================`
			`.. toctree::`
			`:maxdepth: 1`

Bug 939367 - Allow Sphinx docs to come from all over the tree; r=glandium --HG-- extra : rebase_source : 1c1a444a78c0dfce110db3890e29543eeb67f3aa 2013-11-20 20:37:22 +00:00			`glossary`
NO BUG - Expand build system documentation DONTBUILD (NPOTB) 2013-09-24 00:21:10 +00:00			`build-overview`
NO BUG - Build docs for supported build configurations DONTBUILD (NPOTB) --HG-- extra : rebase_source : 9d1ba5ca4568739c557410b20034671093e439c7 2013-11-20 18:52:48 +00:00			`supported-configurations`
Bug 917988 - Sphinx managed build system documentation; add mach build-docs; r=bsmedberg --HG-- rename : python/mozbuild/dumbmake/README.rst => build/docs/mozbuild/dumbmake.rst rename : python/mozbuild/mozbuild/frontend/README.rst => build/docs/mozbuild/frontend.rst rename : python/mozbuild/README.rst => build/docs/mozbuild/index.rst 2013-09-20 22:46:43 +00:00			`Mozconfig Files <mozconfigs>`
NO BUG - Update build system docs for Python and moz.build files DONTBUILD (NPOTB) 2013-09-30 12:32:07 +00:00			`mozbuild-files`
Bug 920638 - Integrate moz.build symbols and Python API docs into Sphinx; r=mshal 2013-10-10 17:35:44 +00:00			`mozbuild-symbols`
Bug 1132771 - Add Files to moz.build with ability to define Bugzilla component; r=glandium The Files sub-context allows us to attach metadata to files based on pattern matching rules. Patterns are matched against files in a last-write-wins fashion. The sub-context defines the BUG_COMPONENT variable, which is a 2-tuple (actually a named tuple) defining the Bugzilla product and component for files. There are no consumers yet. But an eventual use case will be to suggest a bug component for a patch/commit. Another will be to automatically suggest a bug component for a failing test. --HG-- extra : rebase_source : 9489738136d929a53db7f54bbe6acf3186e0a47c 2015-03-02 06:15:07 +00:00			`files-metadata`
Bug 917988 - Sphinx managed build system documentation; add mach build-docs; r=bsmedberg --HG-- rename : python/mozbuild/dumbmake/README.rst => build/docs/mozbuild/dumbmake.rst rename : python/mozbuild/mozbuild/frontend/README.rst => build/docs/mozbuild/frontend.rst rename : python/mozbuild/README.rst => build/docs/mozbuild/index.rst 2013-09-20 22:46:43 +00:00			`Profile Guided Optimization <pgo>`
NO BUG - Expand build system documentation DONTBUILD (NPOTB) 2013-09-24 00:21:10 +00:00			`slow`
			`environment-variables`
NO BUG - Document common build system targets, add requirements.txt DONTBUILD (NPOTB) 2013-09-29 08:43:49 +00:00			`build-targets`
NO BUG - Update build system docs for Python and moz.build files DONTBUILD (NPOTB) 2013-09-30 12:32:07 +00:00			`python`
Bug 901990 - Part 1: Integrate test manifests with build config; r=ted 2013-09-24 18:50:04 +00:00			`test_manifests`
NO BUG - Document mozinfo attributes, test manifest naming convention DONTBUILD (NPOTB) 2013-10-01 07:28:39 +00:00			`mozinfo`
NO BUG - Build docs for text preprocessor and jar manifests DONTBUILD (NPOTB) 2013-10-07 21:47:08 +00:00			`preprocessor`
			`jar-manifests`
Bug 1036894 part 10 - Documentation for programs and libraries in moz.build world. r=gps 2014-07-23 04:31:10 +00:00			`defining-binaries`
Bug 1478124: Part 7 - Add docs for static component manifests. r=froydnj Differential Revision: https://phabricator.services.mozilla.com/D15038 --HG-- extra : rebase_source : 0d029ccb0c7faab855194609041af22264b85d6e extra : source : 5d85deac61c2ee54a69525de8bdfff4be72d224c 2018-12-18 22:15:21 +00:00			`defining-xpcom-components`
Bug 1253707 - Script to generate visual studio toolchain archive; r=ted Previously, Windows toolchains and related dependencies (SDKs, etc) were installed on Windows builders by people responsible for maintaining those machines. This commit takes a step in a new direction. We introduce a script (complete with documentation) that can produce a zip archive (or any archive format if people want to implement support) of the toolchain files. Basically, you install Visual Studio 2015 Community, run the script, and produce a self-contained zip file containing everything from Microsoft you need to build Firefox. With a copy of this archive and an installation of MozillaBuild, it is possible to build Firefox on a fresh Windows installation. No time-consuming Visual Studio installation needed. The goal is to upload these archives to tooltool and have our Windows builders download and extract them at run-time. At which time, we can remove all the other Visual Studio and SDK files from builders because they don't need to be baked into the image. We may find tooltool's caching isn't good enough and we have to more aggressively caching the standalone toolchain files. But that is a problem for another day. Whatever happens, we'll need the functionality in this script to produce a self-contained archive of the toolchain. There are certainly files in the produced archive that aren't needed. I think perfect is the enemy of done and we can prune the archive over time, if wanted. MozReview-Commit-ID: EckEK1a6vA3 --HG-- extra : rebase_source : c328be792b2bfb4b3cb8acb50e4868277cb59974 extra : source : 4c980771e574e899a1b05319ad11fb6cffb00087 2016-03-11 23:00:02 +00:00			`toolchains`
Bug 1260241 - Post: Document how to run Android single-locale repacks. r=me MozReview-Commit-ID: 4BwhyNwrtjJ --HG-- extra : rebase_source : 224a9472aef3e3f1f1d275b7f24c54e0b3cf82f8 2016-04-01 00:25:17 +00:00			`locales`
Bug 1676915: Add documentation page about Unified Builds r=firefox-build-system-reviewers,mstange,dmajor DONTBUILD Describe what unified builds are and how they can cause innocuous changes to cause unexpected compilation failures. Differential Revision: https://phabricator.services.mozilla.com/D96907 2020-11-13 17:16:33 +00:00			`unified-builds`
Bug 1714547 - Add cross-compile to linux build doc r=sylvestre,mhentges Differential Revision: https://phabricator.services.mozilla.com/D116829 2021-06-04 21:35:25 +00:00			`cross-compile`
bug 1313448 - Add documentation for adding Rust code to the build system. r=froydnj MozReview-Commit-ID: IpblCfAKwrL --HG-- extra : rebase_source : cc9ccadc77da20c4043a26bec297d9764a807015 2016-10-27 19:25:40 +00:00			`rust`
Bug 1390700 - Documentation for sparse checkouts; r=me MozReview-Commit-ID: 571VpKWjImZ --HG-- extra : rebase_source : 726d0ab474d0a37e0a094243a71cba8bd51bf6ae 2017-08-24 22:39:11 +00:00			`sparse`
Bug 1427840 - Add in-tree docs for GN support in the build system. r=dminor MozReview-Commit-ID: AWsgvmMMIpX --HG-- extra : rebase_source : 399d292b429714b8d23e1fc2142b2aedd77c584d 2018-01-09 20:15:08 +00:00			`Support for projects building with GN <gn>`
Bug 1483941: add documentation about build telemetry r=ted This commit adds some documentation about build telemetry to the build system documentation. This doc should be used as a reference during opt-in to build system telemetry, and includes paths to the relevant files for users to audit independently. Documentation regarding the schema types and object properties was generated by the `jsonschema2rst` tool, available on PyPI. Differential Revision: https://phabricator.services.mozilla.com/D8030 --HG-- extra : moz-landing-system : lando 2018-10-10 19:58:47 +00:00			`telemetry`
Bug 1576737 - Add sccache-dist in offices docs to the tree. r=firefox-build-system-reviewers,mshal Differential Revision: https://phabricator.services.mozilla.com/D43531 --HG-- extra : moz-landing-system : lando 2019-08-27 22:10:54 +00:00			`sccache-dist`
Bug 1456089 - Make a tutorial out of the genpgocerts.py README. r=jcj Differential Revision: https://phabricator.services.mozilla.com/D20178 --HG-- extra : moz-landing-system : lando 2019-02-25 21:06:41 +00:00			`test_certificates`
Bug 973770 - Build backend that generates C/C++ Eclipse projects. r=gps 2014-03-06 05:03:10 +00:00
			`integrated development environment (IDE)`
			`========================================`
			`.. toctree::`
			`:maxdepth: 1`

No bug - Add skeleton AndroidEclipse backend build docs. r=me DONTBUILD NPOTB 2014-02-19 06:28:01 +00:00			`androideclipse`
Bug 973770 - Build backend that generates C/C++ Eclipse projects. r=gps 2014-03-06 05:03:10 +00:00			`cppeclipse`
			`visualstudio`
Bug 917988 - Sphinx managed build system documentation; add mach build-docs; r=bsmedberg --HG-- rename : python/mozbuild/dumbmake/README.rst => build/docs/mozbuild/dumbmake.rst rename : python/mozbuild/mozbuild/frontend/README.rst => build/docs/mozbuild/frontend.rst rename : python/mozbuild/README.rst => build/docs/mozbuild/index.rst 2013-09-20 22:46:43 +00:00
			`mozbuild`
			`========`

			`mozbuild is a Python package containing a lot of the code for the`
			`Mozilla build system.`

			`.. toctree::`
			`:maxdepth: 1`

			`mozbuild/index`