Skip to content

Commit c064279

Browse files
authored
[SYCL][Doc] Reword Docker doc to reference Dockerfiles (#16539)
We will soon no longer provide pre-built Docker containers, so update the relevant doc to reference the Dockerfile instead. --------- Signed-off-by: Sarnie, Nick <nick.sarnie@intel.com>
1 parent b71b5ac commit c064279

File tree

3 files changed

+25
-29
lines changed

3 files changed

+25
-29
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ Project documentation is available at:
4646

4747
### How to use DPC++
4848

49-
#### Docker containers
49+
#### Dockerfiles
5050

51-
See available containers with pre-built/pre-installed DPC++ compiler at:
52-
[Containers](./sycl/doc/developer/DockerBKMs.md#sycl-containers-overview)
51+
See available Dockerfiles to create containers with pre-built/pre-installed DPC++ compiler at:
52+
[Containers](./sycl/doc/developer/DockerBKMs.md#sycl-dockerfiles-overview)
5353

5454
#### Releases
5555

sycl/doc/GetStartedGuide.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,10 @@ and a wide range of compute accelerators such as GPU and FPGA.
4949
* C++ compiler
5050
* See LLVM's [host compiler toolchain requirements](https://github.com/intel/llvm/blob/sycl/llvm/docs/GettingStarted.rst#host-c-toolchain-both-compiler-and-standard-library)
5151

52-
Alternatively, you can use a Docker image that has everything you need for
53-
building pre-installed:
52+
Alternatively, you can create a Docker image that has everything you need for
53+
building pre-installed using the [Ubuntu 24.04 build Dockerfile](https://github.com/intel/llvm/blob/sycl/devops/containers/ubuntu2404_build.Dockerfile).
5454

55-
```bash
56-
docker run --name sycl_build -it -v /local/workspace/dir/:/src ghcr.io/intel/llvm/ubuntu2204_build /bin/bash
57-
```
58-
59-
This command will start a terminal session, from which you can proceed with the
60-
instructions below. See [Docker BKMs](developer/DockerBKMs.md) for more info on
55+
See [Docker BKMs](developer/DockerBKMs.md) for more info on
6156
Docker commands.
6257

6358
### Create DPC++ workspace

sycl/doc/developer/DockerBKMs.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -32,48 +32,49 @@ container images. Unlike Docker, Podman runs without a daemon and allows you
3232
to run containers without root permissions. The command line syntax is mostly
3333
identical for Docker and Podman. Choose whatever is available on your system.
3434

35-
## SYCL Containers overview
35+
## SYCL Dockerfiles overview
3636

37-
The following containers are publicly available for DPC++ compiler development:
37+
The following Dockerfiles are publicly available for creating DPC++ compiler
38+
development containers:
3839

39-
### Ubuntu 22.04-based images
40+
### Ubuntu 22.04-based Dockerfiles
4041

41-
- `ghcr.io/intel/llvm/ubuntu2204_base`: contains basic environment
42+
- `devops/containers/ubuntu2204_base`: contains basic environment
4243
setup for building DPC++ compiler from source.
43-
- `ghcr.io/intel/llvm/ubuntu2204_intel_drivers`: contains everything from the
44-
base container + pre-installed Intel drivers.
45-
The image comes in two flavors/tags:
44+
- `devops/containers/ubuntu2204_intel_drivers`: contains everything from the
45+
base Dockerfile + pre-installed Intel drivers.
46+
The Dockerfile comes in two flavors/tags:
4647
* `latest`: Intel drivers are downloaded from release/tag and saved in
4748
dependencies.json. The drivers are tested/validated everytime we upgrade
4849
the driver.
4950
* `alldeps`: Includes the same Intel drivers as `latest`, as well as the
50-
development kits for NVidia/AMD from the `ubuntu2204_build` container.
51-
- `ghcr.io/intel/llvm/ubuntu2204_build`: has development kits installed for
51+
development kits for NVidia/AMD from the `ubuntu2204_build` Dockerfile.
52+
- `devops/containers/ubuntu2204_build`: has development kits installed for
5253
NVidia/AMD and can be used for building DPC++
5354
compiler from source with all backends enabled or for end-to-end testing
5455
with HIP/CUDA on machines with corresponding GPUs available.
55-
- `ghcr.io/intel/llvm/sycl_ubuntu2204_nightly`: contains the latest successfully
56-
built nightly build of DPC++ compiler. The image comes in three flavors:
56+
- `devops/containers/sycl_ubuntu2204_nightly`: contains the latest successfully
57+
built nightly build of DPC++ compiler. The Dockerfile comes in three flavors:
5758
with pre-installed Intel drivers (`latest`), without them (`no-drivers`) and
5859
with development kits installed (`build`).
5960

60-
### Ubuntu 24.04-based images
61+
### Ubuntu 24.04-based Dockerfiles
6162

62-
- `ghcr.io/intel/llvm/ubuntu2404_base`: contains basic environment
63+
- `devops/containers/ubuntu2404_base`: contains basic environment
6364
setup for building DPC++ compiler from source.
64-
- `ghcr.io/intel/llvm/ubuntu2404_intel_drivers`: contains everything from the
65-
base container + pre-installed Intel drivers.
66-
The image comes in four flavors/tags:
65+
- `devops/containers/ubuntu2404_intel_drivers`: contains everything from the
66+
base Dockerfile + pre-installed Intel drivers.
67+
The Dockerfile comes in four flavors/tags:
6768
* `latest`: Intel drivers are downloaded from release/tag and saved in
6869
dependencies.json. The drivers are tested/validated everytime we upgrade
6970
the driver.
7071
* `devigc`: Intel Graphics Compiler driver from github actions artifacts,
7172
other drivers are downloaded from release/tag and saved in dependencies.json.
7273
* `unstable`: Intel drivers are downloaded from release/latest.
7374
* `alldeps`: Includes the same Intel drivers as `latest`, as well as the
74-
development kits for NVidia/AMD from the `ubuntu2404_build` container.
75+
development kits for NVidia/AMD from the `ubuntu2404_build` Dockerfile.
7576
The drivers are installed as it is, not tested or validated.
76-
- `ghcr.io/intel/llvm/ubuntu2404_build`: has development kits installed for
77+
- `devops/containers/ubuntu2404_build`: has development kits installed for
7778
NVidia/AMD and can be used for building DPC++
7879
compiler from source with all backends enabled or for end-to-end testing
7980
with HIP/CUDA on machines with corresponding GPUs available.

0 commit comments

Comments
 (0)