oxidecomputer / oxidecomputer/humility

Confusing sentence related to `humility map`

Open
#45 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
584
Forks
63
Avg merge
3h
Merged PRs (30d)
2

Description

@ahrens had trouble understanding this sentence in humility map, but I wasn't sure how to fix it, perhaps due to my unfamiliarity with embedded systems:

This can happen, for example, because the task attempted to access device memory that was not allocated to it in the build description, because it exceeded the device memory allocated to it, or because it allocated the memory allocated to it, e.g., because of a stack overflow.

Specifically, "because it allocated the memory allocated to it" doesn't sound like a problem. Should this be something like, "because it allocated past the memory allocated to it"?

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

Search the repository for the quoted sentence and read the surrounding humility map documentation. Decide whether the proposed wording accurately describes the failure, then update the sentence so the allocation error is unambiguous and confirm the revised text matches the intended meaning.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.