[usd] Bump to v24.08 #40225

theblackunknown · 2024-08-02T05:00:26Z

This PR updates usd port to v24.08.

This versions has no more dependency on boost (when USD Python is disabled, which is already set like this in the current port).
Moreover this version is now compatible with oneTBB so we should now be able to test it on the CI.

Changes comply with the maintainer guide.
SHA512s are updated for each updated download.
The "supports" clause reflects platforms that may be fixed by this new version.
Any fixed CI baseline entries are removed from that file.
Any patches that are no longer applied are deleted from the port's directory.
The version database is fixed by rerunning ./vcpkg x-add-version --all and committing the result.
Only one version is added to each modified port's versions file.

dg0yt

Some early comments, not a full review.

dg0yt · 2024-08-02T05:14:35Z

ports/usd/001-fix_rename_find_package_to_find_dependency.patch

+-        find_package(Python3 "@Python3_VERSION@" EXACT COMPONENTS Development REQUIRED)
+        find_dependency(Python3 "@Python3_VERSION@" EXACT COMPONENTS Development REQUIRED)


find_dependency shall not be used with REQUIRED.
TBH I would suggest to stop adding such replacements in vcpkg (unless there is another reason for corection).
It is to be fixed upstream. In vcpkg, find_package must not fail if all dependencies are done correctly.

Good catch, I'll update the patch shortly in the meantime I have opened a PR upstream for it PixarAnimationStudios/OpenUSD#3205

dg0yt · 2024-08-02T05:15:49Z

ports/usd/002-vcpkg_find_tbb.patch

+-find_package(TBB REQUIRED COMPONENTS tbb)
+find_package(TBB CONFIG REQUIRED)


Suggested change

-find_package(TBB REQUIRED COMPONENTS tbb)

+find_package(TBB CONFIG REQUIRED)

-find_package(TBB REQUIRED COMPONENTS tbb)

+find_package(TBB CONFIG REQUIRED)

+set(TBB_tbb_LIBRARY TBB::tbb)

and get rid of the following changes.

I would prefer that we use CMake namespace target all the way, let me try to follow up with an upstream PR to propose this

See PixarAnimationStudios/OpenUSD#3207

My suggestion is for keeping the patch in vcpkg small and still sufficiently robust. It is not what I would propose for upstream.

dg0yt · 2024-08-02T05:17:23Z

ports/usd/002-vcpkg_find_tbb.patch

+
+include(CMakeFindDependencyMacro)
+
+find_dependency(TBB CONFIG REQUIRED)


Suggested change

+find_dependency(TBB CONFIG REQUIRED)

+find_dependency(TBB CONFIG)

(All use of find_dependency depends on this patch. Hm.)

dg0yt · 2024-08-02T05:19:25Z

ports/usd/004-vcpkg_find_openimageio.patch

+-# Use the import targets set by Imath's package config
+-if (Imath_FOUND)
+-    set(__OIIO_IMATH_LIBS "Imath::Imath")


This must work in vcpkg.

Can you clarify what you meant ?
I think instead of removing I could use a if(0) ... endif().
But what I am really after is to not use Imath::Imath and use OpenImageIO::OpenImageIO instead: here OpenUSD is micro-managing the indirect dependency.

dg0yt · 2024-08-02T05:21:38Z

ports/usd/007-vcpkg_find_vma.patch

+ #include "pxr/base/tf/diagnostic.h"
+
+diff --git a/pxr/imaging/hgiVulkan/vk_mem_alloc.cpp b/pxr/imaging/hgiVulkan/vk_mem_alloc.cpp
+deleted file mode 100644


Delete files with portfile commands instead.

Thanks for the suggestion.

Any opinions on using patch over portfile command to transform #include "pxr/imaging/hgiVulkan/vk_mem_alloc.h" in #include <vk_mem_alloc.h> ?

Cheney-W · 2024-08-02T06:13:58Z

ports/usd/portfile.cmake

-    HEAD_REF master
+    REF "v${VERSION}"
+    SHA512 7d4404980579c4de3c155386184ca9d2eb96756ef6e090611bae7b4c21ad942c649f73a39b74ad84d0151ce6b9236c4b6c0c555e8e36fdd86304079e1c2e5cbe
+    HEAD_REF dev


Suggested change

HEAD_REF dev

HEAD_REF release

The default branch of openusd is named release.

Thanks for the review, can you clarify the purpose of HEAD_REF is it to points to the latest bleeding edge dev commit (here dev for OpenUSD), or the latest stable repository commit (here release for OpenUSD)

