-
Notifications
You must be signed in to change notification settings - Fork 466
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Don't use CURDIR to find spec files ... or rather have it default to CURDIR but be overridable. * Add a spec build test This change adds a test spec filled mostly with Lorem Ipsum that can be built in various versions and extensions. The build results are checked against expectations to ensure the spec output is as expected. This is primarily a test of the asciidoc extensions that have been implemented in this repository whose functionality is not automatically tested.
- Loading branch information
Showing
27 changed files
with
15,249 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -71,3 +71,6 @@ xml/.cache | |
|
||
# Node.js dependency packages | ||
node_modules | ||
|
||
# Build test temp output | ||
/build_tests/gen* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
// Copyright 2023 The Khronos Group Inc. | ||
// SPDX-License-Identifier: CC-BY-4.0 | ||
|
||
= Spec Build Tests | ||
|
||
This directory contains test source and expectation files for the `testBuild` | ||
script. The test specification files are: | ||
|
||
* `testspec.adoc` | ||
* `chapters/*.adoc` | ||
* `chapters/commonvalidity/*.adoc` | ||
* `appendices/*.adoc` | ||
* `images/*.svg` | ||
|
||
The expectation files are: | ||
|
||
* `expectations/*.html` | ||
* `expectations/validusage.json` | ||
|
||
The `testBuild` script builds the test specficiation (`testspec.adoc`) in an | ||
array of configurations, such as Core (latest), Core 1.0, with all extensions, | ||
with a specific extension etc. Additionally, it extracts the VUs into | ||
validusage.json. | ||
|
||
Each build by `testBuild` is done in a separate directory under `gen-<build>`. | ||
In all cases except `gen-validusage`, the output is | ||
`gen-<build>/out/html/vkspec.html`. In the case of `gen-validusage`, the output | ||
is `gen-validusage/out/validition/validusage.json`. | ||
|
||
The primary reason for these tests is ensuring correctness of asciidoc | ||
extensions implemented in this repository. The `testBuild` script first builds | ||
all configurations, then verifies the results against the expectations. | ||
|
||
If a build itself regresses (and fails), the script will stop so the issue can | ||
be addressed after looking at the logs of the failing build. If the builds | ||
succeed but the output does not match the expectations, the diff is output for | ||
investigation. | ||
|
||
In some cases, the diff is small enough to be verified. Otherwise, each output | ||
in `gen-<build>/` needs to be manually reviewed to ensure the results are still | ||
correct; for example because the html is styled differently and the differences | ||
are as expected. | ||
|
||
If the mismatch between the output and expectations is expected, and the output | ||
is verified to be correct, update the expectations with: | ||
|
||
---- | ||
$ ./update-expectations | ||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
// Copyright 2021-2023 The Khronos Group, Inc. | ||
// | ||
// SPDX-License-Identifier: CC-BY-4.0 | ||
|
||
include::{generated}/meta/{refprefix}VK_EXT_host_image_copy.adoc[] | ||
|
||
=== Other Extension Metadata | ||
|
||
*Last Modified Date*:: | ||
2186-02-28 | ||
*Contributors*:: | ||
- Zabhash Ifessouy, Elgoog | ||
- Htiaf Dnartske, Aroballoc | ||
- Sreip Lleinad, AIDIVN | ||
|
||
=== Description | ||
|
||
Sed risus pretium quam vulputate dignissim suspendisse in est ante. Mauris | ||
commodo quis imperdiet massa tincidunt nunc pulvinar. Odio morbi quis commodo | ||
odio aenean sed. Quam adipiscing vitae proin sagittis nisl rhoncus. Vel | ||
facilisis volutpat est velit egestas dui. Consequat id porta nibh venenatis | ||
cras sed felis. Ac tortor dignissim convallis aenean et tortor. Amet porttitor | ||
eget dolor morbi non arcu. Consequat interdum varius sit amet. Tempus egestas | ||
sed sed risus pretium quam. Gravida in fermentum et sollicitudin ac orci | ||
phasellus egestas. Nulla facilisi etiam dignissim diam quis enim lobortis | ||
scelerisque fermentum. Tempus quam pellentesque nec nam aliquam. A pellentesque | ||
sit amet porttitor eget. Viverra justo nec ultrices dui sapien eget mi. Nullam | ||
vehicula ipsum a arcu. Amet volutpat consequat mauris nunc congue nisi. | ||
Tincidunt arcu non sodales neque. | ||
|
||
include::{generated}/interfaces/VK_EXT_host_image_copy.adoc[] | ||
|
||
=== Issues | ||
|
||
1) Natoque penatibus et magnis dis parturient montes nascetur. | ||
|
||
*RESOLVED*: Iaculis eu non diam phasellus vestibulum. Consequat nisl vel | ||
pretium lectus quam. Euismod in pellentesque massa placerat duis ultricies | ||
lacus sed turpis. Ullamcorper eget nulla facilisi etiam dignissim diam quis | ||
enim. Id velit ut tortor pretium viverra suspendisse potenti. | ||
|
||
2) Faucibus in ornare quam viverra orci sagittis eu volutpat? | ||
|
||
*RESOLVED*: Eu facilisis sed odio morbi quis commodo. Pharetra magna ac | ||
placerat vestibulum lectus mauris. Ac felis donec et odio pellentesque diam | ||
volutpat commodo sed. | ||
|
||
=== Version History | ||
|
||
* Revision 0, 2173-05-30 (Htiaf Dnartske) | ||
** Malesuada pellentesque elit eget gravida cum sociis natoque | ||
|
||
* Revision 1, 2185-12-01 (Zabhash Ifessouy) | ||
** Id leo in vitae turpis massa sed elementum |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
// Copyright 2020-2023 The Khronos Group Inc. | ||
// | ||
// SPDX-License-Identifier: CC-BY-4.0 | ||
|
||
// Common Valid Usage | ||
// Common to VkBufferImageCopy*, VkMemoryToImageCopy* and VkImageToMemoryCopy* | ||
// structs | ||
// This relies on additional attributes {bufferrowlength} and | ||
// {bufferimageheight} set by the command which includes this file, specifying | ||
// the type of the non-image target of the copy (which is either buffer* or | ||
// memory*). | ||
|
||
* [[VUID-{refpage}-{bufferrowlength}-99101]] | ||
pname:{bufferrowlength} must: be `0`, or greater than or equal to the | ||
pname:width member of pname:imageExtent | ||
* [[VUID-{refpage}-{bufferimageheight}-99102]] | ||
pname:{bufferimageheight} must: be `0`, or greater than or equal to the | ||
pname:height member of pname:imageExtent | ||
* [[VUID-{refpage}-aspectMask-99103]] | ||
The pname:aspectMask member of pname:imageSubresource must: only have a | ||
single bit set | ||
* [[VUID-{refpage}-imageExtent-96659]] | ||
pname:imageExtent.width must: not be 0 | ||
* [[VUID-{refpage}-imageExtent-96660]] | ||
pname:imageExtent.height must: not be 0 | ||
* [[VUID-{refpage}-imageExtent-96661]] | ||
pname:imageExtent.depth must: not be 0 | ||
// Common Valid Usage |
Oops, something went wrong.