mirror of
https://github.com/open-goal/jak-project
synced 2026-08-20 06:16:35 -04:00
Alexander J. Semenuk
5d5e35fb9b
## Problem Windows builds break with a current local toolchain (Scoop LLVM 22.1.8, CMake 4.4.0, VS 2026), in two independent ways: 1. The build stops at curl's deliberate guard: `#error "no non-blocking method was found/used/set"` in `third-party/curl/lib/nonblock.c`. 2. From the second configure onward, `cmake --build` re-runs CMake in an endless loop (observed 42 consecutive reconfigure cycles in a single build). Likely the same mechanism behind the "endlessly building" VS 2026 note in `docs/setup/dev/vs.md`. ## Root cause 1. `third-party/curl/CMake/CurlTests.c` passes `int *` to `ioctlsocket()`, whose third parameter is `u_long *`. Clang 22 promotes `-Wincompatible-pointer-types` to a hard error in C, so the `HAVE_IOCTLSOCKET_FIONBIO` try_compile silently fails and `curl_config.h` never defines it. Upstream CI does not see this because the windows-2022 runner image ships an older LLVM. GCC 14 promotes the same warning to a hard error, which is very likely the `CurlTests.c.obj` failure reported from MSYS2 in open-goal/jak-project#3551. Upstream curl hit the identical problem with GCC 14 and fixed the probe in curl 8.8.0 (curl/curl#13578). 2. The root CMakeLists copies the build tree's `compile_commands.json` into `<src>/build/` for clangd using `configure_file()`, which registers its input as a configure dependency. CMake rewrites `compile_commands.json` late in every generation, after `CTestTestfile.cmake` and `cmake_install.cmake` (outputs of the same Ninja regen rule), so once the dependency is registered the rule is deterministically dirty and every `ninja` invocation re-runs CMake. A pristine first configure is safe (the file does not exist yet, so the `if(EXISTS ...)` guard skips the copy), which is why the loop looks machine- or IDE-specific. ## Fix 1. Per review, re-vendor `third-party/curl` at the `curl-8_21_0` tag (previously `curl-8_3_0`), which carries the upstream probe fix plus two years of upstream development; `vendor.yaml` updated to match. Adjustments the version jump forced: - curl 8.15 removed the native macOS Secure Transport backend (`CURL_USE_SECTRANSP`), so macOS now builds curl against OpenSSL like Linux. The two macOS workflows install Homebrew `openssl@3` and export `OPENSSL_ROOT_DIR` (keg-only), and the macOS setup docs gained the same two lines. - `CURL_BROTLI` / `CURL_ZSTD` switched to AUTO-detection in curl 8.10; pinned OFF to keep the previous no-compression behavior and avoid silently linking whatever the CI images happen to have. - curl's new top-level `BUILD_EXAMPLES` cache option (default ON) leaked into discord-rpc's identically named option and broke configure at a nonexistent `examples/send-presence` directory; pinned OFF ahead of the third-party subdirectories. The diff is dominated by the mechanical tag-tree swap under `third-party/curl` (linguist-vendored, collapsed in review). The hand-written changes are `CMakeLists.txt`, the two macOS workflows, `docs/setup/system/macos.md`, and `vendor.yaml`. 2. Swap `configure_file()` for `file(COPY ...)`: the same clangd copy with no configure dependency registered. (`file(COPY_FILE ... ONLY_IF_DIFFERENT)` would be cleaner still but requires CMake 3.21, above the declared `cmake_minimum_required(VERSION 3.10)`.) ## Test plan - [x] Fresh `cmake --preset Release-windows-clang` (LLVM 22, no cache seeding) completes and logs `Enabled SSL backends: Schannel`; the FIONBIO probe passes without the previous `#error` - [x] Full Windows Release build from scratch in the branch worktree (all 1422 targets) - [x] goalc-test suite: 1509 passed, 0 failed - [x] Second consecutive configure with `compile_commands.json` present: the regen rule in `build.ninja` has no `compile_commands.json` input; `<src>/build/compile_commands.json` is still refreshed for clangd - [x] Repeated `ninja` invocations after a full build no longer re-run CMake - [x] macOS Intel and ARM CI green (first exercise of the OpenSSL backend switch) --- I work off a self-hosted forge, so this GitHub account is quiet; the configure logs and ninja dirty-node traces from the investigation are available if anyone wants the raw data. (AI-assisted)
80 lines
3.1 KiB
Bash
Vendored
Generated
80 lines
3.1 KiB
Bash
Vendored
Generated
#!/bin/sh
|
|
#***************************************************************************
|
|
# _ _ ____ _
|
|
# Project ___| | | | _ \| |
|
|
# / __| | | | |_) | |
|
|
# | (__| |_| | _ <| |___
|
|
# \___|\___/|_| \_\_____|
|
|
#
|
|
# Copyright (C) Dan Fandrich, <dan@coneharvesters.com>, Viktor Szakats, et al.
|
|
#
|
|
# This software is licensed as described in the file COPYING, which
|
|
# you should have received as part of this distribution. The terms
|
|
# are also available at https://curl.se/docs/copyright.html.
|
|
#
|
|
# You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
# copies of the Software, and permit persons to whom the Software is
|
|
# furnished to do so, under the terms of the COPYING file.
|
|
#
|
|
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
# KIND, either express or implied.
|
|
#
|
|
# SPDX-License-Identifier: curl
|
|
#
|
|
###########################################################################
|
|
|
|
# https://cmake-format.readthedocs.io/en/latest/cmake-lint.html
|
|
# https://cmake-format.readthedocs.io/en/latest/lint-usage.html
|
|
# https://github.com/cheshirekow/cmake_format/blob/master/cmakelang/configuration.py
|
|
|
|
# Run cmakelint on the curl source code. It checks all files given on the
|
|
# command-line, or else all relevant files in git, or if not in a git
|
|
# repository, all files starting in the tree rooted in the current directory.
|
|
#
|
|
# cmake-lint can be installed from PyPi with the command "python3 -m pip
|
|
# install cmakelang".
|
|
#
|
|
# The xargs invocation is portable, but does not preserve spaces in filenames.
|
|
# If such a file is ever added, then this can be portably fixed by switching to
|
|
# "xargs -I{}" and appending {} to the end of the xargs arguments (which calls
|
|
# cmakelint once per file) or by using the GNU extension "xargs -d'\n'".
|
|
|
|
set -eu
|
|
|
|
cd "$(dirname "$0")"/..
|
|
|
|
{
|
|
if [ -n "${1:-}" ]; then
|
|
for A in "$@"; do printf '%s\n' "$A"; done
|
|
elif git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
|
|
git ls-files '**CMakeLists.txt' '*.cmake'
|
|
else
|
|
find . -type f \( -name 'CMakeLists.txt' -o -name '*.cmake' \)
|
|
fi
|
|
} | sort | xargs \
|
|
cmake-lint \
|
|
--suppress-decorations \
|
|
--disable \
|
|
--line-width 132 \
|
|
--tab-size 2 \
|
|
--use-tabchars false \
|
|
--disabled-codes C0113 \
|
|
--function-pattern 'curl_[0-9a-z_]+' \
|
|
--macro-pattern '(curl_[0-9a-z_]+|check_include_file_concat_curl)' \
|
|
--global-var-pattern '[A-Z][0-9A-Z_]+' \
|
|
--internal-var-pattern '_[a-z][0-9a-z_]+' \
|
|
--local-var-pattern '_[a-z][0-9a-z_]+' \
|
|
--private-var-pattern '_[0-9a-z_]+' \
|
|
--public-var-pattern '([A-Z][0-9A-Z_]+|[A-Z][A-Za-z0-9]+_FOUND|[a-z]+_SOURCES|prefix|exec_prefix|includedir|libdir|ssize_t|_FILE_OFFSET_BITS)' \
|
|
--argument-var-pattern '_[a-z][0-9a-z_]+' \
|
|
--keyword-pattern '[A-Z][0-9A-Z_]+' \
|
|
--max-conditionals-custom-parser 2 \
|
|
--min-statement-spacing 1 \
|
|
--max-statement-spacing 2 \
|
|
--max-returns 6 \
|
|
--max-branches 20 \
|
|
--max-arguments 5 \
|
|
--max-localvars 15 \
|
|
--max-statements 95 \
|
|
--
|