mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-26 22:29:10 +00:00
5abf83f95d
* Update release number to 107.
Public Issues:
* Fix revision date for the `<<VK_AMD_gpu_shader_half_float>>` appendix
(public issue 617).
* Make <<synchronization-pipeline-barriers-subpass-self-dependencies,
subpass self-dependencies>> less restrictive (public issue 777).
* Fix the `<<VK_EXT_full_screen_exclusive>>` dependency on
`<<VK_KHR_win32_surface>>` in `vk.xml` (public pull request 849).
* Remove single-page (`apispec.html`) refpage sub-targets from the
Makefile `allman` target and the build instructions. The target is still
present in the Makefile, but we have not been actively maintaining the
single-page document and do not promise it will work. The full
Specification and the individual API reference pages are what we support
and publish at present (public issue 949).
Internal Issues:
* De-duplicate common valid usage statements shared by multiple commands
or structures by using asciidoctor includes and dynamically assigning
part of the valid usage ID based on which command or structure they're
being applied to (internal issue 779).
* Add reference pages for constructs not part of the formal API, such as
platform calling convention macros, and script changes supporting them
This required suppressing some check_spec_links warning classes in order
to pass CI, until a more sophisticated fix can be done (internal issue
888).
* Change math notation for the elink:VkPrimitiveTopology descriptions to
use short forms `v` and `p` instead of `vertex` and `primitive`,
increasing legibility (internal issue 1611).
* Rewrite generated file includes relative to a globally specified path,
fixing some issues with refpage generation (internal issue 1630).
* Update contributor list for `<<VK_EXT_calibrated_timestamps>>`.
* Fix use of pathlin in `scripts/generator.py` so the script will work on
Windows under Python 3.5 (internal merge request 3107).
* Add missing conditionals around the
<<descriptorsets-accelerationstructure, Acceleration Structure>>
section (internal merge request 3108).
* More script synchronization with OpenXR spec repository (internal merge
request 3109).
* Mark the `<<VK_AMD_gpu_shader_half_float>>` and
`<<VK_AMD_gpu_shader_int16>>` extensions as deprecated in `vk.xml` and
the corresponding extension appendices (internal merge request 3112).
New Extensions:
* `<<VK_EXT_headless_surface>>`
97 lines
3.5 KiB
YAML
97 lines
3.5 KiB
YAML
# Gitlab CI file for vulkan spec and header generation
|
|
|
|
# Build the vulkan specification and generate any associated files (such as vulkan.h)
|
|
spec-generate:
|
|
stage: build
|
|
before_script:
|
|
- apt-get update -qq
|
|
- apt-get install -y -qq gcc git python3 python3-termcolor python3-pytest ruby jing
|
|
- apt-get install -y -qq cmake bison flex libffi-dev libxml2-dev libgdk-pixbuf2.0-dev libcairo2-dev libpango1.0-dev ttf-lyx
|
|
# Force-install an older version of i18n so the 1.5.2 version, which
|
|
# won't work with ruby 2.1, doesn't abort the CI job when installing
|
|
# other gems which need it.
|
|
- gem install i18n -v 1.5.1
|
|
- gem install asciidoctor asciidoctor-mathematical coderay json-schema
|
|
script:
|
|
# Internal self-test of the check_spec_links script
|
|
- ( cd scripts && py.test-3 test*.py )
|
|
- mkdir -p out/checks
|
|
- scripts/check_spec_links.py --html=out/checks/problems.html > /dev/null || true
|
|
# Breaking the build if # of errors increases. We should manually ratchet ignore_count down as errors get fixed.
|
|
# If there are unfixable errors, add '--ignore_count #' where '#' is the
|
|
# number of them. This is a slightly crude way of enforcing "don't add
|
|
# errors" but simpler than the alternatives (running against master,
|
|
# diff, etc)
|
|
- scripts/check_spec_links.py -Werror --ignore_count 0 -Wno_refpage_missing_desc -Wno_refpage_xrefs -Wno_refpage_name -Wno_refpage_unknown_attrib
|
|
# Build the actual spec
|
|
- ./makeAllExts QUIET= -j${nproc} -Otarget validusage html styleguide registry manhtmlpages
|
|
# Build headers, for use by all later stages
|
|
- ( cd xml && make validate test install )
|
|
artifacts:
|
|
when: always
|
|
paths:
|
|
- include/
|
|
- src/
|
|
- out/
|
|
expire_in: 1 month
|
|
|
|
# Generate the vulkan C++ header (vulkan.hpp)
|
|
hpp-generate:
|
|
stage: build
|
|
image: ubuntu:16.04
|
|
before_script:
|
|
- SPEC_DIR="${PWD}"
|
|
- apt-get update -qq
|
|
- apt-get install -y -qq cmake git g++
|
|
- cd /tmp
|
|
- rm -rf Vulkan-Hpp
|
|
- git clone https://github.com/KhronosGroup/Vulkan-Hpp.git
|
|
- cd Vulkan-Hpp
|
|
- git submodule update --init --recursive -- tinyxml2
|
|
- rm -rf Vulkan-Docs
|
|
- cp -r "${SPEC_DIR}" Vulkan-Docs
|
|
# Copy Vulkan C headers into subdir copy used by Vulkan-Hpp
|
|
- cp -p ${SPEC_DIR}/include/vulkan/*.h Vulkan-Docs/include/vulkan/
|
|
script:
|
|
- cd /tmp/Vulkan-Hpp
|
|
- cmake -H. -Bbuild
|
|
- make -C build
|
|
- cd build
|
|
- ./VulkanHppGenerator
|
|
after_script:
|
|
- mkdir -p Vulkan-Hpp/vulkan/
|
|
- cp /tmp/Vulkan-Hpp/vulkan/vulkan.hpp Vulkan-Hpp/vulkan/
|
|
artifacts:
|
|
paths:
|
|
- Vulkan-Hpp/vulkan/
|
|
expire_in: 1 month
|
|
allow_failure: true
|
|
|
|
# Compile a simple test program that uses vulkan.h
|
|
# The fake platform headers in tests/ allow compiling with all Vulkan
|
|
# platforms at once.
|
|
h-compile:
|
|
stage: test
|
|
dependencies:
|
|
- spec-generate
|
|
before_script:
|
|
- apt-get update -qq
|
|
- apt-get install -y -qq gcc clang
|
|
script:
|
|
- gcc -c -std=c11 -Iinclude -Itests -Wall -Wextra -Werror tests/htest.c
|
|
- clang -c -std=c11 -Iinclude -Itests -Wall -Wextra -Werror tests/htest.c
|
|
|
|
# Compile a simple test program that uses vulkan.hpp
|
|
hpp-compile:
|
|
stage: test
|
|
dependencies:
|
|
- spec-generate
|
|
- hpp-generate
|
|
before_script:
|
|
- apt-get update -qq
|
|
- apt-get install -y -qq g++ clang
|
|
script:
|
|
- g++ -c -std=c++11 -Iinclude -IVulkan-Hpp -Wall -Wextra -Werror tests/hpptest.cpp
|
|
- clang++ -c -std=c++11 -Iinclude -IVulkan-Hpp -Wall -Wextra -Werror tests/hpptest.cpp
|
|
allow_failure: true
|