Fix Makefile PATCHVERSION to 72, and finish cleaning up after the
dirtree reorganization, changing paths in build scripts and other spec-adjacent material.
This commit is contained in:
parent
26f0bdbf1e
commit
e1c0e426f3
2
Makefile
2
Makefile
|
@ -106,7 +106,7 @@ VERBOSE =
|
|||
# $(EXTENSIONS))
|
||||
# ADOCOPTS options for asciidoc->HTML5 output
|
||||
NOTEOPTS = -a editing-notes -a implementation-guide
|
||||
PATCHVERSION = 71
|
||||
PATCHVERSION = 72
|
||||
ifneq (,$(findstring VK_VERSION_1_1,$(VERSIONS)))
|
||||
SPECREVISION = 1.1.$(PATCHVERSION)
|
||||
else
|
||||
|
|
|
@ -14,12 +14,11 @@
|
|||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
# Build Promoter submission package for a specified extension or extensions
|
||||
# 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 doc/specs/vulkan/config, but is executed from the
|
||||
# parent directory.
|
||||
# This script lives in config/, but is executed from the parent directory.
|
||||
#
|
||||
# Usage: makeSubmit extension targets
|
||||
|
||||
|
|
|
@ -48,7 +48,7 @@ if __name__ == '__main__':
|
|||
if args.internal:
|
||||
# For internal build & pseudo-release
|
||||
repoDir = '/home/tree/git/vulkan'
|
||||
outDir = '/home/tree/git/vulkan/doc/specs/vulkan/out'
|
||||
outDir = '/home/tree/git/vulkan/out'
|
||||
else:
|
||||
# For public release
|
||||
repoDir = '/home/tree/git/Vulkan-Docs'
|
||||
|
|
11
genspec.py
11
genspec.py
|
@ -43,9 +43,9 @@ def buildOnFriday():
|
|||
# outdir = directory to generate specs in
|
||||
# apititle = extra title to apply to the specification
|
||||
# xmlDir = directory containing registry XML
|
||||
# xmlTargets = targets to build in src/spec/
|
||||
# xmlTargets = targets to build in xml/
|
||||
# specDir = directory containing spec source & Makefile
|
||||
# specTargets = targets to build in doc/specs/vulkan/
|
||||
# specTargets = targets to build
|
||||
# miscSrc = path to copy misc files from, if non-None
|
||||
# miscDst = path to copy misc files to, if non-None
|
||||
# needRefSources = True if ref pages must be extracted from the spec sources
|
||||
|
@ -124,9 +124,9 @@ def buildBranch(targetDir,
|
|||
needRefSources = False):
|
||||
|
||||
# Directory with vk.xml and generation tools
|
||||
xmlDir = repoDir + '/src/spec'
|
||||
xmlDir = repoDir + '/xml'
|
||||
# Directory with spec sources
|
||||
specDir = repoDir + '/doc/specs/vulkan'
|
||||
specDir = repoDir
|
||||
# Directory containing misc. files to copy to registry.
|
||||
# At present there are none, since GLSL extensions have moved to the
|
||||
# GLSL repository and are redirected from the Vulkan registy website.
|
||||
|
@ -154,6 +154,3 @@ def createTags(releaseNum, tagdate):
|
|||
print('echo To tag the spec branch for this release, execute the command:')
|
||||
print('echo git tag -a -m \\"Tag Vulkan API specification for 1.1.' +
|
||||
releaseNum, 'release\\"', 'v1.1.' + releaseNum)
|
||||
#print('echo git tag -a -m \\"Tag Vulkan API specification for', now,
|
||||
# 'release\\"', 'v1.1-core-' + now)
|
||||
|
||||
|
|
|
@ -171,7 +171,7 @@ if __name__ == '__main__':
|
|||
# If no files are specified, promote the entire specification chapters folder
|
||||
if len(args.files) == 0:
|
||||
folder_to_promote = os.getcwd()
|
||||
folder_to_promote += '/doc/specs/vulkan'
|
||||
folder_to_promote += '/chapters'
|
||||
promoteAllAdocFiles(folder_to_promote, args)
|
||||
else:
|
||||
for file in args.files:
|
||||
|
|
|
@ -660,7 +660,7 @@ if __name__ == '__main__':
|
|||
# If no files are specified, reflow the entire specification chapters folder
|
||||
if len(args.files) == 0:
|
||||
folder_to_reflow = os.getcwd()
|
||||
# folder_to_reflow += '/doc/specs/vulkan'
|
||||
# folder_to_reflow += '/chapters'
|
||||
reflowAllAdocFiles(folder_to_reflow, args)
|
||||
else:
|
||||
for file in args.files:
|
||||
|
|
|
@ -214,7 +214,7 @@ section above.
|
|||
|
||||
The canonical definition of the Vulkan APIs is kept in an XML file known as
|
||||
the *Vulkan registry*.
|
||||
The registry is kept in `src/spec/vk.xml` in the `master` branch of the
|
||||
The registry is kept in `xml/vk.xml` in the `master` branch of the
|
||||
<<vulkan-docs,KhronosGroup/Vulkan-Docs>> project, containing the most
|
||||
recently released Vulkan API specification.
|
||||
The registry contains reserved author IDs, core and extension interface
|
||||
|
@ -424,8 +424,7 @@ Changes for extensions include (but may not be limited to) the following:
|
|||
|
||||
* All extensions must add an appendix to the Vulkan specification.
|
||||
The appendix should be modeled after the `VK_KHR_shader_draw_parameters`
|
||||
extension in
|
||||
`doc/specs/vulkan/appendices/VK_KHR_shader_draw_parameters.txt`, which
|
||||
extension in `appendices/VK_KHR_shader_draw_parameters.txt`, which
|
||||
contains metainformation about the extension (as well as code examples,
|
||||
and revision history).
|
||||
This example is complicated because `VK_KHR_shader_draw_parameters` has
|
||||
|
@ -451,7 +450,7 @@ Changes for extensions include (but may not be limited to) the following:
|
|||
** *Contributors* - Names and corporate affiliations of people who have
|
||||
made significant direct contributions to this extension.
|
||||
* Each extension's appendix file is included by adding an `include`
|
||||
statement to the `doc/specs/vulkan/appendices/extensions.txt` file.
|
||||
statement to the `appendices/extensions.txt` file.
|
||||
The `include` statement must be protected by appropriate asciidoc
|
||||
conditionals.
|
||||
The new file is grouped alphabetically by name, in a section of
|
||||
|
|
|
@ -354,7 +354,7 @@ image::images/imagename.svg[align="center",title="Figure caption",{fullimagewidt
|
|||
There must be both .svg and .pdf versions of each figure checked into the
|
||||
+images/+ directory, to support generating both HTML and PDF outputs.
|
||||
It is best to create images in Inkscape as SVG files and then use the
|
||||
conversion rule in `doc/specs/vulkan/images/Makefile` to generate PDF.
|
||||
conversion rule in `images/Makefile` to generate PDF.
|
||||
|
||||
Asciidoc restricts captions in figures to be a single line in the source
|
||||
document.
|
||||
|
@ -508,7 +508,7 @@ Only use the fname{cl}, sname{cl}, tname{cl}, and dname{cl} macros if no
|
|||
definition of the target type with a corresponding anchor exists in the
|
||||
document.
|
||||
Anchors are automatically defined when including the generated API interface
|
||||
definitions under `doc/specs/vulkan/api/.../*txt`.
|
||||
definitions under `api/.../*txt`.
|
||||
If an anchor does exist, use the corresponding *link{cl} macro.
|
||||
|
||||
[NOTE]
|
||||
|
|
|
@ -58,7 +58,7 @@ For implicit valid usage statements generated automatically from `vk.xml`,
|
|||
VUID tags are created automatically by the generator scripts.
|
||||
|
||||
For explicit valid usage statements, VUID tags are generated by passing
|
||||
appropriate options to the script `doc/specs/vulkan/reflow.py`.
|
||||
appropriate options to the script `reflow.py`.
|
||||
|
||||
Since these tags are of use only to the published validation layer, they are
|
||||
needed only in the published Specification sources and outputs.
|
||||
|
@ -71,7 +71,7 @@ For reference purposes, this process is described below:
|
|||
|
||||
First, after integrating all new specification language into the internal
|
||||
gitlab branch which contains the canonical Specification source, invoke the
|
||||
following command in `doc/specs/vulkan`:
|
||||
following command:
|
||||
|
||||
[source,sh]
|
||||
----
|
||||
|
|
|
@ -2,5 +2,5 @@
|
|||
# AsciiDoctor files. If a valid usage entry already contains
|
||||
# an ID, it skips that entry. If it does not contain an ID,
|
||||
# it will generate a new one.
|
||||
./doc/specs/vulkan/reflow.py -overwrite -noflow -tagvu
|
||||
python3 reflow.py -overwrite -noflow -tagvu
|
||||
|
||||
|
|
|
@ -17,9 +17,9 @@
|
|||
# extDependency - generate a mapping of extension name -> all required
|
||||
# extension names for that extension.
|
||||
#
|
||||
# This updates doc/specs/vulkan/config/extDependency.sh from the spec Makefile.
|
||||
# This updates config/extDependency.sh from the spec Makefile.
|
||||
# It also defines lists of KHR extensions and all extensions for use in
|
||||
# make frontend scripts in doc/specs/vulkan.
|
||||
# make frontend scripts such as 'makeAllExts'.
|
||||
|
||||
import argparse
|
||||
import xml.etree.ElementTree as etree
|
||||
|
@ -172,7 +172,7 @@ if __name__ == '__main__':
|
|||
fp = open(args.outscript, 'w', encoding='utf-8')
|
||||
|
||||
print('#!/bin/bash', file=fp)
|
||||
print('# Generated from src/spec/extDependency.py', file=fp)
|
||||
print('# Generated from xml/extDependency.py', file=fp)
|
||||
print('# Specify maps of all extensions required by an enabled extension', file=fp)
|
||||
print('', file=fp)
|
||||
print('declare -A extensions', file=fp)
|
||||
|
@ -198,7 +198,7 @@ if __name__ == '__main__':
|
|||
fp = open(args.outpy, 'w', encoding='utf-8')
|
||||
|
||||
print('#!/usr/bin/env python', file=fp)
|
||||
print('# Generated from src/spec/extDependency.py', file=fp)
|
||||
print('# Generated from xml/extDependency.py', file=fp)
|
||||
print('# Specify maps of all extensions required by an enabled extension', file=fp)
|
||||
print('', file=fp)
|
||||
print('extensions = {}', file=fp)
|
||||
|
|
Loading…
Reference in New Issue