Skip to content

Commit ab93c9d

Browse files
nickolas122claude
andcommitted
Move the fork's engineering notes out of the root and into docs/fork
Ten working notes had accumulated at the top level, where they outnumbered the files a visitor actually wants and sat among upstream's own root documents with nothing to say which was which. Git records them as renames, so the history of each one follows it. Their cross-references are relative and the whole set moved together, so those still resolve; the two mentions from outside - .gitignore and two workflow comments - are updated. docs/fork/README.md indexes them by subject, because a folder of ten shouting filenames is not much better than a root of ten. FORK.md stays at the root deliberately. It is the fork's front door, README links it, and the release notes of every published release carry an absolute URL to it - moving it would break those permanently. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 6bf5e79 commit ab93c9d

14 files changed

Lines changed: 41 additions & 3 deletions

.github/workflows/main.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ jobs:
245245
# fails under mingw and Win32 is selected by accident. Asking for it
246246
# explicitly means a future toolchain that happens to pass the test
247247
# cannot silently switch backends and discard the patches applied above.
248-
# See WINDOWS-WINRT-PHASE0.md.
248+
# See docs/fork/WINDOWS-WINRT-PHASE0.md.
249249
qmake -r -- -feature-native-win32-bluetooth
250250
make -j8
251251
cd ../..
@@ -503,7 +503,7 @@ jobs:
503503
# Qt ships a working WinRT Bluetooth backend only for MSVC: QT_FEATURE_winrt_bt
504504
# is 1 in the msvc2022 package and -1 in every mingw one (6.8.2, 6.9.3, 6.10.3
505505
# and llvm-mingw alike), where you get qlowenergycontroller_dummy.cpp instead.
506-
# WINDOWS-QT6-PHASE1.md has the measurements and why building it under mingw is
506+
# docs/fork/WINDOWS-QT6-PHASE1.md has the measurements and why building it under mingw is
507507
# a fork of Qt rather than a build of it.
508508
#
509509
# window-build stays on mingw + Qt 5.15.2 until this one has been proven against

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ src/Makefile
66
src/.qmake.stash
77

88
# Building from the repository root - which is what the linux-x86-build job does,
9-
# and what BUILDING-ON-WINDOWS.md describes for a local build - runs qmake on the
9+
# and what docs/fork/BUILDING-ON-WINDOWS.md describes for a local build - runs qmake on the
1010
# subdirs project and generates these as well. Anchored to the root so the tracked
1111
# src/ios/adb/libzipfile/Makefile.{am,in} are untouched.
1212
/Makefile

FORK.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,11 @@ shifting.
115115
longer clobbers the static library, qthttpserver builds without a native perl,
116116
`aqtinstall` is pinned, and SmtpClient is pinned to a commit that exists.
117117

118+
## Why, in detail
119+
120+
The working notes behind these changes — measurements, dead ends, and the things that
121+
turned out not to be the cause — are in [docs/fork/](docs/fork/).
122+
118123
## Versioning
119124

120125
Releases are tagged `v<upstream base>-qz.<n>` — for example `v2.21.6-qz.1`, meaning the
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/fork/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Fork engineering notes
2+
3+
Working notes written while making the changes listed in [FORK.md](../../FORK.md). They
4+
are a record of *why* — what was measured, what was ruled out, what turned out to be
5+
wrong — not user documentation. Upstream's docs are in the folder above.
6+
7+
They are kept because the expensive part of this work was the evidence, and a note that
8+
says "this was tested and it is not the cause" is worth more later than the fix itself.
9+
10+
## Windows Bluetooth: the move to WinRT
11+
12+
| | |
13+
| --- | --- |
14+
| [WINDOWS-WINRT-PHASE0.md](WINDOWS-WINRT-PHASE0.md) | The case for moving off the Qt 5 Bluetooth path, and where the original argument for it did not survive contact with the source. |
15+
| [WINDOWS-WINRT-BACKEND.md](WINDOWS-WINRT-BACKEND.md) | The plan for the backend swap. |
16+
| [WINDOWS-BLE-HARDENING.md](WINDOWS-BLE-HARDENING.md) | Reconnect behaviour, service subscription, and the bond-cache problem that stopped the trainer working unpaired. |
17+
18+
## Windows on Qt 6
19+
20+
| | |
21+
| --- | --- |
22+
| [WINDOWS-QT6-PLAN.md](WINDOWS-QT6-PLAN.md) | The route to Qt 6 and the questions that decided its shape. |
23+
| [WINDOWS-QT6-PHASE1.md](WINDOWS-QT6-PHASE1.md) | Toolchain measurements — why mingw loses and MSVC 2022 wins. |
24+
| [WINDOWS-QT6-PHASE4.md](WINDOWS-QT6-PHASE4.md) | The result, including a prediction from Phase 0 that the bike disproved. |
25+
| [BUILDING-ON-WINDOWS.md](BUILDING-ON-WINDOWS.md) | How a Windows build of this fork is actually obtained, and the traps worth naming. |
26+
27+
## Devices and training apps
28+
29+
| | |
30+
| --- | --- |
31+
| [DIRCON-SERVER-REFACTOR.md](DIRCON-SERVER-REFACTOR.md) | Why the DIRCON endpoint had to outlive the bike, and the refactor that gave it process lifetime. |
32+
| [AUTO-ERG-MODE.md](AUTO-ERG-MODE.md) | The automatic ERG detector, parked, with an honest account of why. |
33+
| [PLANO-MEGAGYM-EXECUCAO.md](PLANO-MEGAGYM-EXECUCAO.md) | Notes in Portuguese, from making the bike report the effort the rider actually made. |
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)