Skip to content

Correct assembler CLI documentation to describe ELF object output #146

Closed as not planned

Description

@LunaStev

Current evidence

Audit baseline: Whale a254da9e after #131 (2026-09-22). docs/cli/asm.md still says AMD64 is fully supported and that whale asm produces raw .bin data, despite the command writing ObjectFile ELF64 bytes. #24 updated README, leaving this separate CLI page stale.

Whale docs/cli/asm.md

Whale src/commands/asm.rs

Scope

Difficulty: easy.

Update the assembler CLI page to describe relocatable ELF64 output, the supported instruction subset, current architecture limitations, and real output/debug options. Verify examples against the current CLI.

Completion criteria

  • Examples use an object suffix and identify ELF relocatable output.
  • No full-AMD64 or raw-binary capability is claimed.
  • Documented flags and examples match actual help and successful invocations.

Dependencies and boundaries

Backlog index: #12. This issue owns only the bounded work described above. Tests must run without an external assembler dependency.

Suggested start: follow the linked implementation, add the smallest failing regression, then run the affected crate tests and the documented workspace checks.

Activity

  1. added
    bugSomething isn't working
    documentationImprovements or additions to documentation
    cliCommand-line behavior and diagnostics.
    needs testingRequires focused correctness or coverage validation.
    priority mediumNormal development backlog priority.
    on Sep 22, 2026
  2. LunaStev commented on Sep 23, 2026

    @LunaStev
    MemberAuthor

    Superseded by #213 and the decision to keep docs/ out of Git. The referenced docs/cli/asm.md is no longer published; README now describes ELF relocatable object output and current target limitations. The remaining broken contributor-guide links are tracked separately in #214. Closing this obsolete document-specific task without restoring docs/ to Git.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingcliCommand-line behavior and diagnostics.documentationImprovements or additions to documentationgood first issueGood for newcomersneeds testingRequires focused correctness or coverage validation.priority mediumNormal development backlog priority.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions