qemu-rst-documentation
Use for writing or updating QEMU reStructuredText documentation, including board and machine docs, system docs, device docs, developer docs, boot command examples, feature status tables, Sphinx index/toctree updates, and docs build validation.
processmission · 已有静态检查记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add processmission/oh-my-qemu --skill qemu-rst-documentation技能说明
SPDX-FileCopyrightText: Copyright (c) 2026 Process Mission
SPDX-License-Identifier: MIT
name: qemu-rst-documentation description: Use for writing or updating QEMU reStructuredText documentation, including board and machine docs, system docs, device docs, developer docs, boot command examples, feature status tables, Sphinx index/toctree updates, and docs build validation.
QEMU RST Documentation
Audit workflow
For non-trivial workspace writes, use a stable
.oh-my-qemu/<task-slug>/ directory and create only needed entries:
.oh-my-qemu/<task-slug>/
├── audit.md # Baseline, scope, decisions, evidence, verification, and gaps
├── commands.md # Redacted commands, working directories, and results
├── logs/ # Decisive build, test, runtime, or diagnostic logs
├── scripts/ # Temporary scripts, probes, parsers, and harnesses
└── output/ # Generated deliverables, dependencies, and non-QEMU binaries
Before changing source or mutable artifacts, record the workspace root,
revision, git status --short, pre-existing changes, goal, scope, and
acceptance checks in audit.md. Log exact redacted commands and results in
commands.md; record revisions, configurations, tool versions, and hashes when
they affect reproducibility. Separate observations from inferences and edit
source only when requested.
Keep QEMU builds under source-root builds/build-<target>/; put third-party
dependencies and non-QEMU binaries in task output/. Before writing audit
artifacts or configuring QEMU in a Git worktree, add .agents/,
.oh-my-qemu/, and builds/ to the repository-local file from
git rev-parse --git-path info/exclude; preserve existing entries and avoid
duplicates. Never stage or commit those directories. At handoff, verify them
absent from git status --short. Report the task directory and unresolved gaps.
Base every support statement and command example on inspected implementation, tests, or runtime evidence. Do not create audit artifacts for a simple typo or one-line fix.
QEMU upstream boundary
QEMU's official GitLab and mailing lists are upstream project channels. A
patch becomes an upstream contribution when sent to the mailing-list recipients
selected through MAINTAINERS; do not prepare or send agent-generated patches
for that submission. Local branches, commits, patch files, pushes, and pull
requests are not by themselves QEMU upstream contributions. Perform those Git
actions only when requested and follow the workspace's Git policy.
Source-First Rule
Before writing, inspect the checked-out QEMU tree:
- nearby docs in the same directory, such as
docs/system/<arch>/ordocs/devel/; - the relevant
index.rstor toctree file; - existing board or machine docs for tone, section order, and command style;
MAINTAINERSentries when adding a new documented area;- the implementation, tests, and boot logs that prove the documented behavior.
Do not invent support status from code names alone. Document only behavior that is implemented, verified, or explicitly marked as a limitation.
Board or Machine Page Shape
For a new board or machine document, prefer this structure unless nearby docs use a clearer local convention:
<Board or Machine Name>
=======================
Overview
--------
Supported devices
-----------------
Boot options
------------
Direct Linux boot
~~~~~~~~~~~~~~~~~
Firmware boot
~~~~~~~~~~~~~
Known limitations
-----------------
Running tests
-------------
Include only sections that carry useful information. If the board has no firmware path, do not add a placeholder firmware section.
Content Rules
- Name QEMU machine types exactly as the command line uses them.
- Keep command lines copy-pasteable and line-wrapped consistently with nearby docs.
- Show serial console choices explicitly when boot logs depend on a specific UART or chardev.
- Separate supported hardware from known stubs, unimplemented regions, and compatibility workarounds.
- For boot examples, include enough
-machine,-cpu, memory, storage, kernel, firmware, DTB, initrd, and console options for reproduction. - Avoid promising hardware accuracy from a boot smoke alone; tie claims to qtest, trace, or workload evidence when available.
- Avoid project-local paths. Use placeholders such as
/path/to/Imageor variables documented in the surrounding text.
RST Rules
- Match the heading hierarchy and adornment style used by nearby QEMU docs.
- Use inline literals with double backticks.
- Use literal blocks with
::for shell commands unless nearby docs prefer.. code-block::. - Do not use Markdown fences in
.rst. - Keep toctree entries sorted or grouped according to the local index.
- Add the new page to the relevant
index.rstor toctree; a standalone file is not enough. - Do not add labels, cross references, or substitutions unless you verify they resolve in the local docs build.
Validation
Run the narrowest available docs gate from the checked-out QEMU tree:
ninja -C builds/build-docs docs
If the build directory is not configured for docs, inspect available targets first:
ninja -C builds/build-docs -t targets | rg 'docs|sphinx'
At minimum, run git diff --check and inspect the rendered RST mentally for heading hierarchy, toctree inclusion, literal block indentation, and overlong command examples. Store any docs build logs under .oh-my-qemu/<task-slug>/logs/ when the work is part of a larger QEMU task.
Report
When done, report:
- docs files changed;
- index/toctree updates;
- source evidence used for feature and boot claims;
- docs build or fallback validation;
- any intentionally undocumented or unverified behavior.