rust-osdev / rust-osdev/acpi

Make `aml_tester` more ergonomic to use

Open
#142 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
245
Forks
93
Avg merge
2d 8h
Merged PRs (30d)
15

Description

At the moment, aml_tester works, but is pretty janky to use. Some improvements would be:

  • Correctly detect and error when iasl is not installed
  • Use one of those crates that makes panics more readable
  • Color code output
  • Provide summary at the end for each ASL file detected: PASS, COMPILE FAIL, PARSE FAIL
  • Allow testing only one ASL file (CLI -f option?)
  • Provide better control over when output from the parser is logged to console (e.g. only for failing test, separated out, etc.)
  • Provide CLI option to pass a chunk of AML instead (?might be better just adding a test in aml itself tbh)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the aml_tester CLI and its existing handling of iasl, colored output, summaries, and the -f option. Choose one unchecked improvement, such as panic readability or parser-output control, then verify that the selected behavior works for passing and failing ASL files and that the CLI remains usable.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.