build/docs/mozbuild/index.rst@6474c204b198 (annotated)
build/docs/mozbuild/index.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 | ======== |
| michael@0 | 2 | mozbuild |
| michael@0 | 3 | ======== |
| michael@0 | 4 | |
| michael@0 | 5 | mozbuild is a Python package providing functionality used by Mozilla's |
| michael@0 | 6 | build system. |
| michael@0 | 7 | |
| michael@0 | 8 | Modules Overview |
| michael@0 | 9 | ================ |
| michael@0 | 10 | |
| michael@0 | 11 | * mozbuild.backend -- Functionality for producing and interacting with build |
| michael@0 | 12 | backends. A build backend is an entity that consumes build system metadata |
| michael@0 | 13 | (from mozbuild.frontend) and does something useful with it (typically writing |
| michael@0 | 14 | out files that can be used by a build tool to build the tree). |
| michael@0 | 15 | * mozbuild.compilation -- Functionality related to compiling. This |
| michael@0 | 16 | includes managing compiler warnings. |
| michael@0 | 17 | * mozbuild.frontend -- Functionality for reading build frontend files |
| michael@0 | 18 | (what defines the build system) and converting them to data structures |
| michael@0 | 19 | which are fed into build backends to produce backend configurations. |
| michael@0 | 20 | * mozpack -- Functionality related to packaging builds. |
| michael@0 | 21 | |
| michael@0 | 22 | Overview |
| michael@0 | 23 | ======== |
| michael@0 | 24 | |
| michael@0 | 25 | The build system consists of frontend files that define what to do. They |
| michael@0 | 26 | say things like "compile X" "copy Y." |
| michael@0 | 27 | |
| michael@0 | 28 | The mozbuild.frontend package contains code for reading these frontend |
| michael@0 | 29 | files and converting them to static data structures. The set of produced |
| michael@0 | 30 | static data structures for the tree constitute the current build |
| michael@0 | 31 | configuration. |
| michael@0 | 32 | |
| michael@0 | 33 | There exist entities called build backends. From a high level, build |
| michael@0 | 34 | backends consume the build configuration and do something with it. They |
| michael@0 | 35 | typically produce tool-specific files such as make files which can be used |
| michael@0 | 36 | to build the tree. |
| michael@0 | 37 | |
| michael@0 | 38 | Piecing it all together, we have frontend files that are parsed into data |
| michael@0 | 39 | structures. These data structures are fed into a build backend. The output |
| michael@0 | 40 | from build backends is used by builders to build the tree. |
| michael@0 | 41 |
