Improved MAYA_PXR_PLUGINPATH_NAME to handle more checks #949
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
…n_check_control_for_plugins
seando-adsk
approved these changes
Dec 1, 2020
test/lib/usd/plugin/CMakeLists.txt
Outdated
Comment on lines
150
to
156
| install(FILES "${CMAKE_CURRENT_SOURCE_DIR}/${plugName}.py" | ||
| RENAME __init__.py | ||
| DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/TestMayaUsdPlug/${plugName}") | ||
|
|
||
| configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${plugName}_plugInfo.json" | ||
| "${CMAKE_CURRENT_BINARY_DIR}/TestMayaUsdPlug/${plugName}/plugInfo.json" | ||
| ) |
There was a problem hiding this comment.
Minor - these lines should be indented.
| @@ -0,0 +1,30 @@ | |||
| # | |||
| # Copyright 2016 Pixar | |||
There was a problem hiding this comment.
Is there a reason these test files have this copyright?
There was a problem hiding this comment.
Because I took this test plugin from the Pixar repository.
kxl-adsk
added
the
ready-for-merge
kxl-adsk
deleted the
kxl-adsk/better_version_check_control_for_plugins
branch
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.
Plug registry plugins (either pure USD, like render delegates or MayaUsd ones like translators) should never be used with a mismatched version of shared libraries.
When all components are compiled together, there is no chance for version mismatch and PXR_PLUGINPATH_NAME is the proper way to discover and register such plugins.
Plugins distributed separately from MayaUSD should use the
MAYA_PXR_PLUGINPATH_NAMEenv variable to point to a folder with themayaUsdPlugInfo.jsonfile. The JSON file is used to discover plugin paths to register after running requested version checks at runtime. Here is an example file:{ "MayaUsdIncludes":[ { "PlugPath":"testPlugModule1", "VersionCheck":{ "Python":"3", "USD":"0.20.8" } }, { "PlugPath":"testPlugModule2", "VersionCheck":{ "MayaUsd":"0.6.0" } }, { "PlugPath":"testPlugModule3" }, { "PlugPath":"testPlugModule4", "VersionCheck":{ "MayaUsd":"0.0.0" } }, { "PlugPath":"testPlugModule5", "VersionCheck":{ "Python":"1" } }, { "PlugPath":"testPlugModule6", "VersionCheck":{ "USD":"0.0.0" } } ] }The plugin must decide which validation checks are needed by listing them in the
VersionCheckobject. Supported checks are:Every plugin passing version check will get registered in plug registry via
PlugRegistry::GetInstance().RegisterPluginsmethod.