[vcpkg-cmake] Add check for unused cmake variables by JackBoosY · Pull Request #18201 · microsoft/vcpkg

JackBoosY · 2021-05-31T07:11:20Z

In cmake, unused variables are reported as warnings, but in vcpkg, this most likely means that the option names were not updated after the port update.
So I check them and report them here.

If some options only take effect on a specific platform, such as:

if (APPLE)
    options(WITH_XXX_SUPPORT "with xxx support" OFF)
endif()

Use OPTIONS_CHECK_SKIP to ignore them, and cmake regular expressions are supported:

vcpkg_cmake_configure(
    ...
    OPTIONS_CHECK_SKIP "WITH_XXX_SUPPORT"
)

ports/vcpkg-cmake/vcpkg_cmake_configure.cmake

scripts/cmake/vcpkg_configure_cmake.cmake

JackBoosY · 2021-05-31T07:48:38Z

Set FATAL_ERROR to WARNING temporary to check all ports.

scripts/cmake/vcpkg_configure_cmake.cmake

Neumann-A · 2021-05-31T10:54:18Z

Please exclude VCPKG_* and Z_VCPKG_* variables. I mean the complete set.

Neumann-A · 2021-05-31T10:55:59Z

Also this doesn't work if a variable is guarded by an if statement and a vcpkg feature.

JackBoosY · 2021-06-01T01:58:21Z

Also this doesn't work if a variable is guarded by an if statement and a vcpkg feature.

This function is only for the internal options in the source.

…igure_cmake

JackBoosY · 2021-06-01T07:01:31Z

I've checked the pipeline log, and most of the variables in the warnings are indeed out of date.

JackBoosY · 2021-06-02T07:50:26Z

Parts of the reported info:

poco: ENABLE_SAMPLES
apr: INSTALL_PRIVATE_H
apr-util: APU_DECLARE_EXPORT;APU_DECLARE_STATIC
libpng: PNG_ARM_NEON
openal-soft: ALSOFT_AMBDEC_PRESETS;ALSOFT_BACKEND_ALSA;ALSOFT_BACKEND_COREAUDIO;ALSOFT_BACKEND_JACK;ALSOFT_BACKEND_OPENSL;ALSOFT_BACKEND_OSS;ALSOFT_BACKEND_PORTAUDIO;ALSOFT_BACKEND_PULSEAUDIO;ALSOFT_BACKEND_QSA;ALSOFT_BACKEND_SNDIO;ALSOFT_BACKEND_SOLARIS;ALSOFT_CONFIG;ALSOFT_CPUEXT_NEON;ALSOFT_HRTF_DEFS;ALSOFT_TESTS
allegro5: WANT_CURL_EXAMPLE;WANT_GLES2
angle: ANGLE_IS_64_BIT_CPU
thrift: WITH_STDTHREADS
arrow: uriparser_SOURCE
assimp: ASSIMP_BUILD_ASSIMP_VIEW
tiff: WITH_ZSTD
leptonica: STATIC
tesseract: USE_SYSTEM_ICU
aubio: HAVE_LIBAV;HAVE_SNDFILE;HAVE_SWRESAMPLE;HAVE_WAVREAD;HAVE_WAVWRITE
zeromq: DISABLE_WS
azure-uamqp-c: build_as_dynamic
azure-uhttp-c: build_as_dynamic
azure-umqtt-c: build_as_dynamic
gtest: BUILD_GTEST
cpprestsdk: WEBSOCKETPP_CONFIG_VERSION
azure-storage-cpp: GETTEXT_LIB_DIR
bond: BOND_ENABLE_COMM
box2d: BUILD_SAMPLES;BUILD_TESTS
leveldb: INSTALL_HEADERS
bullet3: BUILD_DEMOS
caf: CAF_ENABLE_UTILITY_TARGETS;CAF_NO_BENCHMARKS;CAF_NO_CURL_EXAMPLES;CAF_NO_PROTOBUF_EXAMPLES;CAF_NO_QT_EXAMPLES
capstone: CAPSTONE_X86_ONLY
suitesparse: BUILD_METIS;METIS_SOURCE_DIR;SUITESPARSE_INSTALL_PREFIX
lua: SKIP_INSTALL_HEADERS
cartographer: gtest_disable_pthreads
ccfits: CFITSIO_INCLUDE_DIR
celero: CELERO_RUN_EXAMPLE_ON_BUILD
cgns: HDF5_NEEDS_MPI
pybind11: Python3_EXECUTABLE
corrade: WITH_
librdkafka: ENABLE_SHAREDPTR_DEBUG
vtk-m: BUILD_TESTING;VTKm_USE_DEFAULT_TYPES_FOR_VTK
debug-assert: DEBUG_ASSERT_INSTALL
discord-rpc: RAPIDJSONTEST
dlfcn-win32: ENABLE_DEFAULT_PRECISION

JackBoosY · 2021-06-02T08:11:26Z

Depends on #18202.

strega-nil-ms

I'll do these changes; the same changes are also necessary for vcpkg_configure_cmake.

ports/vcpkg-cmake/vcpkg_cmake_configure.cmake

scripts/cmake/vcpkg_configure_cmake.cmake

ports/vcpkg-cmake/vcpkg_cmake_configure.cmake

strega-nil-ms

Minor changes requested.

scripts/cmake/vcpkg_configure_cmake.cmake

ports/vcpkg-cmake/vcpkg_cmake_configure.cmake

versions/v-/vcpkg-cmake.json

JackBoosY · 2021-07-09T02:24:45Z

Ping for review again and merge this PR.

strega-nil-ms · 2021-07-13T21:32:12Z

I'll pull this into the next rollup

BillyONeal · 2021-07-15T22:02:32Z

Dropping 'reviewed' since it's marked 'next rollup'

[vcpkg-cmake] Add check for unused cmake variables

strega-nil-ms · 2021-07-19T03:41:06Z

Closed as part of rollup PR #19001

@JackBoosY

* [rollup:2021-07-16 1/7] PR #18201 (@JackBoosY) [vcpkg-cmake] Add check for unused cmake variables * [rollup:2021-07-16 2/7] PR #18397 (@strega-nil) [vcpkg_list] add new function * [rollup:2021-07-16 3/7] PR #18782 (@strega-nil) [scripts-audit] vcpkg_build_ninja * [rollup:2021-07-16 4/7] PR #18784 (@strega-nil) [scripts-audit] vcpkg_minimum_required * [rollup:2021-07-16 5/7] PR #18785 (@strega-nil) [scripts-audit] vcpkg_replace_string * [rollup:2021-07-16 6/7] PR #18786 (@strega-nil) [scripts-audit] windows scripts * [rollup:2021-07-16 7/7] PR #18945 (@strega-nil) [many ports] remove deprecated vcpkg_check_features call [1/5] Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: PhoebeHui <20694052+PhoebeHui@users.noreply.github.com>

[vcpkg-config-cmake] Add check for unused cmake variables

ce4c584

JackBoosY added info:internal category:tool-update The issue is with build tool or build script, which requires update or should be executed correctly labels May 31, 2021

JackBoosY assigned PhoebeHui May 31, 2021

JackBoosY added the info:world-rebuild label May 31, 2021

continue when the contents are not found

cc3b3f6

JackBoosY commented May 31, 2021

View reviewed changes

ports/vcpkg-cmake/vcpkg_cmake_configure.cmake Outdated Show resolved Hide resolved

scripts/cmake/vcpkg_configure_cmake.cmake Outdated Show resolved Hide resolved

JackBoosY added 2 commits May 31, 2021 15:48

Update ports/vcpkg-cmake/vcpkg_cmake_configure.cmake

dbb3430

Update scripts/cmake/vcpkg_configure_cmake.cmake

be7307e

JackBoosY requested a review from strega-nil-ms May 31, 2021 07:48

JackBoosY commented May 31, 2021

View reviewed changes

scripts/cmake/vcpkg_configure_cmake.cmake Outdated Show resolved Hide resolved

JackBoosY added the category:vcpkg-feature The issue is a new capability of the tool that doesn’t already exist and we haven’t committed label May 31, 2021

JackBoosY added 3 commits May 31, 2021 23:35

Improve logical

13f2fca

add option OPTIONS_CHECK_SKIP to vcpkg_cmake_configure and vcpkg_conf…

0e80fea

…igure_cmake

Update docs

3c3ba18

JackBoosY marked this pull request as ready for review June 1, 2021 07:00

JackBoosY requested a review from ras0219-msft June 1, 2021 07:00

PhoebeHui added info:needs-maintainer-attention Lets the current 'on rotation' vcpkg maintainer know they need to look at this. and removed info:needs-maintainer-attention Lets the current 'on rotation' vcpkg maintainer know they need to look at this. labels Jun 1, 2021

Improve the warning message output

ca20f55

update warning message.

bcfdc0f

strega-nil-ms suggested changes Jun 3, 2021

View reviewed changes

Make Nicole's changes to vcpkg_cmake_configure

2464a3e

strega-nil-ms reviewed Jun 30, 2021

View reviewed changes

scripts/cmake/vcpkg_configure_cmake.cmake Outdated Show resolved Hide resolved

scripts/cmake/vcpkg_configure_cmake.cmake Outdated Show resolved Hide resolved

ports/vcpkg-cmake/vcpkg_cmake_configure.cmake Outdated Show resolved Hide resolved

Nicole's CR

9cf00d5

strega-nil-ms approved these changes Jun 30, 2021

View reviewed changes

Update docs

d2962ca

JackBoosY commented Jul 2, 2021

View reviewed changes

versions/v-/vcpkg-cmake.json Outdated Show resolved Hide resolved

Update versions/v-/vcpkg-cmake.json

f256a83

JackBoosY commented Jul 2, 2021

View reviewed changes

versions/v-/vcpkg-cmake.json Outdated Show resolved Hide resolved

JackBoosY added 2 commits July 2, 2021 14:35

Update versions/v-/vcpkg-cmake.json

0b0cd52

Merge branch 'master' into dev/jack/check-cmake-ununsed-vars

66fcd57

JackBoosY commented Jul 2, 2021

View reviewed changes

versions/v-/vcpkg-cmake.json Show resolved Hide resolved

JackBoosY and others added 3 commits July 2, 2021 14:40

Update versions/v-/vcpkg-cmake.json

2ab78a5

update port version

966d74c

version stuff

5788f05

JackBoosY added the info:needs-maintainer-attention Lets the current 'on rotation' vcpkg maintainer know they need to look at this. label Jul 9, 2021

PhoebeHui approved these changes Jul 12, 2021

View reviewed changes

strega-nil-ms added info:next-rollup and removed category:tool-update The issue is with build tool or build script, which requires update or should be executed correctly requires:vcpkg-team-review This PR or issue requires someone on the vcpkg team to take a further look. labels Jul 13, 2021

BillyONeal removed the info:needs-maintainer-attention Lets the current 'on rotation' vcpkg maintainer know they need to look at this. label Jul 15, 2021

strega-nil-ms pushed a commit to strega-nil/vcpkg that referenced this pull request Jul 19, 2021

[rollup:2021-07-16 1/7] PR microsoft#18201 (@JackBoosY)

9da31a4

[vcpkg-cmake] Add check for unused cmake variables

strega-nil-ms mentioned this pull request Jul 19, 2021

[rollup] Rollup PR 2021-07-16 #19001

Merged

strega-nil-ms closed this Jul 19, 2021

JackBoosY deleted the dev/jack/check-cmake-ununsed-vars branch July 23, 2021 06:36

Conversation

JackBoosY commented May 31, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JackBoosY commented May 31, 2021

Uh oh!

Uh oh!

Neumann-A commented May 31, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Neumann-A commented May 31, 2021

Uh oh!

JackBoosY commented Jun 1, 2021

Uh oh!

JackBoosY commented Jun 1, 2021

Uh oh!

JackBoosY commented Jun 2, 2021

Uh oh!

JackBoosY commented Jun 2, 2021

Uh oh!

strega-nil-ms left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

strega-nil-ms left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JackBoosY commented Jul 9, 2021

Uh oh!

strega-nil-ms commented Jul 13, 2021

Uh oh!

BillyONeal commented Jul 15, 2021

Uh oh!

strega-nil-ms commented Jul 19, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

JackBoosY commented May 31, 2021 •

edited

Loading

Neumann-A commented May 31, 2021 •

edited

Loading