Bug 1223149 - Add basic usage documentation for mach build; r=glandium

Support for displaying docstrings in `mach help` was added relatively
recently. `mach build` was never documented. Let's document it.

There are a gazillion things we could put in the documentation. For now,
mainly focus on targets.
This commit is contained in:
Gregory Szorc 2015-11-10 15:41:08 -08:00
parent 3f3631e25d
commit 8daae9f220

View File

@ -274,6 +274,26 @@ class Build(MachCommandBase):
help='Verbose output for what commands the build is running.') help='Verbose output for what commands the build is running.')
def build(self, what=None, disable_extra_make_dependencies=None, jobs=0, def build(self, what=None, disable_extra_make_dependencies=None, jobs=0,
directory=None, verbose=False): directory=None, verbose=False):
"""Build the source tree.
With no arguments, this will perform a full build.
Positional arguments define targets to build. These can be make targets
or patterns like "<dir>/<target>" to indicate a make target within a
directory.
There are a few special targets that can be used to perform a partial
build faster than what `mach build` would perform:
* binaries - compiles and links all C/C++ sources and produces shared
libraries and executables (binaries).
* faster - builds JavaScript, XUL, CSS, etc files.
"binaries" and "faster" almost fully complement each other. However,
there are build actions not captured by either. If things don't appear to
be rebuilding, perform a vanilla `mach build` to rebuild the world.
"""
import which import which
from mozbuild.controller.building import BuildMonitor from mozbuild.controller.building import BuildMonitor
from mozbuild.util import resolve_target_to_make from mozbuild.util import resolve_target_to_make