348990517c
* Bump API patch number and header version number to 29 for this update.
Github Issues:
* Remove redundant constraint on
slink:VkCommandBufferInheritanceInfo::pname:queryFlags (public issue
224).
* Fix typo and remove link in Note in the
<<extended-functionality-instance-extensions-and-devices, Instance
Extensions and Device Extensions>> section (public issue 359).
* Fix erroneous validation statement for the pname:layout member of
slink:VkComputePipelineCreateInfo (public issue 362).
Internal Issues:
* Restore long figure captions using asciidoc sidebar blocks, due to
restrictions of asciidoc syntax (internal issue 101).
* Replace most latexmath equations with comparable markup in straight
asciidoc, which significantly improves time required to fully load and
process the HTML forms of the Specification. There are known minor font
and alignment inconsistencies with MathJax and PDF rendering of
latexmath equations. Please do not file github issues about these. We
are aware of the inconsistencies and will make refinements over time,
while the performance improvements are compelling in at least some major
browsers (internal issue 313).
* Move handcoded validity statements from +vk.xml+ into the Specification
body, easing work in the single-branch model. Specify the distinction
between these explicit statements, and the implicit validity statements
inferred from vk.xml. Validity statements now appear in two blocks for
each command and structure - handcoded "Valid Usage" and the implicit
"Valid Usage (Implicit)" (internal issue 392).
* Add the +returnedonly="false"+ attribute to WSI output structures,
removing incorrectly generated implicit validity statements for
slink:VkDisplayPropertiesKHR, slink:VkDisplayPlanePropertiesKHR,
slink:VkDisplayModePropertiesKHR, slink:VkDisplayPlaneCapabilitiesKHR,
slink:VkSurfaceCapabilitiesKHR, and slink:VkSurfaceFormatKHR structures
(internal issue 486).
* Update slink:VkImageLayout to require the
ename:VK_IMAGE_USAGE_SAMPLED_BIT be set for sampled depth/stencil images
(internal issue 487).
* Use an explicit format specifier string for the date command invocation
in the +Makefile+ instead of the shorthand -R option, which doesn't work
on BSD and MaxOS X date commands (internal issue 500).
Other Issues:
* Use the terms ``allocation scope'' and ``extension scope'' instead of
just ``scope'', and add them to the glossary.
|
||
|---|---|---|
| .. | ||
| docbook-xsl | ||
| README | ||
| attribs.txt | ||
| manpages.conf | ||
| mathjax-asciidoc.conf | ||
| mathjax-docbook.conf | ||
| mathjax.js | ||
| vkman.css | ||
| vkspec-dblatex.sty | ||
| vkspec-dblatex.xsl | ||
| vkspec-html.css | ||
| vkspec-xhtml.css | ||
| vkspec.conf | ||
README
This gives an overview of the configuration files in this directory
(doc/specs/vulkan/config/).
--------------- Config File Macros ----------------
The macros in vkspec.conf and manpages.conf are described in the Vulkan
Documentation and Extensions: Procedures and Conventions document (see
../styleguide.txt). There's a parsing issue with comments in vkspec.conf,
so they are pulled out here for now.
----------------- PDF Generation ------------------
vkspec-dblatex.xsl
is XSL specific to a2x->dblatex->PDF spec generation. It is a very
slightly modified version of /etc/asciidoc/dblatex/asciidoc-dblatex.xsl,
as follows:
> <xsl:param name="latex.hyperparam">colorlinks,linkcolor=black,pdfstartview=FitH</xsl:param>
> <xsl:param name="doc.publisher.show">0</xsl:param>
> <xsl:param name="latex.output.revhistory">0</xsl:param>
and has been simplified to just those parameters. Additional templates
replacing those under /usr/share/xml/docbook/stylesheet/dblatex/xsl/*
can be added here.
---------------- XHTML Generation -----------------
vkspec-xhtml.css
is CSS for the xhtml and chunked targets. It is pulled in from
docbook-xsl/common.xsl. This gives us direct control over the CSS for
the document, including support for markup styles.
-------------- Asciibook Stylesheets --------------
docbook-xsl/chunked.xsl
docbook-xsl/common.xsl
docbook-xsl/xhtml.xsl
docbook-xsl/manpage.xsl
replace parts of the asciibook stylesheets normally found under
/etc/asciidoc/docbook-xsl , in order to generate consistent IDs on
sections and to insert MathJax <script> tags into HTML headers. More
will be required for other output types.
---------------- Support for Math -----------------
mathjax-asciidoc.conf
mathjax-docbook.conf
mathjax.js
customize asciidoc macros for HTML and Docbook output to insert MathJax
<script> tags from mathjax.js, and properly pass through math which has
\begin{}\/end{} delimiters instead of $$\[\]\(\), using the <?texmath
delimiters="user"?> processing instruction.
mathjax-docbook.conf is heavily conditionalized depending on whether the
final output format (which should be described in the a2x-format
variable) is 'pdf' or not, since Docbook passes through math differently
to dblatex vs. the HTML stylesheets.