Skip to content

Commit 4d51f00

Browse files
authored
Merge pull request #54 from xcp-ng/gln/doc-image-build-uosq
2 parents 102f2fa + b85b759 commit 4d51f00

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ or `pipx:`
3636
pipx install git+https://github.com/xcp-ng/xcp-ng-build-env
3737
```
3838

39-
After this, two new commands will be available: `xcp-ng-dev-env-create` and
40-
`xcp-ng-dev`.
39+
After this, a new command will be available: `xcp-ng-dev`.
4140

4241
If you want to develop the package and try the changes as you develop
4342
the package, or prefer updating the version from a git repo rather
@@ -63,6 +62,8 @@ Depending on how you installed:
6362
* with `pipx`: run the same command, with `--force`
6463
* editable with `git`: just update your git working tree
6564

65+
Then download the latest image with `docker pull ghcr.io/xcp-ng/xcp-ng-build-env:8.3` or `podman pull ghcr.io/xcp-ng/xcp-ng-build-env:8.3`.
66+
6667
## Completion
6768

6869
### Bash
@@ -79,15 +80,19 @@ To install the completion, run `register-python-argcomplete --shell fish xcp-ng-
7980

8081
## Building the container image(s)
8182

83+
> [!NOTE]
84+
> The images are typically downloaded from ghcr.io for regular usage.
85+
> Unless you're working on this project, you usually don't need to build the container images yourself.
86+
8287
You need one container image per target version of XCP-ng.
8388

84-
Clone this repository (outside any container), then use `xcp-ng-dev-env-create` to
85-
generate the images for the wanted releases of XCP-ng.
89+
Clone this repository (outside any container), then use `./container/build.sh` to
90+
generate the image. Adapt the version to the wanted release of XCP-ng.
8691
Note that Docker and Podman store container images separately.
8792

8893
```
89-
Usage: xcp-ng-dev-env-create {version_of_XCP_ng}
90-
... where {version_of_XCP_ng} is a 'x.y' version such as 8.0.
94+
Usage: ./container/build.sh [--platform PF] <version>
95+
... where <version> is a 'x.y' version such as 8.0.
9196
```
9297

9398
## Using the container

container/build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22
set -e
33

4-
SELF_NAME="xcp-ng-dev-env-create"
4+
SELF_NAME=$0
55

66
die() {
77
echo >&2

0 commit comments

Comments
 (0)