https://learn.microsoft.com/en-us/vcpkg/maintainers/functions/vcpkg_from_github#head_ref

theblackunknown

Thanks for the early review, here is a partial review on your feedbacks @dg0yt

theblackunknown · 2024-08-04T14:27:42Z

ports/usd/001-fix_rename_find_package_to_find_dependency.patch

+-        find_package(Python3 "@Python3_VERSION@" EXACT COMPONENTS Development REQUIRED)
+        find_dependency(Python3 "@Python3_VERSION@" EXACT COMPONENTS Development REQUIRED)


Good catch, I'll update the patch shortly in the meantime I have opened a PR upstream for it PixarAnimationStudios/OpenUSD#3205

theblackunknown · 2024-08-04T14:41:35Z

ports/usd/002-vcpkg_find_tbb.patch

+-find_package(TBB REQUIRED COMPONENTS tbb)
+find_package(TBB CONFIG REQUIRED)


I would prefer that we use CMake namespace target all the way, let me try to follow up with an upstream PR to propose this

Cheney-W · 2024-09-06T08:54:48Z

/azp run

azure-pipelines · 2024-09-06T08:54:59Z

Azure Pipelines successfully started running 1 pipeline(s).

Cheney-W · 2024-09-09T08:35:00Z

scripts/ci.baseline.txt

-usd:arm64-uwp=skip
-usd:x64-uwp=skip
-usd:x64-windows=skip
-usd:x64-windows-static=skip


usd:x64-windows-static=skip should be kept.

theblackunknown · 2024-08-05T15:21:34Z

ports/usd/portfile.cmake

+# Proper support for a true static usd build is left as a future port improvement.
+vcpkg_check_linkage(ONLY_DYNAMIC_LIBRARY)


Proper support for USD as a static library should probably involve setting the USD monolithic build correctly.
This is not supported before this PR and thus left as a future improvement.

Proper support for USD as a static library should probably involve setting the USD monolithic build correctly

If monolitic means "all parts of USD source", okay.
If monolithic means "one binary including external deps", then "monolithic" is not what vcpkg wants. With CMake config it is easy enough to export the transitive usage requirements. Even if it means adding some conditional find_dependency.

theblackunknown · 2024-10-25T21:12:14Z

ports/usd/004-vcpkg_find_openimageio.patch

+-# Use the import targets set by Imath's package config
+-if (Imath_FOUND)
+-    set(__OIIO_IMATH_LIBS "Imath::Imath")


Can you clarify what you meant ?
I think instead of removing I could use a if(0) ... endif().
But what I am really after is to not use Imath::Imath and use OpenImageIO::OpenImageIO instead: here OpenUSD is micro-managing the indirect dependency.

theblackunknown · 2024-10-25T21:15:59Z

ports/usd/007-vcpkg_find_vma.patch

+ #include "pxr/base/tf/diagnostic.h"
+
+diff --git a/pxr/imaging/hgiVulkan/vk_mem_alloc.cpp b/pxr/imaging/hgiVulkan/vk_mem_alloc.cpp
+deleted file mode 100644


Thanks for the suggestion.

theblackunknown · 2024-10-25T21:16:27Z

ports/usd/007-vcpkg_find_vma.patch

+ #include "pxr/base/tf/diagnostic.h"
+
+diff --git a/pxr/imaging/hgiVulkan/vk_mem_alloc.cpp b/pxr/imaging/hgiVulkan/vk_mem_alloc.cpp
+deleted file mode 100644


Any opinions on using patch over portfile command to transform #include "pxr/imaging/hgiVulkan/vk_mem_alloc.h" in #include <vk_mem_alloc.h> ?

theblackunknown · 2024-10-26T16:03:49Z

@dg0yt sorry for taking this long, I think I have addressed all your suggestions and comments.

theblackunknown · 2024-10-26T16:04:55Z

Also OpenUSD v24.11 has just been released and I would like to work toward making usd port compatible with it, so let me know what remain to be done for this PR.

dg0yt

(Community feedback)

You could go straight to the latest version if it isn't too much work to update the patches.

Patch should be kept small. This might be different from what one submit upstream.

dg0yt · 2024-10-27T16:31:37Z

ports/usd/002-vcpkg_find_tbb.patch

+-find_package(TBB REQUIRED COMPONENTS tbb)
+find_package(TBB CONFIG REQUIRED)


My suggestion is for keeping the patch in vcpkg small and still sufficiently robust. It is not what I would propose for upstream.

dg0yt · 2024-10-27T16:35:58Z

ports/usd/portfile.cmake

