Vulkan-Docs/config/makeSubmit.py
Jon Leech 911a764694 Change log for October 7, 2018 Vulkan 1.1.87 spec update:
* Update release number to 87.

Public Issues:

  * Merge flink:vkCmdPipelineBarrier self-dependency barrier VUs referring
    to the same subpass dependency (public pull request 756).
  * Describe default value of `"optional"` attribute in the registry schema
    document (public issue 769)
  * Fix links in <<VK_NVX_raytracing>> extension (public pull request 805).
  * Mark the <<VK_KHR_mir_surface>> extension obsolete (see public issue 814
    - does not close this, however).
  * Fix missing endif in Image Creation block (public issue 817).

Internal Issues:

  * Clarify that the compressed texture formats corresponding to
    <<features-features-textureCompressionETC2>>,
    <<features-features-textureCompressionASTC_LDR>>, and
    <<features-features-textureCompressionBC>> is not contingent on the
    feature bits, and may be supported even if the features are not enabled
    (internal issue 663).
  * Clarify that code:FragStencilRefEXT is output only in the
    <<interfaces-builtin-variables, Built-In Variables>> section (internal
    issue 1173).
  * Identify and correct many overly-aggressive uses of "`undefined`", and
    narrow them down, where straightforward to do so. Mark such resolved
    uses of "`undefined`" with the custom undefined: macro. Add a new
    <<writing-undefined, Describing Undefined Behavior>> section (internal
    issue 1267).
  * Don't require code:inline_uniform_block descriptors to be populated
    before use in the flink:vkAllocateDescriptorSets section (internal issue
    1380).
  * Allow suppressing inline SVG images by controlling this with an
    attribute set in the Makefile, rather than the explicit [%inline]
    directive (internal issue 1391).
  * Mark 'Khronos' as a registered trademark in several places, now that it
    is one.
  * Fix typo in the <<VK_KHR_shader_atomic_int64>> appendix using the GLSL
    naming of the compare exchange op when referring to the SPIR-V op.
  * Specify in the flink:vkGetPhysicalDeviceQueueFamilyProperties section
    that all implementations must support at least one queue family, and
    that every queue family must contain at least one queue.
  * Make slink:VkPipelineDynamicStateCreateInfo::pname:dynamicStateCount,
    slink:VkSampleLocationsInfoEXT::pname:sampleLocationsPerPixel, and
    slink:VkSampleLocationsInfoEXT::pname:sampleLocationsCount optional, to
    fix bogus implicit valid usage checks that were causing failures in the
    conformance tests.
  * Fix vendor tag in reserved extension 237 constants. Does not affect
    anything since it's just a placeholder, but this should avoid further
    comments.
  * Minor markup fixes in some extension appendices.

New Extensions:

  * `<<VK_FUCHSIA_imagepipe_surface>>`
2018-10-07 06:10:21 -07:00

107 lines
3.7 KiB
Python
Executable File

#!/usr/bin/env python3
#
# Copyright (c) 2016-2018 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.
# Build Promoter submission package for a specified extension or extensions.
# This consists of one spec with the extension(s) and all dependencies,
# one with just the dependencies, and an htmldiff of them.
#
# This script lives in config/, but is executed from the parent directory.
#
# Usage: makeSubmit extension targets
import argparse, copy, io, os, pdb, re, string, subprocess, sys
# Ensure config/extDependency.py is up-to-date before we import it.
subprocess.check_call(['make', 'config/extDependency.py'])
from extDependency import *
def enQuote(str):
return '"' + str + '"'
# Make a single submission target. Several are needed per document.
#
# outDir - where to generate intermediate and final documents
# extensionList - list of extensions to include
# submitName - base name of final HTML file
# title - document title
# target - default 'html'
def makeTarget(outDir, extensionList, submitName, title, target):
print('make clean_generated')
print('make OUTDIR=' + outDir,
'IMAGEOPTS=',
'EXTENSIONS="' + ' '.join(extensionList) + '"',
'APITITLE="' + title + '"', target)
# Rename into submission directory
outFile = outDir + '/html/' + submitName + '.html'
print('mv', outDir + '/html/vkspec.html', enQuote(outFile))
# No longer needed
# print('mv -n', outDir + '/katex', 'out/submit/')
return outFile
# Make submission for a list of required extension names
def makeSubmit(submitName, required, target='html'):
global extensions
deps = []
for name in required:
if name in extensions.keys():
for depname in extensions[name]:
if (depname not in required and depname not in deps):
deps.append(depname)
print('echo Required extensions:', ' '.join(required))
print('echo Dependent extensions:', ' '.join(deps))
print('')
# Generate shell commands to build the specs
outDir = 'submit'
print('mkdir -p', outDir)
# Generate spec with required extensions + dependencies
newSpec = makeTarget(outDir, required + deps, submitName,
submitName, target)
# Generate base spec with just dependencies
baseSpec = makeTarget(outDir, deps, 'deps-' + submitName,
'(with only dependencies of ' + submitName + ')',
target)
# # Reorganize and rename them, and generate the diff spec
print('')
print('cd scripts')
print('./htmldiff',
enQuote('../' + baseSpec),
enQuote('../' + newSpec),
'>',
enQuote('../submit/html/diff-' + submitName + '.html'))
print('cd ..')
if __name__ == '__main__':
parser = argparse.ArgumentParser()
parser.add_argument('-title', action='store',
default='vkspec',
help='Set the document title')
parser.add_argument('-extension', action='append',
default=[],
help='Specify a required extension or extensions to add to targets')
results = parser.parse_args()
makeSubmit(results.title, results.extension)