Skip to content

Condense the fork's Vulkan comments for upstream readability - #73

Merged
brianmk merged 1 commit into
coin-Integratefrom
chore/condense-fork-comments
Sep 30, 2026
Merged

brianmk merged 1 commit into
coin-Integratefrom
chore/condense-fork-comments

Conversation

@brianmk

@brianmk brianmk commented Sep 30, 2026

Copy link
Copy Markdown
Owner

Summary

Summarizes the comment blocks this fork added over upstream FreeCAD/coin (the Vulkan renderer, retained-IR path, and GL glue) to make the diff easier to upstream.

  • Comment lines added vs upstream: 4,248 → 2,187 (2,061 fewer, ~48.5%)
  • 77 files changed, +1,909 / −4,325 vs coin-Integrate
  • Scope: only comments introduced by this fork (base merge-base 5a4d2856); upstream-original comments untouched.

What is kept

Comment-only rewrite; the important information is preserved:

  • invariants, lifetime / thread-safety / ordering contracts
  • performance rationale and measured costs
  • API contracts, magic numbers + meaning, env-var / flag names
  • cross-references (files, functions, VUIDs)

Dropped: filler, hedging, repetition, and restatement of the obvious code.

Verification

Comment-stripped code is byte-identical to coin-Integrate in every modified file (strip // and /* */, compare with whitespace collapsed → 0 differing files).

Left deliberately unchanged in ~25 files: license/copyright headers, the generated *.spv.h DXC banners, and already-minimal one-line comments.

Largest reductions

file before after
src/rendering/SoVulkanRenderManager.cpp 639 317
src/rendering/SoVulkanRenderBackend.h 565 270
.../SoVulkanRenderBackendFrame.cpp 304 147
.../SoVulkanRenderBackendCommand.cpp 189 91
.../SoVulkanRenderBackendWideLine.cpp 188 95

Summarize the comment blocks this fork added over FreeCAD/coin (Vulkan
renderer, IR, GL glue): keep invariants, lifetime/thread-safety and
ordering contracts, perf rationale, API contracts, magic numbers and
cross-references; drop filler and restatement.  Comment-only change:
comment-stripped code is byte-identical to coin-Integrate.
@brianmk
brianmk merged commit cda6723 into coin-Integrate Sep 30, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant