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

docs: Add layer configuration documentation #85

Merged
merged 1 commit into from
Sep 20, 2023

Conversation

christophe-lunarg
Copy link
Contributor

This PR is moving some documentation from the validation layer to this repository, refactoring it and adding complementary information.

@christophe-lunarg christophe-lunarg self-assigned this Aug 30, 2023
@christophe-lunarg christophe-lunarg added documentation Improvements or additions to documentation P1 labels Aug 30, 2023
@christophe-lunarg christophe-lunarg force-pushed the doc-layer-configurations branch from 6859005 to befe1be Compare August 30, 2023 13:52
@juan-lunarg
Copy link
Contributor

What about these issues in VVL?
KhronosGroup/Vulkan-ValidationLayers#5895
KhronosGroup/Vulkan-ValidationLayers#4667

Will they be moved here?

@christophe-lunarg christophe-lunarg force-pushed the doc-layer-configurations branch from befe1be to 5c1d846 Compare August 30, 2023 16:55
@christophe-lunarg christophe-lunarg marked this pull request as draft August 30, 2023 16:57
@christophe-lunarg
Copy link
Contributor Author

What about these issues in VVL? KhronosGroup/Vulkan-ValidationLayers#5895 KhronosGroup/Vulkan-ValidationLayers#4667

Will they be moved here?

This is still work in progress

@christophe-lunarg christophe-lunarg force-pushed the doc-layer-configurations branch from 5c1d846 to db394b4 Compare August 30, 2023 17:13
@christophe-lunarg christophe-lunarg marked this pull request as ready for review September 19, 2023 17:37
docs/layer_configuration.md Outdated Show resolved Hide resolved
docs/layer_configuration.md Outdated Show resolved Hide resolved
docs/layer_configuration.md Outdated Show resolved Hide resolved
docs/layer_configuration.md Outdated Show resolved Hide resolved
* The library path has been updated using an operating system-specific mechanism such as:
* Linux: adding the path to the layer's library .so with `LD_LIBRARY_PATH`
* MacOS: adding the path to the layer's library .dylib with `DYLD_LIBRARY_PATH`
3. The layer's library file is compiled for the same target and bitdepth (32 vs 64) as the application

Choose a reason for hiding this comment

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

bitdepth -> bitness

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are you sure about this? This is from the original file

Choose a reason for hiding this comment

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

not sure. bitness is more common for arch and bitdepth is for color, but since it was used in original documentation I guess that’s correct too.

Copy link

@artem-lunarg artem-lunarg left a comment

Choose a reason for hiding this comment

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

LGTM. Some editorial suggestions. Learnt few things from this document.

docs/layer_configuration.md Outdated Show resolved Hide resolved
@christophe-lunarg christophe-lunarg merged commit 276fc1b into main Sep 20, 2023
20 checks passed
@christophe-lunarg christophe-lunarg deleted the doc-layer-configurations branch September 20, 2023 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants