Skip to content
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

extensions/ext: Rename debug_utils_set_object_name to set_debug_utils_object_name and debug_utils_set_object_tag to set_debug_utils_object_tag for consistency and deprecate old ones #661

Merged
merged 5 commits into from
Sep 24, 2022

Conversation

BeastLe9enD
Copy link
Contributor

Fixes #660

Copy link
Collaborator

@MarijnS95 MarijnS95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you fix the title of this PR, add a changelog entry, and target 0.37-stable? For the master branch I'd remove the offending function entirely.

ash/src/extensions/ext/debug_utils.rs Outdated Show resolved Hide resolved
Changelog.md Outdated Show resolved Hide resolved
@MarijnS95
Copy link
Collaborator

MarijnS95 commented Sep 23, 2022

For the deprecation message, vk.xml uses the following: Backwards-compatible alias containing a typo. We don't need to use that, but something like it has my preference. I.e. Backwards-compatible alias containing a typo, use <the right function name> instead.

Also, can you double-check if intradoc links in deprecation messages now work?

@BeastLe9enD BeastLe9enD changed the title Fix VK_EXT_debug_utils inconsistency extensions/ext: Renamed debug_utils_set_object_name to set_debug_utils_object_name and debug_utils_set_object_tag to set_debug_utils_object_tag for consistency and deprecated old ones Sep 23, 2022
@MarijnS95 MarijnS95 changed the title extensions/ext: Renamed debug_utils_set_object_name to set_debug_utils_object_name and debug_utils_set_object_tag to set_debug_utils_object_tag for consistency and deprecated old ones extensions/ext: Rename debug_utils_set_object_name to set_debug_utils_object_name and debug_utils_set_object_tag to set_debug_utils_object_tag for consistency and deprecate old ones Sep 23, 2022
@BeastLe9enD BeastLe9enD changed the base branch from master to 0.37-stable September 23, 2022 18:05
@MarijnS95
Copy link
Collaborator

Also, can you double-check if intradoc links in deprecation messages now work?

Even after fixing the reference (must be prefixed by Self:: or DebugUtils::) they still don't work:

image

Can you remove the [] link brackets around it, and add () at the end of the name?

@MarijnS95
Copy link
Collaborator

@BeastLe9enD Also, after targeting 0.37-stable feel free to submit a new PR removing the functions entirely for master (with appropriate changelog item). I'll sort out the changelog on master when we eventually perform a 0.37 release.

@MarijnS95 MarijnS95 changed the base branch from 0.37-stable to master September 24, 2022 08:56
@MarijnS95 MarijnS95 merged commit f0e636a into ash-rs:master Sep 24, 2022
@MarijnS95
Copy link
Collaborator

Since this hasn't been rebased on 0.37-stable (only the target branch was updated) I'll cherry-pick it to that branch (like I do with any other PR for now, however inconvenient that workflow may be) and push a commit to master that removes the deprecated functions entirely.

MarijnS95 added a commit that referenced this pull request Sep 24, 2022
…ame()` and `debug_utils_set_object_tag()` entirely

See also #660/#661.
MarijnS95 pushed a commit that referenced this pull request Sep 24, 2022
…ils_object_name` and `debug_utils_set_object_tag` to `set_debug_utils_object_tag` for consistency and deprecate old ones (#661)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

VK_EXT_debug_utils function inconsistency
2 participants