+# Proper support for a true static usd build is left as a future port improvement.
+vcpkg_check_linkage(ONLY_DYNAMIC_LIBRARY)


Proper support for USD as a static library should probably involve setting the USD monolithic build correctly

If monolitic means "all parts of USD source", okay.
If monolithic means "one binary including external deps", then "monolithic" is not what vcpkg wants. With CMake config it is easy enough to export the transitive usage requirements. Even if it means adding some conditional find_dependency.

dg0yt · 2024-10-27T16:43:14Z

ports/usd/portfile.cmake

+    if(NOT VCPKG_BUILD_TYPE OR VCPKG_BUILD_TYPE STREQUAL "debug")
+        vcpkg_copy_tools(
+            TOOL_NAMES ${tools}
+            SEARCH_DIR "${CURRENT_PACKAGES_DIR}/debug/bin"
+            DESTINATION "${CURRENT_PACKAGES_DIR}/debug/tools/${PORT}"
+        )
+    endif()


I guess there is a reason why vcpkg_copy_tools normally omits debug tools.
If the port is really meant to install the debug tools, it might be good to add a comment.
And btw it is enough to check if(NOT VCPKG_BUILD_TYPE) in a portfile.

Cheney-W · 2024-10-28T09:18:02Z

ports/usd/vcpkg.json

@@ -1,22 +1,12 @@
 {
  "name": "usd",
-  "version": "24.5",
+  "version-string": "24.08",


Suggested change

"version-string": "24.08",

"version": "24.8",

we use version because it allows for >=, and we transform VERSION to the desired tag.

Cheney-W · 2024-10-28T09:18:56Z

ports/usd/portfile.cmake

-    REF "v${USD_VERSION}"
-    SHA512 e510f6421caba5e74c6efe5b56b17e9c9741ece0cfd5020148ca89b3ac32bd8781ab00dfc7a134163c85af3f4f01f2529a9baa5a9df9b0c80cbca003e6d199e2
-    HEAD_REF master
+    REF "v${VERSION}"


Suggested change

REF "v${VERSION}"

REF "v${USD_VERSION}"

dg0yt reviewed Aug 2, 2024

View reviewed changes

WangWeiLin-MV assigned Cheney-W Aug 2, 2024

Cheney-W reviewed Aug 2, 2024

View reviewed changes

Cheney-W added the category:port-update The issue is with a library, which is requesting update new revision label Aug 2, 2024

theblackunknown commented Aug 4, 2024

View reviewed changes

theblackunknown force-pushed the usd branch 5 times, most recently from 2b8d78e to dd944d0 Compare August 5, 2024 15:23

Cheney-W reviewed Sep 9, 2024

View reviewed changes

theblackunknown force-pushed the usd branch from dd944d0 to 5dbf9f4 Compare October 25, 2024 21:20

theblackunknown commented Oct 25, 2024

View reviewed changes

theblackunknown marked this pull request as ready for review October 25, 2024 21:20

theblackunknown requested review from Cheney-W and dg0yt October 25, 2024 21:20

theblackunknown force-pushed the usd branch from 5dbf9f4 to 80502c6 Compare October 26, 2024 16:02

[usd] Bump to v24.08

74bd447

theblackunknown force-pushed the usd branch from 80502c6 to 74bd447 Compare October 26, 2024 23:11

dg0yt reviewed Oct 27, 2024

View reviewed changes

Cheney-W reviewed Oct 28, 2024

View reviewed changes

Cheney-W marked this pull request as draft October 28, 2024 09:20

		- find_package(Python3 "@Python3_VERSION@" EXACT COMPONENTS Development REQUIRED)
		+ find_dependency(Python3 "@Python3_VERSION@" EXACT COMPONENTS Development REQUIRED)

		-find_package(TBB REQUIRED COMPONENTS tbb)
		+find_package(TBB CONFIG REQUIRED)

	+find_dependency(TBB CONFIG REQUIRED)
	+find_dependency(TBB CONFIG)

		# Proper support for a true static usd build is left as a future port improvement.
		vcpkg_check_linkage(ONLY_DYNAMIC_LIBRARY)

[usd] Bump to v24.08 #40225

Are you sure you want to change the base?

[usd] Bump to v24.08 #40225

Conversation

theblackunknown commented Aug 2, 2024

dg0yt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

theblackunknown left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Cheney-W commented Sep 6, 2024

azure-pipelines bot commented Sep 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

theblackunknown commented Oct 26, 2024

theblackunknown commented Oct 26, 2024

dg0yt left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment