Vulkan-Docs

History

Jon Leech ef053e7c82 Change log for September 16, 2016 Vulkan 1.0.27 spec update: * Bump API patch number and header version number to 27 for this update. Github Issues: * Weaken flink:vkGetPipelineCacheData invariance conditions; previous conditions were stronger than agreed and can't be guaranteed (public issue 280). * Add link to "Vulkan Loader Specification and Architecture Overview" document to Normative References section (public issue 359). Internal Issues: * Be more clear in the <<interfaces-resources-layout-std140, uniform buffer layout>> section that block offsets can be out of order (internal issue 396). * Document that extension authors should add support for their extensions to the validation layers (internal issue 398). * Clarify that the valid range of depth clear values should be limited to the 0..1 range and that copies to depth aspect must also be in this range (internal issue 412). * Specify ``a'' vs. ``an'' use in the style guide (internal issue 432). * Increase the maximum pname:nonCoherentAtomSize value in the <<features-limits-required,Required Limits>> section from 128 to 256 (internal issue 435). * Fix vk_platform.h for compiler errors on some Android platforms (internal issue 441). * Clarify that slink:VkPhysicalDeviceFeatures::pname:pEnabledFeatures == `NULL` disables all features, including the "required" feature pname:robustBufferAccess (internal issue 479). Other Issues: * Expand style guide and make it more self-consistent. * Use ISO 8601 date format everywhere. * Emphasise the correct way of using slink:VkSurfaceCapabilitiesKHR::pname:maxImageCount. * Added +VK_EXT_validation_flags+ extension for validation flag mechanism. * Fix an <<credits,author credit>> to include their current employer.		2016-09-16 21:22:17 -07:00
..
docbook-xsl	Change log for July 22, 2016 Vulkan 1.0.22 spec update:	2016-07-23 03:15:48 -07:00
README	Change log for July 22, 2016 Vulkan 1.0.22 spec update:	2016-07-23 03:15:48 -07:00
manpages.conf	Change log for September 16, 2016 Vulkan 1.0.27 spec update:	2016-09-16 21:22:17 -07:00
mathjax-asciidoc.conf	Change log for September 16, 2016 Vulkan 1.0.27 spec update:	2016-09-16 21:22:17 -07:00
mathjax-docbook.conf	Change log for September 16, 2016 Vulkan 1.0.27 spec update:	2016-09-16 21:22:17 -07:00
mathjax.js	Vulkan 1.0 branch 1.0 for release	2016-02-16 01:53:44 -08:00
vkman.css	Change log for July 15, 2016 Vulkan 1.0.21 spec update:	2016-07-15 19:05:43 -07:00
vkspec-dblatex.sty	Change log for September 16, 2016 Vulkan 1.0.27 spec update:	2016-09-16 21:22:17 -07:00
vkspec-dblatex.xsl	Vulkan 1.0 branch 1.0 for release	2016-02-16 01:53:44 -08:00
vkspec-xhtml.css	Change log for March 10, 2016 Vulkan 1.0.6 spec update:	2016-03-10 17:33:02 -08:00
vkspec.conf	Change log for September 16, 2016 Vulkan 1.0.27 spec update:	2016-09-16 21:22:17 -07:00

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.