docs, comments: describe downstream consumers by capability - #538
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
What changed
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)veh_index.NAV_STATS.mdcovers the same per-vehicle signals but no longer depends on a specific scenario.drive.h,sim_world.h,material.h,drive.cpp,sim_world.cpp,NAV_VEHICLE.md,NAV_MATERIAL.md): the examples of anext_forceare now neutral.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(): theprovenancetext now names the 13-class palette. No test or reader parses this field.nav_material_raster_testchecks onlyschema."app", both in the header docs and inasync_lane_test. One test case is renamed toProcessChrootedToAppReceivesCrossThreadHashPoststo match. Nothing else referred to its old name.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.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. Thedeps/share/cvc-scenes,share/cvc-scenesand in-treescenes/fallbacks remain, and those cover every public layout: the Pages and wasm publish workflows andcvcgl-examples/build-wasm.shall resolveshare/cvc-scenes/austin_south.--bundleand$CVC_NAV_BUNDLEare unchanged.--bundle, started from a directory next to such a checkout, now gets the synthetic city instead of the Austin scene. Pass--bundleor set$CVC_NAV_BUNDLEto get Austin. No CI, wasm or recipe path used the dropped probes.cvcpkg/recipes/{cvcgl,libcvc}/recipe.yaml,.github/workflows/publish-cvcgl-wasm.yml,CMake/cvcConfig.cmake.in): same rewording. A comment-only recipe edit needs nocvc_revisionbump:upstream_version.publish-cvcpkgcomputes the next revision itself.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'svisible_when,on_changeand tiled-layout examples now use the public nav demos'sim.fogstate and a genericstats_panelinclude. Its §12.1load:example mountspanels/stats_panel.ariasstats, so it matches the tiled-layout example in §3.9. The matchinginc/cvc/ariadne/widget.hcomments (the mount-scope example and thewith_text_colorexample) use the same generic names.Not in this PR
publish-cvcpkg.ymlis reworded by open PR publish-cvcpkg: fix the pycvc-gl opt-in lanes (CUDA -lX11, Windows imgui export) #531, which this branch cannot repeat without a conflict: publish-cvcpkg: fix the pycvc-gl opt-in lanes (CUDA -lX11, Windows imgui export) #531 also edits the adjacent lines. This branch leaves that file alone. Until publish-cvcpkg: fix the pycvc-gl opt-in lanes (CUDA -lX11, Windows imgui export) #531 merges, that comment keeps its old wording. See Merge order.rf_materialfield, the RF slots in the L-system registry, and theincludes.rfmount in the Ariadne tests.Verification
publish-cvcpkg.ymlcomment that open PR publish-cvcpkg: fix the pycvc-gl opt-in lanes (CUDA -lX11, Windows imgui export) #531 rewords.git clang-format(clang-format 18) is clean on the changed lines.yaml.safe_load.bindings/pycvc/pymod_gl/scenes.pypassespy_compile.CVC_BUILD_CVCGL=ON CVC_BUILD_EXAMPLES=ON CVC_BUILD_TESTS=ON.cvcConfig.cmakeis byte-identical to the one in a working installed bundle, apart from the reworded comment. A small consumer project'sfind_package(cvc CONFIG)loads it cleanly.-fsyntax-only.async_lane_test,nav_stats_test,nav_material_deploy_test,world_surface_testandnav_material_raster_test(20 + 9 + 14 + 7 + 4 cases), plusariadne_loader_testandariadne_runtime_test(160 + 119 cases) after thewidget.hcomment edit. All pass.nav_city_driveandnav_city_swarmbuild and link cleanly at the branch head (full build, not only-fsyntax-only).master, with publish-cvcpkg: fix the pycvc-gl opt-in lanes (CUDA -lX11, Windows imgui export) #531, and with publish-cvcpkg: fix the pycvc-gl opt-in lanes (CUDA -lX11, Windows imgui export) #531 + cvcGL: fast-draw low-memory mapper (~2/3 fewer GL calls per frame on WebGL2) + reship cvc.16 #522 + cvcGL tests: GL tests hold one resource lock; shadow_casters D prints its macOS numbers #529 together.Merge order
publish-cvcpkg.yml, which this PR leaves to it.include/cvc/andlib/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.