[Bug] macOS QEMU quick start documents a literal PATH suffix and a missing restart script

Open Beginner friendly
#12,082 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
90/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
bash, markdown
Domain
documentation

Research direction

Start in documentation/2.quick-start/quick_start_qemu/quick_start_qemu_macos.md: read step 1.3 (lines 38-49) and step 5.3 (lines 162-171), then list bsp/qemu-vexpress-a9 to confirm the available script names. Change the PATH example to use $HOME inside the quoted value, and replace ./qemu_nographic.sh with ./qemu-nographic.sh or point to ./qemu.sh as in step 5.1. Done when both steps name working commands and the PATH suffix expands to an absolute path.

Written by the indexing model from the issue text.

Description

Arch: ARM/AArch64 Doc
RT-Thread Version

master at 6fdfe70062ec394e5dd7099c51cbcff127cacab1

Affected area

Documentation

Hardware/BSP vendor

Not applicable / Other

Architecture

ARM / AArch64

Board and hardware details

bsp/qemu-vexpress-a9 (emulated ARM vexpress A9). The affected instructions target an Intel macOS host.

Develop Toolchain

GCC

Describe the bug

Two commands in the Intel macOS QEMU quick start can block readers:

  1. Step 1.3 adds a quoted ~ to PATH. Inspecting the final component with printf '%s\n' "${PATH##*:}" shows it is stored literally. In a Bash POSIX-mode test, the documented pattern failed to locate an executable under the home directory. Using $HOME inside the quoted value sets an absolute path. Quick start, step 1.3 · Bash POSIX mode
  2. Step 5.3 asks readers to run ./qemu_nographic.sh after formatting sd0. This name is absent from the BSP directory. Readers can restart using ./qemu.sh as in step 5.1, or ./qemu-nographic.sh for a terminal-only session. Quick start, step 5.3 · BSP directory
Other additional context

Verified the PATH behavior with a temporary executable in Git Bash and checked the script names and executable modes in the repository tree. No macOS build or QEMU boot was performed. Drafted with assistance from OpenAI Codex.

Dominant language
C
Stars
12.4k
Forks
5.5k
Avg merge
3d 7h
Merged PRs (30d)
79

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

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.

More from RT-Thread/rt-thread

All issues in RT-Thread/rt-thread

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.