Vulkan-Docs/xml/Makefile
Jon Leech 476e3f422d Change log for March 18, 2019 Vulkan 1.1.104 spec update:
* Update release number to 104.

Public Issues:

  * Remove the incorrect line from "`Initial`" to "`Invalid`" state in the
    <<commandbuffer-lifecycle-diagram, Lifecycle of a command buffer>>
    diagram (public issue 881).
  * Add Fuchsia platform to <<boilerplate-wsi-header-table, Window System
    Extensions and Headers>> table (public pull request 933).
  * Change the type of
    slink:VkBufferDeviceAddressCreateInfoEXT::pname:deviceAddress from
    basetype:VkDeviceSize to basetype:VkDeviceAddress. These are both
    typedefs of code:uint64_t, so it is an ABI-compatible change (public
    issue 934).

Internal Issues:

  * Remove generated header files and update the CI tests to build a copy of
    the headers for use by the hpp-generate / hpp-compile CI stages. Targets
    to generate the headers will not be removed, but keeping these generated
    files in the repository increased the frequency of conflicts between
    branches when merging to master (internal issue 745).
  * Reword "`undefined: behavior if *action*" to "`must: not do *action*`"
    in the places the old terminology was used, and add a new
    <<writing-undefined, Describing Undefined Behavior>> section of the
    style guide to explain how to write such language in the future
    (internal issue 1579).
  * Move almost all Python scripts into the toplevel `scripts/` directory.
    Apply extensive internal edits to clean up and simplify the scripts, and
    try to follow PEP8 guidelines. Generalize the scripts with the use of a
    Conventions object controlling many aspects of output generation, to
    enable their use in other Khronos projects with similar requirements.
    Autogenerate extension interface refpages (these are experimental and
    may be retired going forward).

New Extensions:

  * `VK_AMD_display_native_hdr`
  * `VK_EXT_full_screen_exclusive` (internal issue 1439)
  * `VK_EXT_host_query_reset`
  * `VK_EXT_pipeline_creation_feedback` (internal issue 1560)
  * `VK_KHR_surface_protected_capabilities` (internal issue 1520)
2019-03-17 06:05:46 -07:00

102 lines
3.1 KiB
Makefile

# Copyright (c) 2013-2019 The Khronos Group Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# If a recipe fails, delete its target file. Without this cleanup, the leftover
# file from the failed recipe can falsely satisfy dependencies on subsequent
# runs of `make`.
.DELETE_ON_ERROR:
# Generator scripts and options
# GENOPTS can be e.g. '-noprotect'
PYTHON ?= python3
SCRIPTS = ../scripts
GENOPTS =
# Generate Vulkan header from XML. Many other files can be generated
# from vk.xml using the scripts, but they are all generated in ../ as
# part of the process of building the Specification.
#
# Targets:
#
# default / install - regenerate headers in ../include/vulkan/.
# validate - run XML validator on vk.xml against the schema.
# test - check if vulkan_core.h compiles.
# clean_dirt - remove intermediate files.
# clean - remove installed and intermediate files.
INCLUDE = ../include
VULKAN = $(INCLUDE)/vulkan
SRC = ../src
# Vulkan platform-specific headers
PLATFORM_HEADERS = \
$(VULKAN)/vulkan_android.h \
$(VULKAN)/vulkan_fuchsia.h \
$(VULKAN)/vulkan_ios.h \
$(VULKAN)/vulkan_macos.h \
$(VULKAN)/vulkan_vi.h \
$(VULKAN)/vulkan_wayland.h \
$(VULKAN)/vulkan_win32.h \
$(VULKAN)/vulkan_xcb.h \
$(VULKAN)/vulkan_xlib.h \
$(VULKAN)/vulkan_xlib_xrandr.h \
$(VULKAN)/vulkan_metal.h
HEADERS = $(VULKAN)/vulkan_core.h $(PLATFORM_HEADERS)
default install: $(HEADERS)
################################################
# Autogenerate vulkan header from XML API description
# Python and XML files on which vulkan_core.h depends
GENSCRIPT = $(SCRIPTS)/genvk.py
VKH_DEPENDS = vk.xml $(GENSCRIPT) $(SCRIPTS)/reg.py $(SCRIPTS)/generator.py
$(HEADERS): $(VKH_DEPENDS)
$(PYTHON) $(GENSCRIPT) -registry vk.xml -o $(VULKAN) $(notdir $@)
platform: $(PLATFORM_HEADERS)
# Verify registry XML file against the schema
validate:
jing -c registry.rnc vk.xml
# Test that vulkan_core.h compiles
# Platforms to test
TESTDEFS = -DVK_USE_PLATFORM_XCB_KHR -DVK_USE_PLATFORM_XLIB_KHR
test: $(HEADERS) $(VULKAN)/vulkan.h $(VULKAN)/vk_platform.h
gcc -Wall -pedantic -std=c99 -c -I$(INCLUDE) test.c
g++ -Wall -c -std=c++98 -I$(INCLUDE) test.c
g++ -Wall -c -std=c++11 -I$(INCLUDE) test.c
gcc $(TESTDEFS) -Wall -pedantic -std=c99 -c -I$(INCLUDE) test.c
rm test.o
################################################
# Files to clean up
PYDIRT = diag.txt dumpReg.txt errwarn.txt *.pyc regdump.txt
DIRT = $(PYDIRT) ERRS \#*
# Clean intermediate files
clean_dirt:
-rm -f $(DIRT)
# Clean generated targets as well as intermediates.
clean clobber: clean_dirt
-rm -f $(HEADERS) $(PLATFORM_HEADERS)