Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(32)

Unified Diff: docs/using_build_runner.md

Issue 1319543002: A batch of docs style fixes. (Closed) Base URL: https://chromium.googlesource.com/chromium/src@master
Patch Set: addressed comments Created 5 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: docs/using_build_runner.md
diff --git a/docs/using_build_runner.md b/docs/using_build_runner.md
index fecb20b6f5226a8eac22e9d524ea477167d071e9..8e9d0f508afd3092c290f41f2066a2c16db40efc 100644
--- a/docs/using_build_runner.md
+++ b/docs/using_build_runner.md
@@ -1,65 +1,87 @@
-Instructions on how to use the buildrunner to execute builds.
+# Instructions on how to use the buildrunner to execute builds.
-# Introduction
+The buildrunner is a script which extracts buildsteps from builders and runs
+them locally on the slave. It is being developed to simplify development on and
+reduce the complexity of the Chromium build infrastructure. When provided a
+master name (with `master.cfg` inside) and a builder, it will either execute
+steps sequentially or output information about them.
-The buildrunner is a script which extracts buildsteps from builders and runs them locally on the slave. It is being developed to simplify development on and reduce the complexity of the Chromium build infrastructure. When provided a master name (with `master.cfg` inside) and a builder, it will either execute steps sequentially or output information about them.
+`runbuild.py` is the main script, while `runit.py` is a convenience script that
+sets up `PYTHONPATH` for you. Note that you can use `runit.py` to conveniently
+run other scripts in the `build/` directory.
-`runbuild.py` is the main script, while `runit.py` is a convenience script that sets up `PYTHONPATH` for you. Note that you can use `runit.py` to conveniently run other scripts in the `build/` directory.
+[TOC]
-# Master/Builder Selection
+## Master/Builder Selection
-`scripts/tools/runit.py scripts/slave/runbuild.py --list-masters`
+ scripts/tools/runit.py scripts/slave/runbuild.py --list-masters
-will list all masters in the search path. Select a mastername (alternatively, use --master-dir to use a specific directory).
+will list all masters in the search path. Select a mastername
+(alternatively, use --master-dir to use a specific directory).
-Next, we need to pick a builder or slave hostname to build. The slave hostname is only used to locate a suitable builder, so it need not be the actual hostname of the slave you're on.
+Next, we need to pick a builder or slave hostname to build. The slave hostname
+is only used to locate a suitable builder, so it need not be the actual hostname
+of the slave you're on.
To list all the builders in a master, run:
-`scripts/tools/runit.py scripts/slave/runbuild.py mastername --list-builders`
+ scripts/tools/runit.py scripts/slave/runbuild.py mastername --list-builders
Example, if you're in `/home/user/chromium/build/scripts/slave/`:
-`scripts/tools/runit.py scripts/slave/runbuild.py chromium --list-builders`
+ scripts/tools/runit.py scripts/slave/runbuild.py chromium --list-builders
will show you which builders are available under the `chromium` master.
-# Step Inspection and Execution
+## Step Inspection and Execution
You can check out the list of steps without actually running them like so:
-`scripts/tools/runit.py scripts/slave/runbuild.py chromium build56-m1 --list-steps`
+ scripts/tools/runit.py scripts/slave/runbuild.py chromium build56-m1 --list-steps
-(Note that some exotic steps, such as gclient steps, won't show up in buildrunner.) You can show the exact commands of most steps with --show-commands:
+Note that some exotic steps, such as gclient steps, won't show up in
+buildrunner.) You can show the exact commands of most steps with --show-
+commands:
-`scripts/tools/runit.py scripts/slave/runbuild.py chromium build56-m1 --show-commands`
+ scripts/tools/runit.py scripts/slave/runbuild.py chromium build56-m1 --show-commands
Finally, you can run the build with:
-`scripts/tools/runit.py scripts/slave/runbuild.py mastername buildername/slavehost`
+ scripts/tools/runit.py scripts/slave/runbuild.py mastername buildername/slavehost
Example, if you're in `/home/user/chromium/build/scripts/slave/`:
-`scripts/tools/runit.py scripts/slave/runbuild.py chromium build56-m1`
+ scripts/tools/runit.py scripts/slave/runbuild.py chromium build56-m1
or
-`scripts/tools/runit.py scripts/slave/runbuild.py chromium 'Linux x64'`
+ scripts/tools/runit.py scripts/slave/runbuild.py chromium 'Linux x64'
-`--stepfilter` and `--stepreject`` can be used to filter steps to execute based on a regex (you can see which with `--list-steps`). See `-help`for more info.
+`--stepfilter` and `--stepreject`` can be used to filter steps to execute based
+on a regex (you can see which with `--list-steps`). See `-help`for more info.
-# Properties
+## Properties
-Build properties and factory properties can be specified using `--build-properties` and `--factory-properties`, respectively. Since build properties contain a master and builder directive, any master or builder options on the CLI are ignored. Properties can be inspected with either or both of --output-build-properties or --output-factory-properties.
+Build properties and factory properties can be specified using `--build-
+properties` and `--factory-properties`, respectively. Since build properties
+contain a master and builder directive, any master or builder options on the CLI
+are ignored. Properties can be inspected with either or both of --output-build-
+properties or --output-factory-properties.
-# Monitoring
+## Monitoring
-You can specify a log destination (including '`-`' for stdout) with `--logfile`. Enabling `--annotate` will enable annotator output.
+You can specify a log destination (including '`-`' for stdout) with `--logfile`.
+Enabling `--annotate` will enable annotator output.
-# Using Within a Buildstep
+## Using Within a Buildstep
-The an annotated buildrunner can be invoked via chromium\_commands.AddBuildStep(). Set the master, builder, and any stepfilter/reject options in factory\_properties. For example usage, see f\_linux\_runnertest in master.chromium.fyi/master.cfg and check\_deps2git\_runner in chromium\_factory.py
+The an annotated buildrunner can be invoked via
+chromium_commands.AddBuildStep(). Set the master, builder, and any
+stepfilter/reject options in factory_properties. For example usage, see
+f_linux_runnertest in master.chromium.fyi/master.cfg and
+check_deps2git_runner in chromium_factory.py
-# More Information
+## More Information
-Running with `--help` provides more detailed usage and options. If you have any questions or issues please contact xusydoc@chromium.org.
+Running with `--help` provides more detailed usage and options. If you have any
+questions or issues please contact xusydoc@chromium.org.

Powered by Google App Engine
This is Rietveld 408576698