Clarify the VK_LOADER_DRIVERS_SELECT example #1130
Merged
Conversation
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
In the documentation examples, if we set `VK_LOADER_DRIVERS_SELECT=nvidia`, we are saying to the loader to select only the driver whose JSON manifest is called exactly `nvidia`. This is likely not what we want, because the Nvidia drivers are usually called something like `nvidia_icd.json`, and not just `nvidia` without a file extension. In the "Behavior" column it already states that: "Since drivers don’t have a name like layers, this glob is used to compare against the manifest filename." So, to avoid confusion, we just need to change the example to reflect how the loader glob works. This commit also adds an additional automated test to ensure that this full-name string glob actually works as described in the documentation. Signed-off-by: Ludovico de Nittis <ludovico.denittis@collabora.com>
|
Author RyuzakiKK not on autobuild list. Waiting for curator authorization before starting CI build. |
MarkY-LunarG
approved these changes
Jan 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the documentation examples, if we set
VK_LOADER_DRIVERS_SELECT=nvidia, we are saying to the loader to select only the driver whose JSON manifest is called exactlynvidia.This is likely not what we want, because the Nvidia drivers are usually called something like
nvidia_icd.json, and not justnvidiawithout a file extension.In the "Behavior" column it already states that:
"Since drivers don’t have a name like layers, this glob is used to compare against the manifest filename."
So, to avoid confusion, we just need to change the example to reflect how the loader glob works.
This commit also adds an additional automated test to ensure that this full-name string glob actually works as described in the documentation.