third_party.pigweed.src/docker/docs.rst
Wyatt Hepler f9fb90f299 docs: Make labels consistent; remove boilerplate
- Update labels so they use consistent naming. Instead of the
  copy-and-pasted `chapter` prefix, name labels with a prefix consistent
  with what they point to:
  - "module-" for module
  - "target-" for targets
  - "docs-" for general documentation
- Remove the unnecessary highlight and default-domain directives.
  Neither is necessary since the Pigweed docs always specify the
  language in code snippets and other directives.

Change-Id: I55c34e9ec919f6f4670e5d3d008e0edf5fecf05b
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/19328
Commit-Queue: Wyatt Hepler <hepler@google.com>
Reviewed-by: Keir Mierle <keir@google.com>
2020-10-01 21:47:35 +00:00

26 lines
1.1 KiB
ReStructuredText

------
docker
------
``pw_env_setup`` reliably initializes a working environment for Pigweed, but
can take awhile to run. It intelligently caches where it can, but that caching
is designed around a particular execution environment. That environment
assumption is poor when running tests with docker. To help out teams using
docker for automated testing, the Pigweed team has a publicly-available docker
image with a cache of some of the Pigweed environment. The current tag of this
image is in ``docker/tag`` under the Pigweed checkout.
To build your own docker image, start with ``docker/Dockerfile.cache`` and
run ``docker build --file docker/Dockerfile.cache .`` from the root of your
Pigweed checkout.
To use the publicly-available docker image, run
``docker build --file docker/Dockerfile.run --build-arg from=$(cat docker/tag) .``
from the root of your Pigweed checkout. You still need to run
``. ./bootstrap.sh`` within the docker image, but it should complete much
faster than on a vanilla docker image.
We're still trying to improve this process, so if you have any ideas for
improvements please `send us a note`_.
.. _send us a note: pigweed@googlegroups.com