Update to keep number attribute for now, but note it is deprecated

KhronosGroup · May 22, 2024 · 821f882 · 821f882
2 parents 0ee1ff9 + ce03761
commit 821f882
Show file tree

Hide file tree

Showing 196 changed files with 2,645 additions and 8,314 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -25,7 +25,7 @@ jobs:
     container: khronosgroup/docker-images@sha256:42123ba13792c4e809d037b69152c2230ad97fbf43b677338075ab9c928ab6ed
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: REUSE license checker
         run: reuse lint
 
@@ -35,7 +35,7 @@ jobs:
     container: khronosgroup/docker-images@sha256:42123ba13792c4e809d037b69152c2230ad97fbf43b677338075ab9c928ab6ed
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Internal self-test of the check_spec_links script
         run: py.test-3 test*.py
         working-directory: scripts
@@ -51,7 +51,7 @@ jobs:
     container: khronosgroup/docker-images@sha256:42123ba13792c4e809d037b69152c2230ad97fbf43b677338075ab9c928ab6ed
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: ./makeSpec -clean -spec core -genpath gencore QUIET= -j${nproc} -Otarget chunked html
 
   spec-generate:
@@ -60,7 +60,7 @@ jobs:
     container: khronosgroup/docker-images@sha256:42123ba13792c4e809d037b69152c2230ad97fbf43b677338075ab9c928ab6ed
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Build the actual spec (both chunked and single-page HTML), and other common targets
         run: ./makeSpec -clean -spec all QUIET= -j${nproc} -Otarget manhtmlpages validusage styleguide registry chunked html
       - name: Check consistency of internal xrefs and anchors in the output, now that an HTML output is available
@@ -75,7 +75,7 @@ jobs:
         # just one large file:
         run: tar -cvf spec-outputs.tar gen/
       - name: Archive generated spec
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: spec-outputs
           path: spec-outputs.tar
@@ -87,11 +87,11 @@ jobs:
     continue-on-error: true
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       # Generate the vulkan C++ header (vulkan.hpp)
       # Failure (should be) allowed, for now
       - name: Download generated spec
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: spec-outputs
       - name: Unpack generated spec
