OpenXR SDK 1.0.17 (2021-06-08)

This release features an important fix to the loader for an
invalid-iterator bug introduced in 1.0.16. All developers shipping the
loader are strongly encouraged to upgrade. It also includes a variety of
new vendor extensions.

-   Registry
    -   Add XR_MSFT_scene_understanding vendor extension. (internal MR
        2032)
    -   Add XR_MSFT_scene_understanding_serialization vendor extension.
        (internal MR 2032)
    -   Add XR_MSFT_composition_layer_reprojection vendor extension.
        (internal MR 2033)
    -   Add XR_OCULUS_audio_device_guid vendor extension. (internal MR
        2053)
    -   Add version 3 of XR_FB_swapchain_update_state vendor extension,
        which splits platform and graphics API specific structs into
        separate extensions. (internal MR 2059)
    -   Apply formatting to registry XML by selectively committing
        changes made by https://github.com/rpavlik/PrettyRegistryXml.
        (internal MR 2070, OpenXR-SDK-Source/#256)
    -   Enforce that all xrCreate functions must be able to return
        XR_ERROR_LIMIT_REACHED and XR_ERROR_OUT_OF_MEMORY, and adjust
        lists of error codes accordingly. (internal MR 2064)
    -   Fix a usage of > without escaping as an XML entity. (internal MR
        2064)
    -   Fix all cases of a success code (most often
        XR_SESSION_LOSS_PENDING) appearing in the errorcodes attribute
        of a command. (internal MR 2064, internal issue 1566)
    -   Improve comments for several enum values. (internal MR 1982)
    -   Perform some script clean-up and refactoring, including
        selective type annotation and moving the Conventions abstract
        base class to spec_tools. (internal MR 2064)
    -   Sort return codes, with some general, popular codes made to be
        early. Script sort_codes.py can be used to maintain this, though
        it mangles other XML formatting, so use it with care.
        https://github.com/rpavlik/PrettyRegistryXml can format, and
        eventually sort return codes (currently sort order does not
        match). (internal MR 2064, OpenXR-SDK-Source/#256)
-   SDK
    -   Loader: Fix iteration over explicit layer manifests.
        (OpenXR-SDK-Source/#256)
    -   validation layer: Don’t try to apply strlen to wchar_t-based
        output buffers. (internal MR 2053)

Author: rpavlik

.appveyor.yml

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-version: 1.0.16.{build}
+version: 1.0.17.{build}
 image: Visual Studio 2017
 
 

.editorconfig

@@ -15,7 +15,7 @@ trim_trailing_whitespace = true
 
 [*.xml]
 indent_style = space
-indent_size = 2
+indent_size = 4
 
 [*.cmake,CMakeLists.txt]
 indent_style = space

.git-blame-ignore-revs

@@ -0,0 +1,42 @@
+# Copyright 2021, The Khronos Group Inc.
+#
+# SPDX-License-Identifier: CC-BY-4.0
+
+# This file contains the commit IDs (on all OpenXR repos!)
+# of "bulk" commits that should be excluded from blame, etc. to
+# make it more useful.
+# When adding new bulk changes, please follow the existing style,
+# and do try to make sure that the bulk change is made
+# **separate from a release commit** on all repos.
+# See <https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-fileltfilegt>
+# for how to use this.
+
+
+## 1.0.17 - Fix XML indentation
+
+# Khronos GitLab
+ae6fe8a4f2cfc3e5e0bb7da3de4d9067e861b5a3
+
+# OpenXR-Docs
+e8ddebd3c7ff6978e84c73e49c41c36ce4a01464
+
+# OpenXR-SDK-Source
+cc8e70f69de3ec536d5bd7cdebcd6e30d36dfcae
+
+# OpenXR-CTS
+e28085d027d0e3b215858906b1ad7d98fb0483ff
+
+
+## 1.0.17 - Sort return codes
+
+# Khronos GitLab
+755ac4d86eb33340289fc0765391c31ce17959fc
+
+# OpenXR-Docs
+bd1f05a6f5da8662c6969996177063a5a98bf0ea
+
+# OpenXR-SDK-Source
+114c3a2829f51eb0e2508a99f98b2e14760ba2c2
+
+# OpenXR-CTS
+1224c0ba88b6f000a5f00f56c0dbb8265a6c6350

.gitignore

@@ -48,10 +48,13 @@ local.properties
 !.clang-tidy
 !.cmake-format.json
 !.editorconfig
+!.git-blame-ignore-revs
+!.git-keep
 !.gitattributes
 !.github
 !.gitignore
 !.gitlab-ci.yml
+!.mailmap
 !.markdownlint.yaml
 !.proclamation.json
 !.reuse

CHANGELOG.SDK.md

@@ -19,6 +19,57 @@ along with any public pull requests that have been accepted.
 In this repository in particular, since it is primarily software,
 pull requests may be integrated as they are accepted even between periodic updates.
 
+## OpenXR SDK 1.0.17 (2021-06-08)
+
+This release features an important fix to the loader for an invalid-iterator bug
+introduced in 1.0.16. All developers shipping the loader are strongly encouraged
+to upgrade. It also includes a variety of new vendor extensions.
+
+- Registry
+  - Add `XR_MSFT_scene_understanding` vendor extension.
+    ([internal MR 2032](https://gitlab.khronos.org/openxr/openxr/merge_requests/2032))
+  - Add `XR_MSFT_scene_understanding_serialization` vendor extension.
+    ([internal MR 2032](https://gitlab.khronos.org/openxr/openxr/merge_requests/2032))
+  - Add `XR_MSFT_composition_layer_reprojection` vendor extension.
+    ([internal MR 2033](https://gitlab.khronos.org/openxr/openxr/merge_requests/2033))
+  - Add `XR_OCULUS_audio_device_guid` vendor extension.
+    ([internal MR 2053](https://gitlab.khronos.org/openxr/openxr/merge_requests/2053))
+  - Add version 3 of `XR_FB_swapchain_update_state` vendor extension, which splits
+    platform and graphics API specific structs into separate extensions.
+    ([internal MR 2059](https://gitlab.khronos.org/openxr/openxr/merge_requests/2059))
+  - Apply formatting to registry XML by selectively committing changes made by
+    <https://github.com/rpavlik/PrettyRegistryXml>.
+    ([internal MR 2070](https://gitlab.khronos.org/openxr/openxr/merge_requests/2070),
+    [OpenXR-SDK-Source/#256](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/256))
+  - Enforce that all `xrCreate` functions must be able to return
+    `XR_ERROR_LIMIT_REACHED` and `XR_ERROR_OUT_OF_MEMORY`, and adjust lists of
+    error codes accordingly.
+    ([internal MR 2064](https://gitlab.khronos.org/openxr/openxr/merge_requests/2064))
+  - Fix a usage of `>` without escaping as an XML entity.
+    ([internal MR 2064](https://gitlab.khronos.org/openxr/openxr/merge_requests/2064))
+  - Fix all cases of a success code (most often `XR_SESSION_LOSS_PENDING`)
+    appearing in the `errorcodes` attribute of a command.
+    ([internal MR 2064](https://gitlab.khronos.org/openxr/openxr/merge_requests/2064),
+    [internal issue 1566](https://gitlab.khronos.org/openxr/openxr/issues/1566))
+  - Improve comments for several enum values.
+    ([internal MR 1982](https://gitlab.khronos.org/openxr/openxr/merge_requests/1982))
+  - Perform some script clean-up and refactoring, including selective type
+    annotation and moving the Conventions abstract base class to `spec_tools`.
+    ([internal MR 2064](https://gitlab.khronos.org/openxr/openxr/merge_requests/2064))
+  - Sort return codes, with some general, popular codes made to be early. Script
+    `sort_codes.py` can be used to maintain this, though it mangles other XML
+    formatting, so use it with care. <https://github.com/rpavlik/PrettyRegistryXml>
+    can format, and eventually sort return codes (currently sort order does not
+    match).
+    ([internal MR 2064](https://gitlab.khronos.org/openxr/openxr/merge_requests/2064),
+    [OpenXR-SDK-Source/#256](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/256))
+- SDK
+  - Loader: Fix iteration over explicit layer manifests.
+    ([OpenXR-SDK-Source/#256](https://github.com/KhronosGroup/OpenXR-SDK-Source/pull/256))
+  - validation layer: Don't try to apply `strlen` to `wchar_t`-based output
+    buffers.
+    ([internal MR 2053](https://gitlab.khronos.org/openxr/openxr/merge_requests/2053))
+
 ## OpenXR SDK 1.0.16 (2021-05-11)
 
 This release contains an update to define a new error code,

README.md

@@ -40,3 +40,13 @@ Currently the best sample code is in [src/tests/hello_xr/](https://github.com/Kh
 ## Building
 
 See [BUILDING.md](https://github.com/KhronosGroup/OpenXR-SDK-Source/blob/master/BUILDING.md)
+
+## Note about `git blame`
+
+We are tracking "bulk commits" in the `.git-blame-ignore-revs` file, for better
+git blame output. Sadly it appears that web interfaces do not yet handle this
+file, but you can if using the command line. See
+[--ignore-revs-file docs](https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-fileltfilegt)
+for details, and
+[this blog post about ignore-revs](https://www.moxio.com/blog/43/ignoring-bulk-change-commits-with-git-blame)
+for some useful usage details.

changes/sdk/pr.256.gh.OpenXR-SDK-Source.md

@@ -40,7 +40,7 @@ check_tree_and_changelog() {
     changelog_dir=$1
     shift
     if changes_in_tree "$@"; then
-        if changes_in_tree $changelog_dir; then
+        if changes_in_tree "$changelog_dir"; then
             echo "OK: Found changes in $* and changelog fragment in $changelog_dir"
         else
             echo "Error: Found changes in $* but no changelog fragment in $changelog_dir"
@@ -57,11 +57,14 @@ check_tree_and_changelog() {
     check_tree_and_changelog changes/specification specification/sources
     check_tree_and_changelog changes/registry specification/registry
 
-    if [ "x$CI_MERGE_REQUEST_ID" != "x" ]; then
+    if [ "$CI_OPEN_MERGE_REQUESTS" != "" ]; then
         # This is a CI build of a merge request.
-        echo "Merge request $CI_MERGE_REQUEST_IID"
-        if ! find changes -name "mr.$CI_MERGE_REQUEST_IID.gl.md" | grep -q "."; then
-            echo "Warning: Could not find a changelog fragment named mr.$CI_MERGE_REQUEST_IID.gl.md"
+        # shellcheck disable=SC2001
+        mr_num=$(echo "${CI_OPEN_MERGE_REQUESTS}" | sed 's/.*!//')
+        fragment_fn="mr.$mr_num.gl.md"
+        echo "Merge request $CI_OPEN_MERGE_REQUESTS: expecting one or more fragments named $fragment_fn"
+        if ! find changes -name "$fragment_fn" | grep -q "."; then
+            echo "Warning: Could not find a changelog fragment named $fragment_fn"
             # RESULT=false
         fi
     fi

maintainer-scripts/check-changelog-fragments.sh

@@ -34,7 +34,7 @@ makeSubset() {
 
 }
 
-COMMON_FILES=".gitignore .gitattributes CODE_OF_CONDUCT.md LICENSES .reuse .editorconfig"
+COMMON_FILES=".gitignore .gitattributes .git-blame-ignore-revs CODE_OF_CONDUCT.md LICENSES .reuse .editorconfig"
 export COMMON_FILES
 
 add_to_tar() {
@@ -130,6 +130,7 @@ getDocsFilenames() {
         | grep -v "vuid[.]adoc" \
         | grep -v "CMakeLists.txt" \
         | grep -v "ubmitted" \
+        | grep -v "experimental" \
         | grep -v "compare" \
         | grep -v "JP\.jpg"
 }

maintainer-scripts/common.sh

@@ -44,7 +44,7 @@ ifneq (,$(strip $(VERY_STRICT)))
 ASCIIDOC := $(ASCIIDOC) --failure-level WARN
 endif
 
-SPECREVISION = 1.0.16
+SPECREVISION = 1.0.17
 REVISION_COMPONENTS = $(subst ., ,$(SPECREVISION))
 MAJORMINORVER = $(word 1,$(REVISION_COMPONENTS)).$(word 2,$(REVISION_COMPONENTS))
 
@@ -166,7 +166,7 @@ BASIC_GENERATED_DEPENDS := \
   $(SCRIPTS)/reg.py \
   $(SCRIPTS)/generator.py \
   $(SPECTOOLS)/util.py \
-  $(SCRIPTS)/conventions.py \
+  $(SPECTOOLS)/conventions.py \
   $(SCRIPTS)/xrconventions.py \
   config_stamp \
   Makefile
@@ -393,6 +393,7 @@ MANDEPS      = $(MANCOPYRIGHT) $(GENINCLUDE) $(GENDEPENDS)
 MANATTRIBOPTS := -a stylesheet=khronos.css \
 				-a stylesdir=$(CURDIR)/config \
 				-a html_spec_relative='../../openxr.html' \
+				-a imagesdir=$(CURDIR)/sources
 
 # Pure makefile lowercase function, generated by a script.
 make_lower = $(subst A,a,$(subst B,b,$(subst C,c,$(subst D,d,$(subst E,e,$(subst F,f,$(subst G,g,$(subst H,h,$(subst I,i,$(subst J,j,$(subst K,k,$(subst L,l,$(subst M,m,$(subst N,n,$(subst O,o,$(subst P,p,$(subst Q,q,$(subst R,r,$(subst S,s,$(subst T,t,$(subst U,u,$(subst V,v,$(subst W,w,$(subst X,x,$(subst Y,y,$(subst Z,z,$(1)))))))))))))))))))))))))))