mirror of
https://github.com/open-goal/jak-project
synced 2026-08-06 09:54:10 -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)
198 lines
5.5 KiB
Perl
Vendored
Generated
198 lines
5.5 KiB
Perl
Vendored
Generated
#!/usr/bin/env perl
|
|
#***************************************************************************
|
|
# _ _ ____ _
|
|
# Project ___| | | | _ \| |
|
|
# / __| | | | |_) | |
|
|
# | (__| |_| | _ <| |___
|
|
# \___|\___/|_| \_\_____|
|
|
#
|
|
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, 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
|
|
#
|
|
###########################################################################
|
|
|
|
=begin comment
|
|
|
|
This script converts an nroff file to curldown
|
|
|
|
Example: cd2nroff [options] <file.md> > <file.3>
|
|
|
|
Note: when converting .nf sections, this tool does not know if the
|
|
section is code or regular quotes. It then assumes and uses ~~~c
|
|
for code.
|
|
|
|
=end comment
|
|
=cut
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
my $nroff2cd = "0.1"; # to keep check
|
|
|
|
sub single {
|
|
my ($f) = @_;
|
|
open(F, "<:crlf", $f) or
|
|
return 1;
|
|
my $line;
|
|
my $title;
|
|
my $section;
|
|
my $source;
|
|
my @seealso;
|
|
my @desc;
|
|
my $header; # non-zero when TH is passed
|
|
my $quote = 0; # quote state
|
|
while(<F>) {
|
|
$line++;
|
|
my $d = $_;
|
|
if($_ =~ /^.\\\"/) {
|
|
# a comment we can ignore
|
|
next;
|
|
}
|
|
if(!$header) {
|
|
if($d =~ /.so (.*)/) {
|
|
# this is basically an include, so do that
|
|
my $f = $1;
|
|
# remove leading directory
|
|
$f =~ s/(.*?\/)//;
|
|
close(F);
|
|
open(F, "<:crlf", $f) or return 1;
|
|
}
|
|
if($d =~ /^\.TH ([^ ]*) (\d) \"(.*?)\" ([^ \n]*)/) {
|
|
# header, this needs to be the first thing after leading comments
|
|
$title = $1;
|
|
$section = $2;
|
|
# date is $3
|
|
$source = $4;
|
|
# if there are enclosing quotes around source, remove them
|
|
$source =~ s/[\"\'](.*)[\"\']\z/$1/;
|
|
$header = 1;
|
|
|
|
print <<HEAD
|
|
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel\@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: $title
|
|
Section: $section
|
|
Source: $source
|
|
HEAD
|
|
;
|
|
}
|
|
next;
|
|
}
|
|
|
|
if($quote) {
|
|
if($d =~ /^\.SH/) {
|
|
#end of quote without an .fi
|
|
$quote = 0;
|
|
push @desc, "~~~\n";
|
|
}
|
|
elsif($d =~ /^\.fi/) {
|
|
#end of quote
|
|
$quote = 0;
|
|
push @desc, "~~~\n";
|
|
next;
|
|
}
|
|
else {
|
|
# double-backslashes converted to single ones
|
|
$d =~ s/\\\\/\\/g;
|
|
push @desc, $d;
|
|
next;
|
|
}
|
|
}
|
|
if($d =~ /^\.SH (.*)/) {
|
|
my $word = $1;
|
|
# if there are enclosing quotes, remove them first
|
|
$word =~ s/[\"\'](.*)[\"\']\z/$1/;
|
|
if($word eq "SEE ALSO") {
|
|
# we slurp up this section
|
|
next;
|
|
}
|
|
push @desc, "\n# $word\n\n";
|
|
}
|
|
elsif($d =~ /^\.(RS|RE)/) {
|
|
# ignore these
|
|
}
|
|
elsif($d =~ /^\.IP (.*)/) {
|
|
my $word = $1;
|
|
# if there are enclosing quotes, remove them first
|
|
$word =~ s/[\"\'](.*)[\"\']\z/$1/;
|
|
push @desc, "\n## $word\n\n";
|
|
}
|
|
elsif($d =~ /^\.IP/) {
|
|
# .IP with no text we skip
|
|
}
|
|
elsif($d =~ /^\.BR (.*)/) {
|
|
# only used for SEE ALSO
|
|
my $word = $1;
|
|
# remove trailing comma
|
|
$word =~ s/,\z//;
|
|
|
|
for my $s (split(/,/, $word)) {
|
|
# remove all double quotes
|
|
$s =~ s/\"//g;
|
|
# tream leading whitespace
|
|
$s =~ s/^ +//g;
|
|
push @seealso, $s;
|
|
}
|
|
}
|
|
elsif($d =~ /^\.I (.*)/) {
|
|
push @desc, "*$1*\n";
|
|
}
|
|
elsif($d =~ /^\.B (.*)/) {
|
|
push @desc, "**$1**\n";
|
|
}
|
|
elsif($d =~ /^\.nf/) {
|
|
push @desc, "~~~c\n";
|
|
$quote = 1;
|
|
}
|
|
else {
|
|
# embolden
|
|
$d =~ s/\\fB(.*?)\\fP/**$1**/g;
|
|
# links to "curl.*()" are left bare since cd2nroff handles them
|
|
# specially
|
|
$d =~ s/\\fI(curl.*?\(3\))\\fP/$1/ig;
|
|
# emphasize
|
|
$d =~ s/\\fI(.*?)\\fP/*$1*/g;
|
|
# emphasize on a split line
|
|
$d =~ s/\\fI/*/g;
|
|
# bold on a split line
|
|
$d =~ s/\\fB/**/g;
|
|
# remove backslash amp
|
|
$d =~ s/\\&//g;
|
|
# remove backslashes
|
|
$d =~ s/\\//g;
|
|
# fix single quotes
|
|
$d =~ s/\(aq/'/g;
|
|
# fix double quotes
|
|
$d =~ s/\(dq/\"/g;
|
|
push @desc, $d;
|
|
}
|
|
}
|
|
close(F);
|
|
|
|
print "See-also:\n";
|
|
for my $s (sort @seealso) {
|
|
print " - $s\n" if($s);
|
|
}
|
|
print "---\n";
|
|
print @desc;
|
|
|
|
return !$header;
|
|
}
|
|
|
|
if(@ARGV) {
|
|
exit single($ARGV[0]);
|
|
}
|