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

1
docs/roadmap/api.md
View File

@@ -24,6 +24,7 @@ as well.
| D8 | Remove `CodeOptionsUnavailable` after confirming there is no intentional supported role. Do not introduce a failure merely to give the code a producer; a concrete reason to retain it should be brought back for discussion. | | D8 | Remove `CodeOptionsUnavailable` after confirming there is no intentional supported role. Do not introduce a failure merely to give the code a producer; a concrete reason to retain it should be brought back for discussion. |
| A1 | Add `Result.Source(id)` for direct lookup of acquired-source evidence, alongside ordered `Sources()` enumeration and passive `SourceContext(id)` resource access. | | A1 | Add `Result.Source(id)` for direct lookup of acquired-source evidence, alongside ordered `Sources()` enumeration and passive `SourceContext(id)` resource access. |
| N1 | Rename `Paths(paths ...string) Search` to `SearchPaths(paths ...string) Search`, replacing the old name outright. Preserve literal file candidates, ordering, deferred acquisition, and selection/failure behavior. Leave semantic `Path` APIs and `Searches` unchanged. | | N1 | Rename `Paths(paths ...string) Search` to `SearchPaths(paths ...string) Search`, replacing the old name outright. Preserve literal file candidates, ordering, deferred acquisition, and selection/failure behavior. Leave semantic `Path` APIs and `Searches` unchanged. |
| N2 | Replace `LayerBase = "base"` with `LayerMain = "main"`, without a compatibility alias. Update Go references and affected string comparisons, serialization, and rendered labels. Preserve the existing main-tier category, imported contributions' owning tiers, precedence, and acquisition order. |
### Recording Methods (D6) ### Recording Methods (D6)

13
docs/roadmap/audit.md
View File

@@ -1,7 +1,7 @@
# Additional Public API Review # Additional Public API Review
Reviewed revision: `3ebb848eadf6e61275ecec6e35838ad6576cdd3a`. 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 ## 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 registration, callbacks, inspection/diffs, secrets, and diagnostics. It does not
repeat the symbol inventory or conduct a correctness/performance audit. 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 settled; public path comparison (A2) remains deferred. The findings here are
additional opportunities, including consequences of the accepted cleanup. 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 | | Finding | Recommendation | Compatibility impact if accepted |
| --- | --- | --- | | --- | --- | --- |
| N1: discovery `Paths` (accepted) | Rename to `SearchPaths`; decision recorded in [api.md](api.md). | Go function rename. | | 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. | | 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. | | 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. | | 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. | | 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 These are design recommendations, not defect severities or additional release
gates. In particular, N2 and N3 require deliberate approval of their string-value gates. N2's string-value change is accepted. N3's code-string change still requires
changes; accepting other naming cleanup does not authorize them automatically. deliberate approval; accepting other naming cleanup does not authorize it.
## N1. Distinguish Discovery Paths From Semantic Paths ## N1. Distinguish Discovery Paths From Semantic Paths
@@ -60,6 +60,9 @@ although it is less consistent with `SearchDirectory`.
## N2. Use Main Consistently In Provenance ## 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 Evidence: `LoadLayered(main, ...)`, `SourceInfo.UnderlayIndex`, the configuration
contract, and the accepted `SourceVersionModeMainOnly` name distinguish main input contract, and the accepted `SourceVersionModeMainOnly` name distinguish main input
from lower-priority underlays. [records.go](../../records.go) instead exposes from lower-priority underlays. [records.go](../../records.go) instead exposes