Skip to content

KLL: document that the updatable form's empty and single-item flags may be stale - #815

Open
leerho wants to merge 1 commit into
mainfrom
kll-updatable-flags-doc
Open

leerho wants to merge 1 commit into
mainfrom
kll-updatable-flags-doc

Conversation

@leerho

@leerho leerho commented Nov 22, 2026

Copy link
Copy Markdown
Member

Javadoc only, in KllPreambleUtil's description of the UPDATABLE structure.

The empty and single-item flags are set when an updatable image is written, but a sketch updated in place never changes them. On a direct sketch, the empty flag stays set after an update to n = 1, and the single-item bit stays clear. Nothing depends on them: KllMemorySegmentValidate checks the flags only for the compact structures, and isEmpty() uses N. The comment now says so, and that this structure is Java-only.

Also in the same bullet: the structure is used for any n, including an empty sketch (the old text said n > 1), and a doubled period is fixed.

No code change. javac -Xlint:all -Xdoclint:all,-missing reports nothing for the file.

🤖 Generated with Claude Code

…ay be stale

Readers of the updatable structure use N. The structure is Java-only.
Also fixes the bullet's n > 1, since an empty updatable image exists.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant