Consistently ensure the word 'overlay' is printed when talking about overlays. #1345

BillyONeal · 2024-02-15T03:17:10Z

Also switches to the standard way of referring to file paths on the terminal, and drops the community triplet notice to an 'info' rather than a warning.

Example:

PS D:\vcpkg> git status -u
HEAD detached at origin/master
Untracked files:
  (use "git add <file>..." to include in what will be committed)
        overlay-ports/zlib/0001-Prevent-invalid-inclusions-when-HAVE_-is-set-to-0.patch
        overlay-ports/zlib/0002-build-static-or-shared-not-both.patch
        overlay-ports/zlib/0003-android-and-mingw-fixes.patch
        overlay-ports/zlib/portfile.cmake
        overlay-ports/zlib/usage
        overlay-ports/zlib/vcpkg-cmake-wrapper.cmake
        overlay-ports/zlib/vcpkg.json
        overlay-triplets/x64-windows.cmake
        triplets/community/x64-windows-community.cmake

nothing added to commit but untracked files present (use "git add" to track)
PS D:\vcpkg> D:\vcpkg-tool\out\build\Win-x64-Debug-WithArtifacts\vcpkg.exe install zlib:x64-windows-community zlib:x64-windows zlib:x86-windows --overlay-ports D:\vcpkg\overlay-ports\zlib --overlay-triplets .\overlay-triplets --binarysource clear
Computing installation plan...
The following packages will be built and installed:
  * vcpkg-cmake:x64-windows@2023-05-04
    zlib:x64-windows@1.3.1 -- D:\vcpkg\overlay-ports\zlib
    zlib:x64-windows-community@1.3.1 -- D:\vcpkg\overlay-ports\zlib
    zlib:x86-windows@1.3.1 -- D:\vcpkg\overlay-ports\zlib
