base-layer/configkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Accept main terminology for provenance

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-27 14:26:54 +00:00
parent e9155fced6
commit 1ee508ba02
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/roadmap/audit.md
View File

@@ -1,7 +1,7 @@
# Additional Public API Review
Reviewed revision: `3ebb848eadf6e61275ecec6e35838ad6576cdd3a`.
Status: N1 accepted; N2–N6 remain discussion findings. Implementation has not begun.
Status: N1–N2 accepted; N3–N6 remain discussion findings. Implementation has not begun.
## Scope And Assessment
@@ -12,7 +12,7 @@ It covers loading/discovery, source and resource ownership, paths and collection
registration, callbacks, inspection/diffs, secrets, and diagnostics. It does not
repeat the symbol inventory or conduct a correctness/performance audit.
[api.md](api.md) owns the accepted D1–D8, A1, and N1 changes. Those decisions remain
[api.md](api.md) owns the accepted D1–D8, A1, and N1–N2 changes. Those decisions remain
settled; public path comparison (A2) remains deferred. The findings here are
additional opportunities, including consequences of the accepted cleanup.
@@ -24,15 +24,15 @@ obsolete input-error category, and a missing convenience on failed loads.
| Finding | Recommendation | Compatibility impact if accepted |
| --- | --- | --- |
| N1: discovery `Paths` (accepted) | Rename to `SearchPaths`; decision recorded in [api.md](api.md). | Go function rename. |
| N2: main-tier provenance | Rename `LayerBase` to `LayerMain`, with value `"main"`. | Go constant rename and observable string change. |
| N2: main-tier provenance (accepted) | Rename `LayerBase` to `LayerMain`, with value `"main"`; decision recorded in [api.md](api.md). | Go constant rename and observable string change. |
| N3: shared-history quota | Rename `CodeExplainLimitExceeded` to `CodeHistoryLimitExceeded`, with value `"history.limit_exceeded"`. | Go constant rename and machine-readable code change. |
| N4: recording-kind diagnostic | Retire `CodeResolveInvalidKind` if D6 removes its public trigger. | Conditional constant removal. |
| N5: failed-load source lookup | Add `LoadError.Source(id)` alongside accepted A1. | Compatible addition. |
| N6: import-default field names | Consider `FollowSymlinks` and `IncludeHidden`; lower priority. | Go field renames; YAML keys unchanged. |
These are design recommendations, not defect severities or additional release
gates. In particular, N2 and N3 require deliberate approval of their string-value
changes; accepting other naming cleanup does not authorize them automatically.
gates. N2's string-value change is accepted. N3's code-string change still requires
deliberate approval; accepting other naming cleanup does not authorize it.
## N1. Distinguish Discovery Paths From Semantic Paths
@@ -60,6 +60,9 @@ although it is less consistent with `SearchDirectory`.
## N2. Use Main Consistently In Provenance
Status: accepted, including the string-value change. [api.md](api.md) owns the
selected change; the discussion below preserves its rationale and alternatives.
Evidence: `LoadLayered(main, ...)`, `SourceInfo.UnderlayIndex`, the configuration
contract, and the accepted `SourceVersionModeMainOnly` name distinguish main input
from lower-priority underlays. [records.go](../../records.go) instead exposes