utmapp / utmapp/UTM

Documentation/Dependencies.md points at five paths that no longer exist

Open
#7,852 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Swift
Stars
35.5k
Forks
1.8k
Avg merge
5d 5h
Merged PRs (30d)
7

Description

Every relative link in `Documentation/Dependencies.md` was checked against the repository tree. Five point at paths that are not in the repo any more. One I am confident about; the other four describe a layout I do not know the replacement for, which is why this is an issue rather than a PR.

**Resolvable — happy to send a one-line PR:**

- Line 44 links `../Configuration/UTMQemuConfiguration+ConstantsGenerated.m`. `Configuration/` still exists but that file does not; the generated constants are now `Configuration/QEMUConstantGenerated.swift` (alongside `QEMUConstant.swift`). Same paragraph correctly points at `../scripts/const-gen.py`, which is still there.

**Stale content rather than a moved link — needs your knowledge:**

- Line 32: `../scripts/qapi-gen.py` — `scripts/` currently holds `bridge-gen.sh`, `build_dependencies.sh`, `build_utm.sh`, `const-gen.py`, `install_d3dmetal.sh`, `pack_dependencies.sh`, `package.sh`, `package_mac.sh`, `deb/`, `resources/`. No `qapi-gen.py`.
- Line 40: `../scripts/qapi/` — not present.
- Line 42: `../qapi/` — not present.
- Line 46: `../patches/data` — `patches/` is a flat set of `.patch` files with no `data/` subdirectory, so the instruction to "rename the binary patches directory to the new QEMU version" no longer matches the layout.

A code search across the repo finds `qapi` only in `Documentation/Dependencies.md`, `Documentation/Architecture.md`, `AGENTS.md`, `.agents/skills/utm-review/SKILL.md` and inside `patches/qemu-10.0.12-utm.patch` — so the QAPI generation step looks like it moved into the QEMU fork or into `build_dependencies.sh` rather than being renamed here. `Documentation/Architecture.md` describes the same step, so whatever the answer is, it probably applies to both files.

That matters because these five links are in the "Updating dependencies" runbook — the part someone follows when bumping QEMU, where a wrong path costs real time.

For completeness: the other relative links in that file (`../patches/`, `../patches/sources`, `../.github/workflows/build.yml`) all resolve, and all 56 external URLs across the repository markdown return 200.

I have read the AI contribution guidelines and have followed them to the best of my ability. Disclosure: this was found with AI assistance (Claude Opus 5 in Claude Code); every path above was verified against the GitHub contents API rather than a local checkout, because my working copy was a sparse clone and sparse checkouts produce exactly this kind of false "missing file" result. No device testing applies — nothing here is code.

Contributor guide

Open the contributing guide

Research direction

Start with Documentation/Dependencies.md and compare its updating-dependencies steps with Documentation/Architecture.md. Check build_dependencies.sh and the current patches/ layout to determine where the four stale references belong, then update both documents consistently and verify every relative link resolves.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.