Skip to content

Wiki Update: Create Atomic Spoke Page for Shell 'Syntax' #21

@LSantha

Description

@LSantha

Goal:
JNode's shell uses a robust Syntax system to parse, autocomplete, and validate command-line arguments before a Command is ever executed. We need to extract this into a dedicated atomic Spoke page so agents writing new shell commands understand how to register argument syntaxes.

Agent Execution Checklist:

  • 1. Research: Analyze the code in shell/src/shell/org/jnode/shell/syntax/ (e.g., SyntaxManager, Argument, MuiltipleSyntax). Understand how a syntax XML descriptor binds to a Java Command.
  • 2. Create Spoke Page: Create a new file .wiki/Syntax.md.
    • Strictly follow the WIKI_SCHEMA.md rules (200-500 lines max, atomic focus).
    • Include sections on: Overview, Key Classes, How Argument Parsing Works, and Gotchas (e.g., how tab-completion interacts with syntax).
  • 3. Link from Hub: Open .wiki/Shell-Commands.md (the parent Hub page) and add a brief mention and link to [[Syntax]] in the relevant section.
  • 4. Update Index: Open .wiki/index.md and add a new row to the Concepts → Pages table:
    • Concept: Syntax
    • Defined In: [[Syntax]]
    • Related: [[Shell-Commands]], [[Command]]
  • 5. Commit & Push: Run git add . && git commit -m "Wiki: Add Syntax spoke page" && git push in the .wiki directory.
  • 6. Complete: Close this issue.

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