`VkAccessFlagBits` broken link

[Dherse]

Hello,

In the documentation for VkAccessFlagBits there is a broken link: at line 1086 for synchronization.txt (note I'm using an older commit so this may be slightly incorrect), the link that gets generated with the text color, resolve, or depth/stencil resolve attachment gives the link #renderpass instead of https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#renderpass.

Hope this is helpful,

Dherse

[oddhack]

Thanks. I'll take a look at it once things start up again after the holidays.

[Dherse]

Hello,

I am adding to this issue the following similar dead links:

• In VkBufferMemoryBarrier.html: links with text [synchronization-queue-transfers] point to dead-link #synchronization-queue-transfers ;
• In VkImageMemoryBarrier.html: links with text image layout transition point to dead-link #synchronization-image-layout-transitions ;
• In VkImageMemoryBarrier.html: links with text separateDepthStencilLayouts point to dead-link "features-separateDepthStencilLayouts ;
• In VkSubpassDependency.html: links with text geometry shaders point to dead-link #features-geometryShader ;
• In VkSubpassDependency.html: links with text tessellationshaders point to dead-link #features-tessellationShader ;
• In VkSubpassDependency.html: links with text conditional rendering point to dead-link #features-conditionalRendering ;
• In VkSubpassDependency.html: links with text fragment density map point to dead-link #features-fragmentDensityMap ;
• In VkSubpassDependency.html: links with text fragment density map point to dead-link #features-fragmentDensityMap ;
• In VkSubpassDependency.html: links with text transform feedback point to dead-link #features-transformFeedback ;
• In VkSubpassDependency.html: links with text task shaders point to dead-link #features-taskShader ;
• In VkSubpassDependency.html: links with text shading rate image point to dead-link #features-shadingRateImage ;
• In VkSubpassDependency.html: links with text synchronization2 point to dead-link #features-synchronization2 ;
• In VkPhysicalDeviceFeatures.html: links with text filled with <span class="eq">(0,0,1)</span> point to dead-link #fxvertex-input-extraction ;
• In VkBindImageMemoryInfo.html: links with text dedicated allocation image aliasing point to dead-link #features-dedicatedAllocationImageAliasing ;
• In VkPhysicalDeviceSubgroupProperties.html: links with text VK_SUBGROUP_FEATURE_QUAD_BIT point to dead-link #features-subgroup-quad ;
• In VkRayTracingPipelineCreateInfoNV.html: links with text Shader Interfaces point to dead-link #interfaces ;
• In VkRayTracingPipelineCreateInfoNV.html: links with text consistent point to dead-link #descriptorsets-pipelinelayout-consistency ;
• In VkRayTracingPipelineCreateInfoNV.html: links with text pipelineCreationCacheControl point to dead-link #features-pipelineCreationCacheControl ;
• In VkCopyImageInfo2KHR.html: links with text format features point to dead-link #features-pipelineCreationCacheControl ;
• In VkCopyImageInfo2KHR.html: there are links that point to dead-link #features-pipelineCreationCacheControl ;
• In VkCopyImageInfo2KHR.html: there are links that point to dead-link #resources-image-format-features ;
• In VkCopyImageInfo2KHR.html: there are links that point to dead-link #formats-requiring-sampler-ycbcr-conversion ;
• In VkCopyImageInfo2KHR.html: there are links that point to dead-link #copies-images-format-compatibility ;
• In VkCopyImageInfo2KHR.html: there are links that point to dead-link #formats-compatible-planes ;
• In VkCopyImageInfo2KHR.html: there are links that point to dead-link #blocked-image ;
• In VkCopyBufferToImageInfo2KHR.html: there are links that point to dead-link #copies-buffers-images-addressing ;
• In VkMemoryBarrier2KHR.html: there are links that point to dead-link #features-subpassShading ;
• In VkMemoryBarrier2KHR.html: there are links that point to dead-link #features-invocationMask ;
• In VkMemoryBarrier2KHR.html: there are links that point to dead-link #features-rayQuery ;

Let me preface this by saying I don't know how Asciidoc works. But my guess looking at the code, is that when embedding pieces of doc from the spec into the individual doc items, it does not change the links to point to the spec.

Happy holidays,

Dherse

[Dherse]

Hello,

I found another example, in PFN_vkReallocationFunction.html and others, the link vkAllocationFunction_return_rules.html is broken.

There is also something very weird with the generation of PFN_vkInternalFreeNotification.html for the description section, where for some reason it generated a link in the description but puts it in a <code></code> block. The link cannot be clicked and has unusual text for the Vulkan docs.

Regards,

Dherse

[oddhack]

You're correct that the refpage extraction process doesn't always rewrite xrefs into links correctly. It does a pretty good job with the actual refpages blocks, with a few exceptions, but the common validity statements exist in separate asciidoc include files and xrefs there that should be rewritten, aren't. It is a known issue but not a high priority.

[oddhack]

N.b. what we'd probably have to do is change the refpage extraction scripts to actually insert the text of those common validity includes, rather than incorporate them via the 'include::' construct, prior to xref rewriting. It is not hard, but tedious.