[avro] 02/02: AVRO-2963: Build documentation update

[ie...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

iemejia pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/avro.git

commit 3c99902f50e7998f972c491bfaecac2e3cacc981
Author: Ryan Skraba <ry...@skraba.com>
AuthorDate: Mon Jan 11 11:31:02 2021 +0100

    AVRO-2963: Build documentation update
---
 BUILD.md | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/BUILD.md b/BUILD.md
index d5febea..29cb324 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -22,8 +22,11 @@ The following packages must be installed before Avro can be built:
  - Apache Forrest 0.9 (for documentation)
  - md5sum, sha1sum, used by top-level dist target
 
-To simplify this, you can run a Docker container with all the above
-dependencies installed by installing Docker and run:
+## Using docker
+
+It can be simpler to use a Docker image with all of the requirements already
+installed. If you have Docker installed on your host machine, you can build
+inside a container by running:
 
 ```bash
 ./build.sh docker
@@ -42,6 +45,21 @@ The working directory in the container is mounted from your host. This
 allows you to access the files in your Avro development tree from the
 Docker container.
 
+There are some additional `DOCKER_` environment variables described in 
+[build.sh](./build.sh) that can be used to interact with the image using
+the build script. Some examples:
+
+```bash
+# Rebuild the docker image without using the build cache.
+DOCKER_BUILD_XTRA_ARGS=--no-cache ./build.sh docker
+
+# Build a docker image with a specific tag (for an RC or poc, for example)
+DOCKER_IMAGE_NAME=avro-build:1.10.1-rc1 ./build.sh docker
+
+# Run a command and return.
+DOCKER_RUN_ENTRYPOINT="mvn --version" ./build.sh docker
+```
+
 ## Building
 
 Once the requirements are installed (or from the Docker container),