Skip to content

docs, comments: describe downstream consumers by capability - #538

Merged
transfix merged 5 commits into
masterfrom
docs/consumer-neutral-comments
Oct 2, 2026
Merged

transfix merged 5 commits into
masterfrom
docs/consumer-neutral-comments

Conversation

@transfix

@transfix transfix commented Oct 2, 2026

Copy link
Copy Markdown
Owner

Summary

Rewords comments, docs and a few test/example strings that referred to downstream consumers by name, so they describe those consumers by capability instead: a WebGL2 app with heavy per-frame overlays, a wasm app that installs the catalog bundles, or an extension layer on top of nav_stats. Profile figures that were not measured on a libcvc gallery demo are now stated qualitatively.

Almost all of it is comment or doc text. The exceptions are a few renamed test literals, one provenance string, and two dropped bundle-autodetect paths in the Austin nav demos. The autodetect change is the only behaviour change, so it has its own commit and can be reverted by itself. Three commits:

  1. docs, comments: describe downstream consumers by capability
  2. nav demos: drop the sibling-checkout bundle autodetect paths (behaviour change, see below)
  3. docs: drop workstation-local paths from the roadmaps

What changed

  • nav_stats (docs/NAV_STATS.md, docs/roadmap/NAV-STATS-INTRINSIC-ROADMAP.md, inc/cvc/nav/nav_stats.h, inc/cvc/gl/nav_stats_publish.h, src/cvcGL/nav_stats_publish.cpp)
    • The design is now described as two layers: a domain-neutral core, and an extension seam where a downstream layer keeps its own record, joined by veh_index.
    • The roadmap keeps the libcvc and grl-snam tracks and describes the extension track generically.
    • Track 3b-2 is now marked merged (cvcGL: belief/fog raster bridge for realtime nav-stats viz (Track 3b-2) #426).
    • The arrival-debugging guidance in NAV_STATS.md covers the same per-vehicle signals but no longer depends on a specific scenario.
  • External-force comments (drive.h, sim_world.h, material.h, drive.cpp, sim_world.cpp, NAV_VEHICLE.md, NAV_MATERIAL.md): the examples of an ext_force are now neutral.
  • Material vocabulary seam (world/surface.h, world/surface.cpp, lsys/interp.h, nav/material_raster.h, world_surface_test.cpp): these comments now describe a consumer keyed on the shared physical-material names.
  • material_raster::to_json(): the provenance text now names the 13-class palette. No test or reader parses this field. nav_material_raster_test checks only schema.
  • async_lane: the example chroot and channel prefix is now "app", both in the header docs and in async_lane_test. One test case is renamed to ProcessChrootedToAppReceivesCrossThreadHashPosts to match. Nothing else referred to its old name.
  • cvcGL (CameraController.cpp, Viewport.h, ViewportManager.h, DrapedLinkNode.h, the cvcgl test headers, nav_city_drive / nav_city_swarm / terrain_lab): same rewording. Per-frame costs are now stated qualitatively.
  • Austin nav demo bundle autodetect (nav_city_drive.cpp, nav_city_swarm.cpp, commit 2): the native fallback probes no longer include two dev-checkout paths into a sibling repository. The deps/share/cvc-scenes, share/cvc-scenes and in-tree scenes/ fallbacks remain, and those cover every public layout: the Pages and wasm publish workflows and cvcgl-examples/build-wasm.sh all resolve share/cvc-scenes/austin_south. --bundle and $CVC_NAV_BUNDLE are unchanged.
    • Behaviour change: a native run with no --bundle, started from a directory next to such a checkout, now gets the synthetic city instead of the Austin scene. Pass --bundle or set $CVC_NAV_BUNDLE to get Austin. No CI, wasm or recipe path used the dropped probes.
  • Packaging comments (cvcpkg/recipes/{cvcgl,libcvc}/recipe.yaml, .github/workflows/publish-cvcgl-wasm.yml, CMake/cvcConfig.cmake.in): same rewording. A comment-only recipe edit needs no cvc_revision bump:
    • The CI recipe check compares only upstream_version.
    • publish-cvcpkg computes the next revision itself.
    • Packed bundles embed their recipe directory, so the new text reaches the catalog at the next publish of each package.
  • Docs (STATE_LIFETIME_AND_ATOMICITY.md, RENDER_PERF_ROADMAP.md, CVCGL-UI-DSL-ROADMAP.md): example names and asset lists are now generic. The DSL roadmap's visible_when, on_change and tiled-layout examples now use the public nav demos' sim.fog state and a generic stats_panel include. Its §12.1 load: example mounts panels/stats_panel.ari as stats, so it matches the tiled-layout example in §3.9. The matching inc/cvc/ariadne/widget.h comments (the mount-scope example and the with_text_color example) use the same generic names.
  • Third commit: replaces absolute paths into a developer checkout with repo-relative names in four roadmap docs.

Not in this PR

Verification

Merge order

  • publish-cvcpkg: fix the pycvc-gl opt-in lanes (CUDA -lX11, Windows imgui export) #531: land it with or before this PR. It carries the matching rewording of the imgui comment in publish-cvcpkg.yml, which this PR leaves to it.
  • Next publish: the libcvc and cvcgl bundles ship include/cvc/ and lib/cmake/cvc/, and published variants are immutable. Land this before the next libcvc/cvcgl publish so the new variants carry the reworded headers and package config.

Reword comments, docs and a few test/example strings that referred to
downstream consumers by name, so they describe them by what they need
instead: a WebGL2 app with heavy per-frame overlays, a wasm app that
installs the catalog bundles, an extension layer on top of nav_stats.
Profile figures that were not measured on a libcvc demo are restated
qualitatively.

- nav_stats (NAV_STATS.md, the intrinsic-stats roadmap, nav_stats.h and
  its publisher): describe the two-layer design as a domain-neutral core
  plus an extension seam joined by veh_index.
- ext_force / *_material_ext comments and NAV_VEHICLE.md /
  NAV_MATERIAL.md: neutral examples of an external force.
- async_lane: the example chroot and channel prefix is now "app" (header
  docs and async_lane_test; one test case renamed to match).
- material_raster::to_json(): the provenance text names the 13-class
  palette instead of an external table.
- CVCGL-UI-DSL-ROADMAP.md: the DSL examples bind the public nav demos'
  sim.fog state, and the section 12.1 load: example (with the matching
  ariadne/widget.h comments) mounts a generic stats panel.
- cvcGL comments, cvcgl tests, nav demos, recipe and workflow comments:
  same rewording.

No functional change beyond the renamed test literals and the
provenance string.
nav_city_drive and nav_city_swarm probed two dev-checkout paths into a
sibling repository when no --bundle was given. Drop them. The demos now
fall back to deps/share/cvc-scenes, share/cvc-scenes and the in-tree
scenes/ directory, which cover every published layout: the Pages and
wasm publish workflows and cvcgl-examples/build-wasm.sh all resolve
share/cvc-scenes/austin_south. --bundle and $CVC_NAV_BUNDLE are
unchanged.

Behaviour change: a native run with no --bundle from a directory next
to such a checkout now gets the synthetic city instead of the Austin
scene. Pass --bundle or set $CVC_NAV_BUNDLE to keep the old result.
Replace absolute paths into one developer's checkout (worktrees, a
sibling repo, a deps prefix) with repo-relative names, and refer to the
externally maintained volrover3 roadmap by its file name.
Conflicts (comment-only) resolved by taking master's neutral wording in nav/material.h and keeping this branch's neutral wording in nav_material_deploy_test.cpp.
@transfix
transfix merged commit 85fa008 into master Oct 2, 2026
13 checks passed
transfix added a commit that referenced this pull request Oct 2, 2026
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