Vulkan-Docs/doc/specs/vulkan/buildRelease

84 lines
2.3 KiB
Plaintext
Raw Normal View History

2016-02-16 01:53:44 -08:00
#!/bin/sh
# This script builds a full release package including XHTML and PDF
# versions of both master and wsi_extensions branches. Other files
# in the release directory are removed, including man pages,
# XHTML chunked, HTML, validity output, etc.
#
# Both branches must be fully committed and up to date when the
# script is run, with no outstanding un-added / un-committed
# files. Both branches must have fully regenerated all
# automatically-regeneratable files.
#
# After completing the build, the current branch is set to 'master'
# and suggestions for creating tags are printed out.
#
# Essentially replaced by genRelease
# Root of the Vulkan git repo
root=/home/tree/git/vulkan
# Directory with vk.xml and generation tools
xml=$root/src/spec
# Directory with spec sources
spec=$root/doc/specs/vulkan
# Branch name for WSI
wsibranch=wsi_extensions
##################### master Branch #####################
echo "**** GENERATING MASTER BRANCH ****"
git checkout master
echo "**** AUTOGENERATING HEADERS AND SPEC INCLUDE FILES ****"
cd $xml
Change log for May 13, 2016 Vulkan 1.0.13 spec update: * Bump API patch number and header version number to 13 for this update. Github Issues: * Improve the description of ename:VK_PRESENT_MODE_FIFO_RELAXED_KHR in the VK_KHR_surface extension (public issue 174). * Clarify use of etext:*_SIMULTANEOUS_USE_BIT for secondary command buffers (public issue 182). * Fix typos in VK_KHR_wayland_surface extension where code:wl_device was used instead of code:wl_display (public issue 193). * Replaced {apiname} with ``Vulkan'' in XML validity statements (public issue 199). * Fix dead links for WSI handle types (public issue 200). *** N.b. this needs to be done in WSI branches as well *** * Use "signaled" instead of "signalled" spelling everywhere (public issue 201). *** N.b. this needs to be done in WSI branches as well *** * Move readme.pdf target directory for XML schema documentation into the target generation directory, instead of leaving it checked into the spec source tree (public issue 203). *** N.b. need to add generated PDF to registry index/1.0 page * 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). Internal Issues: * Clarify in the <<pipelines-cache,Pipeline Cache>> section that implementations should not manage the size of pipeline cache (internal issue 192). * Deprecate the concept of device layers and associated commands (internal issue 255). * Remove ename:VK_INCOMPLETE from the list of possible result codes of flink:vkGetPhysicalDeviceSurfaceCapabilitiesKHR (internal issue 314). * Add missing std140/std430 rule: the base alignment of a member following a structure is a multiple of the structure's base alignment (internal issue 321). * Fixes naming of the single elink:VkColorSpaceKHR enum from ename:VK_COLORSPACE_SRGB_NONLINEAR_KHR to ename:VK_COLOR_SPACE_SRGB_NONLINEAR_KHR in XML/header and the VK_KHR_swapchain and VK_KHR_surface extensions to match the style of the typename (space and color are two words, not one) (internal issue 322). * Make it clear that code:LocalInvocationID should only be applied to an input variable and normalize the language describing code:LocalInvocationID to the language for other compute shader variables in the <<interfaces-builtin-variables,Built-in Variables>> section, and add normative language (internal issue 323). * Clarify in the <<fundamentals-returncodes,Return Codes>> section that the result pointer may be modified for specific commands, even if a runtime error is returned (internal issue 324).
2016-05-13 17:01:59 -07:00
make OUTDIR=$outdir clobber full_install
2016-02-16 01:53:44 -08:00
echo "**** CLEANING SPEC ****"
cd $spec
outdir=$root/out
rm -rf $outdir/man $outdir/xhtml $outdir/pdf $outdir/chunked $outdir/vkspec.html
rm specversion.txt
echo "**** GENERATING SPEC ****"
make specversion.txt
make OUTDIR=$outdir xhtml pdf
rm $outdir/pdf/vkspec.xml
git checkout -- specversion.txt
##################### wsi_extensions Branch #####################
echo "**** GENERATING WSI BRANCH ****"
git checkout $wsibranch
echo "**** AUTOGENERATING WSI HEADERS AND SPEC INCLUDE FILES ****"
cd $xml
make clobber
make full_install
echo "**** CLEANING WSI SPEC ****"
cd $spec
outdir=$root/out/wsi
rm -rf $outdir/man $outdir/xhtml $outdir/pdf $outdir/chunked $outdir/vkspec.html
rm specversion.txt
echo "**** GENERATING WSI SPEC ****"
make specversion.txt
make OUTDIR=$outdir xhtml pdf
rm $outdir/pdf/vkspec.xml
git checkout -- specversion.txt
##################### Post-generation cleanup #####################
git checkout master
echo "*** Spec generaion complete, on master branch"
echo "To tag the spec branches, do the following:"
date=`date +%Y%m%d`
echo git checkout master
echo git tag -a -m '"Tag core API specification for' $date 'release"' v1.0-core-$date
echo git checkout $wsibranch
echo git tag -a -m '"Tag core+WSI API specification for' $date 'release"' v1.0-core+wsi-$date