Skip to content

Document Docker build #1572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EwanC wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document Docker build #1572

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,17 @@ We intend to maintain a linear history on the GitHub `main` branch.
[[building]]
== Building The Specifications and Reference Pages

If you have installed all <<depends,required toolchain components>>, you
should be able to build both HTML and PDF outputs for all specifications by:
After cloning the repository you should install all of the <<depends,required toolchain components>>.
The recommended way to do this is by using the Khronos provided Docker image
`khronosgroup/docker-images:asciidoctor-spec` from DockerHub.
The Dockerfile specifying this image can be found at
https://github.com/KhronosGroup/DockerContainers[KhronosGroup/DockerContainers]
if you need to build a modified or layered image. Due to local and CI caching problems when this image
is updated on dockerhub, the OpenCL-Docs CI uses the SHA256 of the latest image update,
rather than the image name.

Once you have installed all the dependencies you should be able to build both HTML
and PDF outputs for all specifications by:

$ make

Expand Down