Skip to content

Commit

Permalink
Minor build rule tweaks for new paths, and update anchors here and th…
Browse files Browse the repository at this point in the history
…ere to make antora outputs complain less
  • Loading branch information
oddhack committed Oct 22, 2024
1 parent 8588af0 commit 9f7314b
Show file tree
Hide file tree
Showing 14 changed files with 93 additions and 76 deletions.
71 changes: 37 additions & 34 deletions ChangeLog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ Internal Issues
palette when VK_NV_shading_rate_image is enabled (internal MR 6872).
* Merge common draw vertex binding VUs for shader object and pipeline
patch control and update corresponding language in the shader object
<<shaders-objects-state Setting State>> section (internal MR 6876).
<<shaders-objects-state, Setting State>> section (internal MR 6876).
* Fix definition of the built-in variable
<<interfaces-builtin-variables-viewindex, ViewIndex>> to specify it
returns bit indexes, not bit values (internal MR 6877).
Expand Down Expand Up @@ -519,7 +519,7 @@ Internal Issues
* Unify markup for corresponding, but differently named subgroup property
members of VkPhysicalDeviceVulkan11Properties and
VkPhysicalDeviceSubgroupProperties (internal issue 3886).
* Fix <<spirvenv-module-validation-runtime Runtime SPIR-V Validation>> VU
* Fix <<spirvenv-module-validation-runtime, Runtime SPIR-V Validation>> VU
09644 for SubpassData variables declared as arrays (internal issue
3887).
* Clarify when VkDescriptorSetLayout objects can be freed in the
Expand Down Expand Up @@ -835,7 +835,7 @@ Internal Issues
transition, VkImageViewCreateInfo, and VkSparseImageMemoryBindInfo
(internal MR 6522).
* fix shader object interaction with dynamic blend states in the
<<shaders-objects-state]] Setting State>> section and common draw VUs
<<shaders-objects-state, Setting State>> section and common draw VUs
(internal MR 6523).