Additional packages (*) will be modified to complete this operation.
Detecting compiler hash for triplet x64-windows...
Detecting compiler hash for triplet x64-windows-community...
Detecting compiler hash for triplet x86-windows...
Installing 1/4 vcpkg-cmake:x64-windows@2023-05-04...
Building vcpkg-cmake:x64-windows@2023-05-04...
D:\vcpkg\overlay-triplets\x64-windows.cmake: info: loaded overlay triplet from here
-- Installing: D:/vcpkg/packages/vcpkg-cmake_x64-windows/share/vcpkg-cmake/vcpkg_cmake_configure.cmake
-- Installing: D:/vcpkg/packages/vcpkg-cmake_x64-windows/share/vcpkg-cmake/vcpkg_cmake_build.cmake
-- Installing: D:/vcpkg/packages/vcpkg-cmake_x64-windows/share/vcpkg-cmake/vcpkg_cmake_install.cmake
-- Installing: D:/vcpkg/packages/vcpkg-cmake_x64-windows/share/vcpkg-cmake/vcpkg-port-config.cmake
-- Installing: D:/vcpkg/packages/vcpkg-cmake_x64-windows/share/vcpkg-cmake/copyright
-- Performing post-build validation
Elapsed time to handle vcpkg-cmake:x64-windows: 44.2 ms
vcpkg-cmake:x64-windows package ABI: a73848fd4da981642d092495c505e7687c7e95e2f8e0666a65d7fc2ed4d92580
Installing 2/4 zlib:x64-windows@1.3.1...
Building zlib:x64-windows@1.3.1...
D:\vcpkg\overlay-triplets\x64-windows.cmake: info: loaded overlay triplet from here
D:\vcpkg\overlay-ports\zlib: info: installing overlay port from here
-- Using cached madler-zlib-v1.3.1.tar.gz.
-- Extracting source D:/vcpkg-downloads/madler-zlib-v1.3.1.tar.gz
-- Applying patch 0001-Prevent-invalid-inclusions-when-HAVE_-is-set-to-0.patch
-- Applying patch 0002-build-static-or-shared-not-both.patch
-- Applying patch 0003-android-and-mingw-fixes.patch
-- Using source at D:/vcpkg/buildtrees/zlib/src/v1.3.1-2e5db616bf.clean
-- Configuring x64-windows
-- Building x64-windows-dbg
-- Building x64-windows-rel
-- Installing: D:/vcpkg/packages/zlib_x64-windows/share/zlib/vcpkg-cmake-wrapper.cmake
-- Fixing pkgconfig file: D:/vcpkg/packages/zlib_x64-windows/lib/pkgconfig/zlib.pc
-- Using cached msys2-mingw-w64-x86_64-pkgconf-1~2.1.0-1-any.pkg.tar.zst.
-- Using cached msys2-msys2-runtime-3.4.10-4-x86_64.pkg.tar.zst.
-- Using msys root at D:/vcpkg-downloads/tools/msys2/fdbea3694fb5c0d4
-- Fixing pkgconfig file: D:/vcpkg/packages/zlib_x64-windows/debug/lib/pkgconfig/zlib.pc
-- Installing: D:/vcpkg/packages/zlib_x64-windows/share/zlib/copyright
-- Performing post-build validation
Elapsed time to handle zlib:x64-windows: 3.3 s
zlib:x64-windows package ABI: ead6150e2020408911024d540a9a189203766f5f5d77d84d6765325ec04737e8
Installing 3/4 zlib:x64-windows-community@1.3.1...
Building zlib:x64-windows-community@1.3.1...
D:\vcpkg\triplets\community\x64-windows-community.cmake: info: loaded community triplet from here. Community triplets are not built in the curated registry and are thus less likely to succeed.
D:\vcpkg\overlay-ports\zlib: info: installing overlay port from here
-- Using cached madler-zlib-v1.3.1.tar.gz.
-- Cleaning sources at D:/vcpkg/buildtrees/zlib/src/v1.3.1-2e5db616bf.clean. Use --editable to skip cleaning for the packages you specify.
-- Extracting source D:/vcpkg-downloads/madler-zlib-v1.3.1.tar.gz
-- Applying patch 0001-Prevent-invalid-inclusions-when-HAVE_-is-set-to-0.patch
-- Applying patch 0002-build-static-or-shared-not-both.patch
-- Applying patch 0003-android-and-mingw-fixes.patch
-- Using source at D:/vcpkg/buildtrees/zlib/src/v1.3.1-2e5db616bf.clean
-- Configuring x64-windows-community
-- Building x64-windows-community-dbg
-- Building x64-windows-community-rel
-- Installing: D:/vcpkg/packages/zlib_x64-windows-community/share/zlib/vcpkg-cmake-wrapper.cmake
-- Fixing pkgconfig file: D:/vcpkg/packages/zlib_x64-windows-community/lib/pkgconfig/zlib.pc
-- Using cached msys2-mingw-w64-x86_64-pkgconf-1~2.1.0-1-any.pkg.tar.zst.
-- Using cached msys2-msys2-runtime-3.4.10-4-x86_64.pkg.tar.zst.
-- Using msys root at D:/vcpkg-downloads/tools/msys2/fdbea3694fb5c0d4
-- Fixing pkgconfig file: D:/vcpkg/packages/zlib_x64-windows-community/debug/lib/pkgconfig/zlib.pc
-- Installing: D:/vcpkg/packages/zlib_x64-windows-community/share/zlib/copyright
-- Performing post-build validation
Elapsed time to handle zlib:x64-windows-community: 3 s
zlib:x64-windows-community package ABI: b15f45c307b1080ee5a776069c339f7c7cf72c91f4f24b3578be4efade302bef
Installing 4/4 zlib:x86-windows@1.3.1...
Building zlib:x86-windows@1.3.1...
D:\vcpkg\overlay-ports\zlib: info: installing overlay port from here
-- Using cached madler-zlib-v1.3.1.tar.gz.
-- Cleaning sources at D:/vcpkg/buildtrees/zlib/src/v1.3.1-2e5db616bf.clean. Use --editable to skip cleaning for the packages you specify.
-- Extracting source D:/vcpkg-downloads/madler-zlib-v1.3.1.tar.gz
-- Applying patch 0001-Prevent-invalid-inclusions-when-HAVE_-is-set-to-0.patch
-- Applying patch 0002-build-static-or-shared-not-both.patch
-- Applying patch 0003-android-and-mingw-fixes.patch
-- Using source at D:/vcpkg/buildtrees/zlib/src/v1.3.1-2e5db616bf.clean
-- Configuring x86-windows
-- Building x86-windows-dbg
-- Building x86-windows-rel
-- Installing: D:/vcpkg/packages/zlib_x86-windows/share/zlib/vcpkg-cmake-wrapper.cmake
-- Fixing pkgconfig file: D:/vcpkg/packages/zlib_x86-windows/lib/pkgconfig/zlib.pc
-- Using cached msys2-mingw-w64-x86_64-pkgconf-1~2.1.0-1-any.pkg.tar.zst.
-- Using cached msys2-msys2-runtime-3.4.10-4-x86_64.pkg.tar.zst.
-- Using msys root at D:/vcpkg-downloads/tools/msys2/fdbea3694fb5c0d4
-- Fixing pkgconfig file: D:/vcpkg/packages/zlib_x86-windows/debug/lib/pkgconfig/zlib.pc
-- Installing: D:/vcpkg/packages/zlib_x86-windows/share/zlib/copyright
-- Performing post-build validation
Elapsed time to handle zlib:x86-windows: 3.2 s
zlib:x86-windows package ABI: ef7b1c2bd4e1de5536d15fe06c88de7d5e511042ed90589d6157eb88af470ac2
Total install time: 9.5 s
The package zlib is compatible with built-in CMake targets:

    find_package(ZLIB REQUIRED)
    target_link_libraries(main PRIVATE ZLIB::ZLIB)

