OpenColorIO icon indicating copy to clipboard operation
OpenColorIO copied to clipboard

ocio_deps.bat script can provide wrong instructions

Open herronelou opened this issue 3 years ago • 2 comments

Hello, fairly minor issue but: (https://github.com/AcademySoftwareFoundation/OpenColorIO/blob/main/share/dev/windows/ocio_deps.bat#L116) On line 116 or ocio_depts.bat script, the script instructs to use ocio_deps --vs <path>, however, the script does not accept --vs as an argument. I would have attempted a PR myself, however, I'm unsure what the intended use is, and it seems the MSVS variable is never used again, so maybe it only serves as a warning in case Visual Studio is not found?

herronelou avatar Dec 17 '22 03:12 herronelou

Hi @herronelou,

Since the script ocio_deps uses vcpkg, the intent is to warn the user that MS Visual studio is missing as it is a prerequisite to vcpkg (Visual Studio 2015 Update 3 or newer). It would work without this warning, but the user would get an error (if MSVS is missing) during the step where vcpkg installs some OCIO's dependencies.

something like this:

error: in triplet x64-windows: Unable to find a valid Visual Studio instance
Could not locate a complete Visual Studio instance

The part about the --vs option is not needed as the script does not do anything about it and the message seems like an old artifact of a previous refactor that was missed during review. The only requirement is that MSVS is present in the PATH variable to enable vcpkg to find it.

cedrik-fuoco-adsk avatar Jun 20 '23 16:06 cedrik-fuoco-adsk

This was merely to flag that the error message provided wrong instructions, I just didn't do a MR to fix the instructions because I'm not sure what they're meant to be. Cheers

herronelou avatar Jun 20 '23 17:06 herronelou