Skip to content

Document VMMagic Annotations (@Uninterruptible, @Inline) - Value 5 #93

@LSantha

Description

@LSantha

Concept: VMMagic Annotations (@Uninterruptible, @inline)

Value: 5 (Critical - Compiler/runtime guarantees)

What it is: VM-specific annotations for compiler hints and runtime guarantees

Key files:

  • core/src/vmmagic/org/jnode/annotation/Uninterruptible.java
  • core/src/vmmagic/org/jnode/annotation/Inline.java

Bridges: VM Magic, Compiler, Runtime


Documentation Requirements

For Value 5 (Critical):

  1. Update ALL 4 sections of the index (index.md):

    • Pages Table: Add new page in alphabetical order
    • Concepts → Pages: Add the page name. Update any existing entries (e.g., currently mentioned in Code-Conventions.md, VM-Magic.md) to point to new Spoke page
    • Source Path → Pages: Map core/src/vmmagic/ to the new page
    • Task Routing: Add to relevant developer task categories with meaningful routing ideas (1-3 entries)
  2. Update Glossary: Add 1-sentence definition for any new project-specific term

  3. Broader Search: Search for related "Helper", "Manager", "Layout", or "Constants" classes to better catch context

Skill Reference

Use update-wiki skill for wiki maintenance workflow


Related Concepts (from index.md)

  • [[VM-Magic]]
  • [[Code-Conventions]]
  • [[Thread-Scheduling]]
  • [[Core-Thread-Scheduling]]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions