Skip to content

[docs] point QEMU Linux quick start at qemu-nographic.sh - #11793

Open
shiptux wants to merge 1 commit into
RT-Thread:masterfrom
shiptux:docs/qemu-linux-nographic
Open

[docs] point QEMU Linux quick start at qemu-nographic.sh#11793
shiptux wants to merge 1 commit into
RT-Thread:masterfrom
shiptux:docs/qemu-linux-nographic

Conversation

@shiptux

@shiptux shiptux commented Sep 9, 2026

Copy link
Copy Markdown

Problem

The QEMU Linux quick start only ever mentions ./qemu.sh, and its file table omits the qemu-nographic scripts entirely.

qemu.sh passes -serial stdio without -nographic, so QEMU opens a GTK window for the emulated CLCD. On a headless machine or over SSH it stops at gtk initialization failed (reproduced by running it with DISPLAY unset), with nothing in the guide explaining what to do next — even though the BSP already ships qemu-nographic.sh for exactly this case, and the BSP README itself recommends it for servers.

Change

  • Add both qemu-nographic scripts to the file table in chapter 4
  • Document ./qemu-nographic.sh in section 5.2, right where the project is first run

The quick start only ever mentions ./qemu.sh, and its file table omits
the qemu-nographic scripts entirely. qemu.sh passes -serial stdio
without -nographic, so QEMU opens a GTK window for the emulated CLCD.
On a headless machine or over SSH it stops at "gtk initialization
failed", with nothing in the guide explaining what to do next, even
though the BSP already ships qemu-nographic.sh for exactly this case.

Add both nographic scripts to the file table and document them where
the project is first run.
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Cheng Li seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).


🛠 操作步骤 | Steps

  1. 前往 Actions 页面 | Go to the Actions page
    点击进入工作流 → | Click to open workflow →

  2. 点击 Run workflow | Click Run workflow

  • Use workflow from 保持默认分支(通常为 master
    Keep the default branch (usually master) in Use workflow from
  • branch 输入框填写 PR 分支 docs/qemu-linux-nographic
    Enter PR branch docs/qemu-linux-nographic in the branch field
  • 设置需排除的文件/目录(目录请以"/"结尾)
    Set files/directories to exclude (directories should end with "/")
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将作为独立提交推送至你的分支。
    The formatting changes will be pushed to your branch as a separate commit.

完成后,提交将自动更新至 docs/qemu-linux-nographic 分支,关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the docs/qemu-linux-nographic branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们,再次感谢您的贡献!💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

@github-actions github-actions Bot added the Doc This PR/issue related with documents label Sep 9, 2026
@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

📌 Code Review Assignment

🏷️ Tag: documentation

Reviewers: @CXSforHPU @GorrayLi @lianux-mm

Changed Files (Click to expand)
  • documentation/2.quick-start/quick_start_qemu/quick_start_qemu_linux.md

📊 Current Review Status (Last Updated: 2026-09-09 23:53 CST)


📝 Review Instructions

  1. 维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
    Maintainers can refresh the review status by clicking here: 🔄 Refresh Status

  2. 确认审核通过后评论 LGTM/lgtm
    Comment LGTM/lgtm after confirming approval

  3. PR合并前需至少一位维护者确认
    PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

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

Labels

Doc This PR/issue related with documents

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants