Rename the "clean pipeline" to "Slipstream pipeline" (files, classes, shaders, flags, log tags) #576

New issue

Open

opened 2026-10-09 00:41:32 +00:00 by sky_line · 0 comments

sky_line commented

2026-10-09 00:41:32 +00:00

Owner

Scope (measured on vulkan-port-tb, 2026-10-08)

Files: 53 indra/newview/llclean* sources, plus the indra/vkclean/ directory (169 files, including 116 clean_* shaders).
Classes: 28 LLClean* names, e.g. LLCleanRendererVK, LLCleanIngest, LLCleanInstanceStore, LLCleanMaterialStore.
Build flag: LL_HAS_CLEAN_PIPELINE, about 221 uses.
Log tags: about 16 containing "Clean" (Clean29Ingest, CleanParticle, …).
Settings: 4 containing "Clean" (e.g. RenderCleanSweepSlice).
Other: variables, functions and comments.

Proposed naming

Prefix: LLClean* → SLPipe* or SLRender*; pick one short prefix in the first commit and stick to it. Files llclean*.cpp → slpipe*.cpp, indra/vkclean → indra/slpipe, shaders clean_*.glsl → slp_*.glsl.
Build flag: LL_HAS_CLEAN_PIPELINE → remove it if it's always on, otherwise SL_HAS_PIPELINE.

Rules

Do it mechanically, in one dedicated change, done when no other big branches are in flight. It touches nearly every renderer file and will conflict with everything open.
Order:
1. git mv the files, so history is preserved through renames.
2. Rename the identifiers with a scripted, word-boundary-aware replace.
3. Rebuild, and regenerate the SPIR-V header (regen_world_spv.py paths and vk_world_shaders_spv.h symbol names).
Settings: keep compatibility for user-facing names. Renamed settings need a migration (read the old key once, copy it to the new one), or keep the old names, since users and docs reference them.
Log tags: check that support docs and memories (e.g. Clean29Ingest, VKIngestDiag) are updated to match.
Leave LL's own names alone: cleanup, cleanDeadObjects, cleanupClass, etc.
No behaviour change: build, launch and log in before and after; the logs should match apart from tag names.

Rename the internal "clean pipeline" naming to "Slipstream pipeline" so the codebase says what it is. "Clean" was the working name for the GPU-driven rewrite. It's now the only renderer, and the word is ambiguous: it collides with LL's `cleanup()`/`cleanDeadObjects()` and similar names. ## Scope (measured on vulkan-port-tb, 2026-10-08) - **Files:** 53 `indra/newview/llclean*` sources, plus the `indra/vkclean/` directory (169 files, including 116 `clean_*` shaders). - **Classes:** 28 `LLClean*` names, e.g. `LLCleanRendererVK`, `LLCleanIngest`, `LLCleanInstanceStore`, `LLCleanMaterialStore`. - **Build flag:** `LL_HAS_CLEAN_PIPELINE`, about 221 uses. - **Log tags:** about 16 containing "Clean" (`Clean29Ingest`, `CleanParticle`, …). - **Settings:** 4 containing "Clean" (e.g. `RenderCleanSweepSlice`). - **Other:** variables, functions and comments. ## Proposed naming - **Prefix:** `LLClean*` → `SLPipe*` or `SLRender*`; pick one short prefix in the first commit and stick to it. Files `llclean*.cpp` → `slpipe*.cpp`, `indra/vkclean` → `indra/slpipe`, shaders `clean_*.glsl` → `slp_*.glsl`. - **Build flag:** `LL_HAS_CLEAN_PIPELINE` → remove it if it's always on, otherwise `SL_HAS_PIPELINE`. ## Rules - **Do it mechanically, in one dedicated change**, done when no other big branches are in flight. It touches nearly every renderer file and will conflict with everything open. - **Order:** 1. `git mv` the files, so history is preserved through renames. 2. Rename the identifiers with a scripted, word-boundary-aware replace. 3. Rebuild, and regenerate the SPIR-V header (`regen_world_spv.py` paths and `vk_world_shaders_spv.h` symbol names). - **Settings:** keep compatibility for user-facing names. Renamed settings need a migration (read the old key once, copy it to the new one), or keep the old names, since users and docs reference them. - **Log tags:** check that support docs and memories (e.g. `Clean29Ingest`, `VKIngestDiag`) are updated to match. - **Leave LL's own names alone:** `cleanup`, `cleanDeadObjects`, `cleanupClass`, etc. - **No behaviour change:** build, launch and log in before and after; the logs should match apart from tag names.

sky_line added the

triage

label

2026-10-09 00:41:32 +00:00

sky_line added this to the Slipstream project

2026-10-09 00:41:32 +00:00

sky_line added

priority

low

and removed

triage

labels