New Extensions
Expand Down Expand Up @@ -1812,10 +1812,11 @@ Internal Issues
3537).
* Remove check in reflow.py that did not allow embedded conditionals in VU
statement markup (internal issue 3545).
* Reduce duplication of spec language in the <<Cooperative Matrices>>
section, where the apiext:VK_KHR_cooperative_matrix interfaces are
similar to, but not promoted from the apiext:VK_NV_cooperative_matrix
interfaces (internal issue 3547).
* Reduce duplication of spec language in the
<<cooperative-matrices,Cooperative Matrices>> section, where the
apiext:VK_KHR_cooperative_matrix interfaces are similar to, but not
promoted from the apiext:VK_NV_cooperative_matrix interfaces (internal
issue 3547).
* Fix shader tile image access for depth/stencil images in
elink:VkAccessFlagBits2 and elink:VkAccessFlagsBits (internal merge
request 5912)
Expand Down Expand Up @@ -1973,8 +1974,8 @@ Internal Issues
will ease keeping the two repositories closely synchronized (internal
merge request 5930).
* Update precision for code:degrees() and code:radians() instructions
in the <<Precision of GLSL.std.450 Instructions>> table
(internal merge request 5922).
in the <<precision-of-glsl-std-450-instructions, Precision of
GLSL.std.450 Instructions>> table (internal merge request 5922).
* Fix definition of code:ulp() in the
<<spirvenv-op-prec, Precision of Individual Operations>>
section to limit the definition to finite numbers
Expand Down Expand Up @@ -2923,7 +2924,7 @@ Internal Issues:
* Tighten wording around <<descriptor-validity>> and in the
<<descriptor-set-initial-state>> section (internal issue 3248).
* Add VU for code:Component decoration on 64 bit types in
<<spirvenv-module-validation-standalone Standalone SPIR-V Validation>>
<<spirvenv-module-validation-standalone, Standalone SPIR-V Validation>>
(internal merge request 5495).
* Clarify the meaning of "`new image`" in flink:vkWaitForPresentKHR
(internal merge request 5513).
Expand Down Expand Up @@ -5786,8 +5787,8 @@ Internal Issues:
`<<VK_KHR_zero_initialize_workgroup_memory>> appendix (internal merge
request 4553).
* Add missing `R64ui` and `R64i` entries to the SPIR-V
<<spirvenv-format-type-matching tables, image format matching tables>>
for `<<VK_EXT_shader_image_atomic_int64>>` (internal
<<spirvenv-format-type-matching, image format matching tables>> for
`<<VK_EXT_shader_image_atomic_int64>>` (internal
Tracker/vk-gl-cts#2885).

New Extensions:
Expand Down Expand Up @@ -6009,8 +6010,8 @@ GitHub Issues:
are different (public issue 1357).
* Fix tagging for slink:VkPhysicalDeviceVulkan11Features in `vk.xml`
(public issue 1437).
* Update the <<WSI Swapchain>> chapter's use of "`release`" and
"`present`" terminology (public pull request 1470).
* Update the <<wsi-swapchain, WSI Swapchain>> chapter's use of "`release`"
and "`present`" terminology (public pull request 1470).
* Migrate from Azure Pipelines to GitHub Actions for CI, and use updated
Khronos Docker image to build (public pull request 1473).

Expand All @@ -6031,7 +6032,7 @@ Internal Issues:
* Update valid usage ID assignment and extraction scripts to handle IDs
containing function pointer names (internal issue 2557).
* Move some runtime restrictions to
<<spirvenv-module-validation-standalone Standalone SPIR-V>> valid usage
<<spirvenv-module-validation-standalone, Standalone SPIR-V>> valid usage
statements (internal merge request 4286).
* Use new version of the HTML asciidoctor-chunker, which runs much faster,
and a new Docker image which omits the old implementation of the chunker
Expand Down Expand Up @@ -6920,8 +6921,9 @@ GitHub Issues:

Internal Issues:

* Improve the layout of the <<Standard sample locations>> table to avoid
overflow in the HTML output (internal issue 1354).
* Improve the layout of the <<standard-sample-locations, Standard Sample
Locations>> table to avoid overflow in the HTML output (internal issue
1354).
* Also build core-only HTML spec in internal CI, to try and catch
extension ifdef errors (should probably also do this in Azure CI on
GitHub) (internal issue 1770).
Expand Down Expand Up @@ -8098,7 +8100,7 @@ Internal Issues:
<<shaders-scope-queue-family>> sections to apply to Vulkan 1.2, as well
as `VK_KHR_vulkan_memory_model` (internal merge request 3570).
* Add performance queries to the list in the introduction of the
<<supported query types, queries>> chapter (internal merge request
<<queries, supported query types>> chapter (internal merge request
3577).

New Extensions
Expand Down Expand Up @@ -8540,8 +8542,8 @@ GitHub Issues:
in same-parent valid usage statements (public pull request 1030).
* Make slink:VkDescriptorUpdateTemplateCreateInfo::pname:descriptorSetLayout
`noautovalidity` in `vk.xml` (public pull request 1031).
* Fix footnote markup in the <<vkGetDeviceProcAddr behavior>> table
(public pull request 1034).
* Fix footnote markup in the <<vkGetDeviceProcAddr-behavior,
vkGetDeviceProcAddr behavior>> table (public pull request 1034).

Internal Issues:

Expand Down Expand Up @@ -8751,7 +8753,8 @@ GitHub Issues:
* Remove redundant slink:VkSubpassDependency and
slink:VkSubpassDependency2KHR valid usage statements
(public pull request 995).
* Clarify the <<vkGetInstanceProcAddr behavior>> and <<vkGetDeviceProcAddr
* Clarify the <<vkGetInstanceProcAddr-behavior, vkGetInstanceProcAddr
behavior>> and <<vkGetDeviceProcAddr-behavior, vkGetDeviceProcAddr
behavior>> tables (public pull request 1004).
* Fix use of nonexistent
slink:VkSamplerYcbcrConversionImageFormatProperties::pname:maxCombinedImageSamplerDescriptorCount
Expand Down Expand Up @@ -9979,7 +9982,7 @@ Internal Issues:
`optimize-pdf` step of PDF generation, due (apparently) to inconsistent
treatment of unwrapped multicharacter terms by different LaTeX parsers
(internal issue 1435).
* For the <<memory-model-synchronizes-with synchronizes-with>> memory
* For the <<memory-model-synchronizes-with, Synchronizes-With>> memory
model relation cases involving a release barrier plus relaxed atomic
write, treat the atomic as if it were a release atomic and allow the
acquire side to read from its hypothetical release sequence. This is
Expand Down Expand Up @@ -10279,8 +10282,8 @@ Public Issues:

Internal Issues:

* Add images to the <<Standard sample locations>> table (internal issue
1115).
* Add images to the <<standard-sample-locations, Standard Sample
Locations>> table (internal issue 1115).
* Add a definition of "`Inherited from`" precision in the
<<spirvenv-precision-operation, Precision and Operation of SPIR-V
Instructions>> section (internal issue 1314).
Expand Down Expand Up @@ -10334,11 +10337,11 @@ Internal Issues:
* Reword and consolidate synchronization valid usage statements for
flink:vkCmdPipelineBarrier such that they correctly account for multiple
possible self-dependencies (internal issue 1322).
* Change order of <<Standard sample locations>> for 2xMSAA (internal issue
1347).
* Add definitions of "`<<Correctly Rounded>>`" and "`<<ULP>>`" in the
SPIR-V environment appendix, and "`Units in the Last Place (ULP)`" in
the glossary.
* Change order of <<standard-sample-locations, Standard Sample Locations>>
for 2xMSAA (internal issue 1347).
* Add definitions of <<spirvenv-correctly-rounded, Correctly Rounded>>
<<spirvenv-ulp, ULP>> in the SPIR-V environment appendix, and "`Units in
the Last Place (ULP)`" in the glossary.

New Extensions:

Expand Down Expand Up @@ -13791,9 +13794,9 @@ GitHub Issues:
source tree (public issue 203).
* Fix duplicate 'which which' typo in description of
elink:VkCommandPoolResetFlagBits (public issue 204).
* Move the <<Programmable Primitive Shading>> section up one level, out of
the <<drawing-primitive-topologies,Primitive Topologies>> section
(public issue 209).
* Move the <<drawing-primitive-shading, Programmable Primitive Shading>>
section up one level, out of the <<drawing-primitive-topologies,
Primitive Topologies>> section (public issue 209).

Internal Issues:

Expand Down Expand Up @@ -13910,8 +13913,8 @@ Internal Issues:
* Document that the requested patch version number specified as part
of slink:VkApplicationInfo::pname:apiVersion is ignored when
creating an instance (internal issue 176).
* Clarify handling of extension structs in the
<<fundamentals-validusageValid Usage>> section (internal issue 254).
* Clarify handling of extension structs in the <<fundamentals-validusage,
Valid Usage>> section (internal issue 254).
* Update required slink:VkImageFormatProperties::pname:maxMipLevels to
be limited to the maximum allowed mipmap pyramid size corresponding
to the actual maximum supported size for the format (internal issue
Expand Down
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -771,7 +771,7 @@ setup_spec_antora pagemap $(JSPAGEMAP): $(JSAPIMAP)
$(QUIET)$(PYTHON) $(SCRIPTS)/antora-prep.py \
-root . \
-component $(shell realpath antora/spec/modules/ROOT) \
-xrefpath antora/spec \
-xrefpath $(GENERATED) \
-pageHeaders antora/pageHeaders-spec.adoc \
-pagemappath $(JSPAGEMAP) \
./config/attribs.adoc \
Expand All @@ -787,7 +787,7 @@ setup_features_antora: features_nav_antora
$(QUIET)$(PYTHON) $(SCRIPTS)/antora-prep.py \
-root . \
-component $(shell realpath antora/features/modules/features) \
-xrefpath antora/features \
-xrefpath $(GENERATED) \
`find ./images/proposals -type f` \
`find ./proposals -name '[A-Za-z]*.adoc'`

Expand Down
2 changes: 2 additions & 0 deletions appendices/spirvenv.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2505,6 +2505,7 @@ Otherwise, either the floating-point value closest to and no less than
[eq]#x# or the value closest to and no greater than [eq]#x# will be
returned.

[[spirvenv-ulp]]
.ULP
Where an error bound of [eq]#n# ULP (units in the last place) is given, for
an operation with infinitely precise result #x# the value returned must: be
Expand Down Expand Up @@ -2630,6 +2631,7 @@ FMod(x,x) computing x rather than 0, and can also cause the result to have a
different sign than the infinitely precise result.
====

[[precision-of-glsl-std-450-instructions]]
.Precision of GLSL.std.450 Instructions
[options="header", cols=",,"]
|====
Expand Down
1 change: 1 addition & 0 deletions chapters/VK_KHR_swapchain/wsi.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
//
// SPDX-License-Identifier: CC-BY-4.0

[[wsi-swapchain]]
== WSI Swapchain

[open,refpage='VkSwapchainKHR',desc='Opaque handle to a swapchain object',type='handles',xrefs='vkQueuePresentKHR']
Expand Down
11 changes: 5 additions & 6 deletions chapters/copies.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -493,6 +493,7 @@ and extents>> of the image's format.

ifdef::VK_QCOM_rotated_copy_commands[]
[[copies-buffers-images-rotation-addressing]]
.Image Rotation Addressing
If a rotation is specified by slink:VkCopyCommandTransformInfoQCOM, the 2D
region of the image being addressed is rotated around the offset, and texels
at each coordinate [eq]#(x',y',z',layer)# are accessed in the image
Expand Down Expand Up @@ -801,9 +802,8 @@ ifdef::VK_QCOM_rotated_copy_commands[]
* [[VUID-VkCopyBufferToImageInfo2KHR-pRegions-04554]]
If the image region specified by each element of pname:pRegions contains
slink:VkCopyCommandTransformInfoQCOM in its pname:pNext chain, the
rotated destination region as described in
<<copies-buffers-images-rotation-addressing>> must: be contained within
pname:dstImage
<<copies-buffers-images-rotation-addressing, rotated destination
region>> must: be contained within pname:dstImage
* [[VUID-VkCopyBufferToImageInfo2KHR-pRegions-04555]]
If any element of pname:pRegions contains
slink:VkCopyCommandTransformInfoQCOM in its pname:pNext chain, then
Expand Down Expand Up @@ -926,9 +926,8 @@ ifdef::VK_QCOM_rotated_copy_commands[]
* [[VUID-VkCopyImageToBufferInfo2KHR-pRegions-04557]]
If the image region specified by each element of pname:pRegions contains
slink:VkCopyCommandTransformInfoQCOM in its pname:pNext chain, the
rotated source region as described in
<<copies-buffers-images-rotation-addressing>> must: be contained within
pname:srcImage
<<copies-buffers-images-rotation-addressing, rotated source region>>
must: be contained within pname:srcImage
* [[VUID-VkCopyImageToBufferInfo2KHR-pRegions-04558]]
If any element of pname:pRegions contains
slink:VkCopyCommandTransformInfoQCOM in its pname:pNext chain, then
Expand Down
23 changes: 12 additions & 11 deletions chapters/descriptorsets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3560,7 +3560,8 @@ If the destination descriptor is a mutable descriptor, the active descriptor
type for the destination descriptor becomes pname:descriptorType.
endif::VK_EXT_mutable_descriptor_type,VK_VALVE_mutable_descriptor_type[]

[[descriptorsets-updates-consecutive, consecutive binding updates]]
[[descriptorsets-updates-consecutive]]
.Consecutive Binding Updates
If the pname:dstBinding has fewer than pname:descriptorCount array elements
remaining starting from pname:dstArrayElement, then the remainder will be
used to update the subsequent binding - [eq]#pname:dstBinding+1# starting at
Expand Down Expand Up @@ -3623,8 +3624,8 @@ endif::VK_VERSION_1_3,VK_EXT_inline_uniform_block[]
* [[VUID-VkWriteDescriptorSet-dstArrayElement-00321]]
The sum of pname:dstArrayElement and pname:descriptorCount must: be less
than or equal to the number of array elements in the descriptor set
binding specified by pname:dstBinding, and all applicable consecutive
bindings, as described by <<descriptorsets-updates-consecutive>>
binding specified by pname:dstBinding, and all applicable
<<descriptorsets-updates-consecutive, consecutive bindings>>
ifdef::VK_VERSION_1_3,VK_EXT_inline_uniform_block[]
* [[VUID-VkWriteDescriptorSet-descriptorType-02219]]
If pname:descriptorType is
Expand Down Expand Up @@ -4324,23 +4325,23 @@ endif::VK_EXT_mutable_descriptor_type,VK_VALVE_mutable_descriptor_type[]
* [[VUID-VkCopyDescriptorSet-srcArrayElement-00346]]
The sum of pname:srcArrayElement and pname:descriptorCount must: be less
than or equal to the number of array elements in the descriptor set
binding specified by pname:srcBinding, and all applicable consecutive
bindings, as described by <<descriptorsets-updates-consecutive>>
binding specified by pname:srcBinding, and all applicable
<<descriptorsets-updates-consecutive, consecutive bindings>>
* [[VUID-VkCopyDescriptorSet-dstBinding-00347]]
pname:dstBinding must: be a valid binding within pname:dstSet
* [[VUID-VkCopyDescriptorSet-dstArrayElement-00348]]
The sum of pname:dstArrayElement and pname:descriptorCount must: be less
than or equal to the number of array elements in the descriptor set
binding specified by pname:dstBinding, and all applicable consecutive
bindings, as described by <<descriptorsets-updates-consecutive>>
binding specified by pname:dstBinding, and all applicable
<<descriptorsets-updates-consecutive, consecutive bindings>>
* [[VUID-VkCopyDescriptorSet-dstBinding-02632]]
The type of pname:dstBinding within pname:dstSet must: be equal to the
type of pname:srcBinding within pname:srcSet
* [[VUID-VkCopyDescriptorSet-srcSet-00349]]
If pname:srcSet is equal to pname:dstSet, then the source and
destination ranges of descriptors must: not overlap, where the ranges
may: include array elements from consecutive bindings as described by
<<descriptorsets-updates-consecutive>>
may: include array elements from <<descriptorsets-updates-consecutive,
consecutive bindings>>
ifdef::VK_VERSION_1_3,VK_EXT_inline_uniform_block[]
* [[VUID-VkCopyDescriptorSet-srcBinding-02223]]
If the descriptor type of the descriptor set binding specified by
Expand Down Expand Up @@ -4736,8 +4737,8 @@ endif::VK_VERSION_1_3,VK_EXT_inline_uniform_block[]
pname:dstArrayElement and pname:descriptorCount must: be less than or
equal to the number of array elements in the descriptor set binding
implicitly specified when using a descriptor update template to update
descriptors, and all applicable consecutive bindings, as described by
<<descriptorsets-updates-consecutive>>
descriptors, and all applicable <<descriptorsets-updates-consecutive,
consecutive bindings>>
ifdef::VK_VERSION_1_3,VK_EXT_inline_uniform_block[]
* [[VUID-VkDescriptorUpdateTemplateEntry-descriptor-02226]]
If pname:descriptor type is
Expand Down
2 changes: 2 additions & 0 deletions chapters/initialization.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ A valid returned function pointer ("`fp`") must: not be `NULL`.
The returned function pointer is of type tlink:PFN_vkVoidFunction, and must:
be cast to the type of the command being queried before use.

[[vkGetInstanceProcAddr-behavior]]
.fname:vkGetInstanceProcAddr behavior
[width="80%",options="header"]
|====
Expand Down Expand Up @@ -121,6 +122,7 @@ be cast to the type of the command being queried before use.
The function pointer must: only be called with a dispatchable object (the
first parameter) that is pname:device or a child of pname:device.

[[vkGetDeviceProcAddr-behavior]]
.fname:vkGetDeviceProcAddr behavior
[width="80%",options="header"]
|====
Expand Down
2 changes: 1 addition & 1 deletion chapters/limits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ flink:vkGetPhysicalDeviceProperties.
granularity, in bytes, at which buffer or linear image resources, and
optimal image resources can: be bound to adjacent offsets in the same
sname:VkDeviceMemory object without aliasing.
See <<resources-bufferimagegranularity,Buffer-Image Granularity>> for
See <<resources-bufferimagegranularity, Buffer-Image Granularity>> for
more details.
* [[limits-sparseAddressSpaceSize]] pname:sparseAddressSpaceSize is the
total amount of address space available, in bytes, for sparse memory
Expand Down
1 change: 1 addition & 0 deletions chapters/primsrast.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -724,6 +724,7 @@ fragment.

<<<

[[standard-sample-locations]]
.Standard Sample Locations
[options="header",align="center"]
|====
Expand Down
2 changes: 1 addition & 1 deletion chapters/resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9762,7 +9762,7 @@ endif::VK_VERSION_1_1,VK_KHR_sampler_ycbcr_conversion[]
endif::VK_VERSION_1_1,VK_KHR_bind_memory2[]


[[resources-bufferimagegranularity,Buffer-Image Granularity]]
[[resources-bufferimagegranularity]]
.Buffer-Image Granularity
The implementation-dependent limit <<limits-bufferImageGranularity,
pname:bufferImageGranularity>> specifies a page-like granularity at which
Expand Down
1 change: 1 addition & 0 deletions chapters/shaders.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3202,6 +3202,7 @@ endif::VK_VERSION_1_1[]


ifdef::VK_NV_cooperative_matrix,VK_KHR_cooperative_matrix[]
[[cooperative-matrices]]
== Cooperative Matrices

A _cooperative matrix_ type is a SPIR-V type where the storage for and
Expand Down
Loading

0 comments on commit 9f7314b

Please sign in to comment.