docs(overlay): document the new: intent directive#914
Open
SoundMatt wants to merge 1 commit into
Open
Conversation
5 tasks
Collaborator
|
@SoundMatt - minor conflict after I merged the other PR, could you resolve |
SoundMatt
force-pushed
the
docs/overlay-new-directive
branch
from
7ef393e to
85153f2
Compare
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Matt Jones <47545907+SoundMatt@users.noreply.github.com>
SoundMatt
force-pushed
the
docs/overlay-new-directive
branch
from
85153f2 to
f7da336
Compare
Contributor
Author
|
Updated to match the naming decision from the maintainer meeting: the attribute has been renamed from
The companion vss-tools#527 PR has been updated with the same rename. |
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
2 participants
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
Companion documentation for COVESA/vss-tools#527, which introduces the opt-in
new:attribute for overlay files.new: false— asserts the node already exists in the base spec (modify intent); errors on typos and upstream removalsnew: true— asserts the node does not exist in the base spec (create intent); errors on future naming collisionsNew section added between "Node content in Overlays" and "Deleting nodes" in
docs-gen/content/extensions/overlay.md.Test plan