@@ -120,7 +120,7 @@ jobs:
           ./VulkanHppGenerator -f "${SPEC_DIR}"/xml/vk.xml
           cp /tmp/Vulkan-Hpp/vulkan/*.hpp ${SPEC_DIR}/gen/include/vulkan/
       - name: Upload generated hpp
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: hpp-outputs
           path: gen/include/
@@ -135,12 +135,12 @@ jobs:
       CARGO_TARGET_DIR: ${{ github.workspace }}/ash-target
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
         with:
           repository: ash-rs/ash
           path: ash
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/bin/
@@ -152,7 +152,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-cargo-ash-generator-
       - name: Download generated spec
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: spec-outputs
       - name: Unpack generated spec
@@ -175,7 +175,7 @@ jobs:
         # https://github.com/actions/upload-artifact#limitations, see above
         run: tar -cvf ash-outputs.tar ash/
       - name: Upload generated ash
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ash-outputs
           path: ash-outputs.tar
@@ -189,7 +189,7 @@ jobs:
     continue-on-error: true
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Sparse/shallow clone of CTS GitHub repository to pull only relevant parts
         run: |
           git clone --sparse --depth 1 --single-branch --branch main https://github.com/KhronosGroup/VK-GL-CTS.git
@@ -199,7 +199,7 @@ jobs:
           # Link the spec project into CTS hierarchy, instead of cloning it
           mkdir external/vulkan-docs
           ln -s `cd .. ; pwd` external/vulkan-docs/src
-      - name: Run the Vulkan-specific tests (from scripts/check_build_sanity.py)
+      - name: Run the Vulkan-specific tests (from scripts/check_build_sanity.py) # codespell:allow sanity
         run: |
           cd VK-GL-CTS
           python3 external/vulkancts/scripts/gen_framework.py
@@ -213,9 +213,9 @@ jobs:
     needs: spec-generate
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Download generated files
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: spec-outputs
       - name: Unpack generated spec
@@ -234,15 +234,15 @@ jobs:
     continue-on-error: true
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Download generated spec
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: spec-outputs
       - name: Unpack generated spec
         run: tar -xvf spec-outputs.tar
       - name: Download generated hpp
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: hpp-outputs
           path: gen/include/
@@ -261,12 +261,12 @@ jobs:
 
     steps:
       - name: Download generated files
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: ash-outputs
       - name: Unpack generated Ash crate
         run: tar -xvf ash-outputs.tar
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/bin/

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -195,7 +195,7 @@ cts-framework-tests:
     # Link the spec project into CTS hierarchy, instead of cloning it
     - mkdir external/vulkan-docs
     - ln -s `cd .. ; pwd` external/vulkan-docs/src
-    # Run the Vulkan-specific tests (from scripts/check_build_sanity.py)
+    # Run the Vulkan-specific tests (from scripts/check_build_sanity.py) # codespell:allow sanity
     - python3 external/vulkancts/scripts/gen_framework.py
     - python3 external/vulkancts/scripts/gen_framework_c.py
     - python3 external/vulkancts/scripts/gen_framework.py --api SC

diff --git a/BUILD.adoc b/BUILD.adoc
@@ -30,11 +30,14 @@ The repository is located at https://github.com/KhronosGroup/Vulkan-Docs/.
 Next, install all the necessary build tools (see <<depends,Software
 Dependencies>> below).
 If you are using the <<depends-docker, Khronos-Provided Docker Image>>,
-which we strongly recommend, one way to build using the image (assuming a
-Linux docker host) is:
+which we strongly recommend, two ways to build using the image are:
 
+    $ # assuming a Linux docker host
     $ scripts/runDocker
 
+    $ # assuming a Linux podman host
+    $ scripts/runPodman
+
 executed from the specification repository root.
 
 `runDocker` runs the Docker image with the cloned repository mounted under
@@ -50,7 +53,7 @@ to build an HTML5 specification output for the core Vulkan 1.3
 specification, with no extensions included, or
 
     $ cd /vulkan
-    $ ./makeSpec -spec all all
+    $ ./makeSpec -spec all alldocs allchecks
 
 to build the spec targets `html`, `pdf`, `styleguide`, `registry`,
 `manhtmlpages`, and `allchecks`, with *all* registered extensions included.
@@ -410,6 +413,10 @@ Docker installation is beyond the scope of this document.
 Refer to link:https://docs.docker.com/get-docker/[the Docker website] for
 information about installing Docker on Linux, Windows, and MacOS X.
 
+Another way to execute the Docker image is using the open source podman
+container tool. See link:https://podman.io/get-started[the Podman website]
+for information about installing podman on Linux, Windows, and MacOS X.
+
 The build image is *named* `khronosgroup/docker-images:asciidoctor-spec`.
 However, due to local and CI caching problems when this image is updated on
 dockerhub, we use the SHA256 of the latest image update, rather than the
@@ -422,9 +429,10 @@ which will print a line like
     image: khronosgroup/docker-images@sha256:42123ba13792c4e809d037b69152c2230ad97fbf43b677338075ab9c928ab6ed
 
 Everything following `image: ` is the <imagename> to use. The first time you
-try to run Docker with this <imagename>, as is done by the `runDocker`
-script described above under <<building, Building the Spec>>, the image will
-be pulled from Dockerhub and cached locally on your machine.
+try to run a container with this <imagename>, as is done by the `runDocker`
+and `runPodman` scripts described above under <<building, Building the
+Spec>>, the image will be pulled from Dockerhub and cached locally on your
+machine.
 
 This image is used to build Specification output documents or other Makefile
 targets.
@@ -473,7 +481,7 @@ toolchain yourself.
 [[building-epub-outputs]]
 === Building EPUB Outputs
 
-The `epub` target will generate an EPUB file in in
+The `epub` target will generate an EPUB file in
 `$(OUTDIR)/epub/vkspec.epub`. Note that the `epub` target is
 community-contributed, and not supported by Khronos. See
 https://github.com/KhronosGroup/Vulkan-Docs/pull/2286 for more.