-
Notifications
You must be signed in to change notification settings - Fork 518
Fix copy/paste error in wsi.adoc
#2643
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
@cubanismo agreed this is a cut & paste error, probably from when we were getting the array query language more consistent. Please ask SI TSG to sign off. |
chapters/VK_KHR_surface/wsi.adoc
Outdated
| written to pname:pPresentModes. | ||
| Otherwise, pname:presentModeCount must: be set by the application to the | ||
| number of elements in the pname:pPresentModes array, and on return the | ||
| variable is overwritten with the number of values actually written to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe also drop "the variable" here since it is a product of the indirection language removed above it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe also drop "the variable" here since it is a product of the indirection language removed above it?
Descriptions of following variables use the exactly same phrase "and on return the variable is ...":
// In limits.adoc
layeredApiCount
copyDstLayoutCount
copySrcLayoutCount
// In wsi.adoc
presentModeCount
presentationTimingCount
timingCount
Remove "the variable" from all these descriptions?
cubanismo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please resolve inline feedback and fix CI issues.
|
SI TSG Discussion Today: Approved once CI and feedback above are resolved. Assigning @EasyVulkan to follow-up. |
cubanismo
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah I didn't realize this wording was so widespread. Regardless, the new wording sounds better to me.
|
Note: Ignore the copyright date check CI failures for now. Something isn't working right there. I manually verified the copyright was correctly updated for the files this change touches. |
We tried to harmonize all the array query language a while back. In this case the pattern is ", and on return pname:{name of member} is overwritten...". The more common case is "pname:foo points to a variable ... and on return the variable is overwritten" but that's not for queries where the count is inside a structure. As for CI that will continue to break until I push the next spec update from gitlab later today. |
From the current description of
VkSurfacePresentModeCompatibilityKHR:Apparently a copy / paste error.
VkSurfacePresentModeCompatibilityKHR::presentModeCountis not a pointer.Change it to: