[Xen-devel] [PATCH] automation/build: Fix command, improve explanation

[Anthony PERARD <anthony.perard@xxxxxxxxxx>]

Fix the command to use shell syntax for environment variables.

Make it more explicite that the command `make` is going to modifie the
current directory.

Also include an example of what a container is.

Signed-off-by: Anthony PERARD <anthony.perard@xxxxxxxxxx>

---

I'm attempted to change the short options by their long equivalent as
it's often easier to understand a command we are not familiar with.
---
 automation/build/README.md | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/automation/build/README.md b/automation/build/README.md
index 0206d57e03..12b418dbbb 100644
--- a/automation/build/README.md
+++ b/automation/build/README.md
@@ -19,12 +19,16 @@ Building Xen
 From the top level of the source tree it should be possible to
 run the following:
 
-docker run --rm -it -v $(PWD):/build -u $(id -u) -e CC=gcc $(CONTAINER) make
+docker run --rm -it -v $PWD:/build -u $(id -u) -e CC=gcc $CONTAINER make
+
+With for e.g.:
+    CONTAINER=registry.gitlab.com/xen-project/xen/debian:jessie
+
+This will mount your current directory inside the specified container and run
+the `make` command.  In other words, it will use your currently checked out
+source tree to build with, ensure that file permissions remain consistent and
+clean up after itself.
 
-There are other modifications that can be made but this will run
-the `make` command inside the specified container. It will use your
-currently checked out source tree to build with, ensure that file
-permissions remain consistent and clean up after itself.
 
 Building a container
 --------------------
-- 
Anthony PERARD


_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/mailman/listinfo/xen-devel