PS D:\vcpkg>

…overlays. Also switches to the standard way of referring to file paths on the terminal, and drops the community triplet notice to a message rather than a warning. Example: ```console Installing 1/1 zlib:x86-windows-static@1.3.1... Building zlib:x86-windows-static@1.3.1... D:\vcpkg\triplets\community\x86-windows-static.cmake: message: loaded community triplet from here. Community triplets are not built in the curated registry and are thus less likely to succeed. -- Using cached madler-zlib-v1.3.1.tar.gz. -- Cleaning sources at D:/work/testing/buildtrees/zlib/src/v1.3.1-2e5db616bf.clean. Use --editable to skip cleaning for the packages you specify. -- Extracting source D:/vcpkg-downloads/madler-zlib-v1.3.1.tar.gz -- Applying patch 0001-Prevent-invalid-inclusions-when-HAVE_-is-set-to-0.patch -- Applying patch 0002-build-static-or-shared-not-both.patch -- Applying patch 0003-android-and-mingw-fixes.patch -- Using source at D:/work/testing/buildtrees/zlib/src/v1.3.1-2e5db616bf.clean ``` I'm not sure I like this form myself, in particular 'message' seems really long to say... nothing. This follows the standard way to refer to paths in output though. I do want to stop community triplets being loud and taking up at least 2 lines though.

ras0219-msft · 2024-02-15T21:10:32Z

I do want to stop community triplets being loud and taking up at least 2 lines though.

Shouldn't we only report it once anyway? It seems excessive to repeat the triplet for every package.

I'm not sure I like this form myself, in particular 'message' seems really long to say... nothing. This follows the standard way to refer to paths in output though.

Agreed that 'message: ' seems excessive here. 'info: '?

Could you also add an example of the new overlay text in context to the description?

ras0219-msft

Looking forward to dramatically simplifying this with #1323!

BillyONeal · 2024-02-15T23:31:32Z

Shouldn't we only report it once anyway? It seems excessive to repeat the triplet for every package.

I'm torn on this. I agree it would be nice to not spam it all the time, but I also see people snip out just the block of a failed build when they're having issues, and not noting it being likely to create confusion.

Agreed that 'message: ' seems excessive here. 'info: '?

Will try info, yes.

Could you also add an example of the new overlay text in context to the description?

I was about to say "didn't I already do that?" but just realized I only showed community triplet above. Sure, stand by...

ras0219-msft approved these changes Feb 15, 2024

View reviewed changes

BillyONeal added 2 commits February 15, 2024 15:37

Merge remote-tracking branch 'origin/main' into use-word-overlay

e250c84

Change 'message' to 'info'.

f5df34f

BillyONeal merged commit 42dbe07 into microsoft:main Feb 21, 2024
5 checks passed

BillyONeal deleted the use-word-overlay branch February 21, 2024 01:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consistently ensure the word 'overlay' is printed when talking about overlays. #1345

Consistently ensure the word 'overlay' is printed when talking about overlays. #1345

BillyONeal commented Feb 15, 2024 •

edited

Loading

ras0219-msft commented Feb 15, 2024

ras0219-msft left a comment

BillyONeal commented Feb 15, 2024

Consistently ensure the word 'overlay' is printed when talking about overlays. #1345

Consistently ensure the word 'overlay' is printed when talking about overlays. #1345

Conversation

BillyONeal commented Feb 15, 2024 • edited Loading

ras0219-msft commented Feb 15, 2024

ras0219-msft left a comment

Choose a reason for hiding this comment

BillyONeal commented Feb 15, 2024

BillyONeal commented Feb 15, 2024 •

edited

Loading