1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/build/docs/glossary.rst Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,48 @@
1.4 +========
1.5 +Glossary
1.6 +========
1.7 +
1.8 +.. glossary::
1.9 + :sorted:
1.10 +
1.11 + object directory
1.12 + A directory holding the output of the build system. The build
1.13 + system attempts to isolate all file modifications to this
1.14 + directory. By convention, object directories are commonly
1.15 + directories under the source directory prefixed with **obj-**.
1.16 + e.g. **obj-firefox**.
1.17 +
1.18 + mozconfig
1.19 + A shell script used to configure the build system.
1.20 +
1.21 + configure
1.22 + A generated shell script which detects the current system
1.23 + environment, applies a requested set of build configuration
1.24 + options, and writes out metadata to be consumed by the build
1.25 + system.
1.26 +
1.27 + config.status
1.28 + An executable file produced by **configure** that takes the
1.29 + generated build config and writes out files used to build the
1.30 + tree. Traditionally, config.status writes out a bunch of
1.31 + Makefiles.
1.32 +
1.33 + install manifest
1.34 + A file containing metadata describing file installation rules.
1.35 + A large part of the build system consists of copying files
1.36 + around to appropriate places. We write out special files
1.37 + describing the set of required operations so we can process the
1.38 + actions effeciently. These files are install manifests.
1.39 +
1.40 + clobber build
1.41 + A build performed with an initially empty object directory. All
1.42 + build actions must be performed.
1.43 +
1.44 + incremental build
1.45 + A build performed with the result of a previous build in an
1.46 + object directory. The build should not have to work as hard because
1.47 + it will be able to reuse the work from previous builds.
1.48 +
1.49 + mozinfo
1.50 + An API for accessing a common and limited subset of the build and
1.51 + run-time configuration. See :ref:`mozinfo`.
