docs: align manual pages with release 4.9.8 by philclifford · Pull Request #1858 · quickemu-project/quickemu

philclifford · 2026-01-27T22:24:32Z

Description

Align documentation with Release 4.9.8

Type of change

Documentation (updates the documentation)

Checklist:

I have performed a self-review of my code
I have tested my code in common scenarios and confirmed there are no regressions
I have made corresponding changes to the documentation (remove if no documentation changes were required)

cubic-dev-ai

2 issues found across 8 files

Confidence score: 5/5

Only minor documentation typos in docs/quickemu.1.md and docs/quickget.1 ("recover image" vs "recovery image"), no functional impact
Score 5 because issues are low-severity, non-user-impacting documentation wording fixes
No files require special attention.

Prompt for AI agents (all issues)


Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="docs/quickemu.1.md">

<violation number="1" location="docs/quickemu.1.md:569">
P3: Typo in documentation: use “recovery image” instead of “recover image.”</violation>
</file>

<file name="docs/quickget.1">

<violation number="1" location="docs/quickget.1:393">
P3: Typo in the new macOS VPN note: "recover image" should be "recovery image" for correctness.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

docs/quickemu.1.md

docs/quickget.1

philclifford · 2026-01-28T20:20:38Z

@cubic-dev-ai typo addressed in regeneration from source - please re-review

cubic-dev-ai · 2026-01-28T20:20:50Z

@cubic-dev-ai typo addressed in regeneration from source - please re-review

@philclifford I have started the AI code review. It will take a few minutes to complete.

cubic-dev-ai

1 issue found across 8 files

Confidence score: 5/5

This PR looks safe to merge; the only noted issue is a low-severity documentation inconsistency.
The manpage in docs/quickemu.1 lists two different defaults for --display (sdl vs gtk), which could confuse users but won’t affect runtime behavior.
Pay close attention to docs/quickemu.1 - reconcile the documented default display backend.

Prompt for AI agents (all issues)


Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="docs/quickemu.1">

<violation number="1" location="docs/quickemu.1:1159">
P3: The manpage now lists two conflicting defaults for `--display` (sdl vs gtk). Please reconcile both sections so the default backend is documented consistently.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

docs/quickemu.1

cubic-dev-ai

1 issue found across 8 files

Confidence score: 5/5

Only a minor documentation formatting issue in docs/quickemu.1 (missing space before a colon) that affects manpage alignment, not functionality.
Pay close attention to docs/quickemu.1 - keep option list formatting aligned.

Prompt for AI agents (all issues)


Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="docs/quickemu.1">

<violation number="1" location="docs/quickemu.1:585">
P3: The new `--check-all-arch` entry is missing the space before the colon that the rest of the option list uses, which causes misaligned formatting in the rendered manpage. Add the space to keep the column alignment consistent.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

docs/quickemu.1

as per quickemu-project/quickemu#1858 (comment) Signed-off-by: Phil Clifford <philip.clifford@gmail.com>

as per quickemu-project#1858 (comment) with adjustment of flag alignment in _ _ _ __ _ _ _(_) ___| | ____ _ ___| |_ / _` | | | | |/ __| |/ / _` |/ _ \ __| | (_| | |_| | | (__| < (_| | __/ |_ \__, |\__,_|_|\___|_|\_\__, |\___|\__| |_| |___/ v4.9.9, using curl 7.81.0 -------------------------------------------------------------------------------- Project - https://github.com/quickemu-project/quickemu Discord - https://wimpysworld.io/discord -------------------------------------------------------------------------------- Usage: quickget <os> <release> [edition] quickget ubuntu 22.04 Advanced usage: quickget <arg> [path] <os> [release] [edition] quickget --download ubuntu 22.04 Arguments: --arch <arch> : Set architecture (arm64, aarch64, amd64, x86_64) --download <os> <release> [edition] : Download image; no VM configuration --create-config <os> [path/url] [flags] : Create VM config for an OS image --open-homepage <os> : Open homepage for the OS --show [os] : Show OS information --version : Show version --help : Show this help message ------------------------------------ Flags ------------------------------------- --create-config: --disable-unattended : Force quickget not to set up an unattended installation -------------------------- For testing & development --------------------------- --url [os] [release] [edition] : Show image URL(s) --check [os] [release] [edition] : Check image URL(s) --check-all-arch [os] [release] [edition]: Check downloads for all architectures (amd64 and arm64) --list : List all supported systems --list-csv : List everything in csv format --list-json : List everything in json format -------------------------------------------------------------------------------- Supported Operating Systems: alma alpine android antix archcraft archlinux artixlinux azurelinux batocera bazzite biglinux blendos bodhi bunsenlabs cachyos centos-stream chimeralinux crunchbang++ debian deepin devuan dragonflybsd easyos edubuntu elementary endeavouros endless fedora freebsd freedos garuda gentoo ghostbsd gnomeos guix haiku kali kdeneon kolibrios kubuntu linuxlite linuxmint lmde lubuntu maboxlinux macos mageia manjaro mxlinux netboot netbsd nitrux nixos nwg-shell openbsd openindiana opensuse oraclelinux parrotsec pclinuxos peppermint popos porteus primtux proxmox-ve pureos reactos rebornos rockylinux siduction slackware slax slint slitaz solus sparkylinux spirallinux tails tinycore trisquel tuxedo-os ubuntu ubuntu-budgie ubuntu-mate ubuntu-server ubuntu-unity ubuntucinnamon ubuntukylin ubuntustudio vanillaos void windows windows-server xubuntu zorin and regenerated docs Signed-off-by: Phil Clifford <philip.clifford@gmail.com>

as per quickemu-project/quickemu#1858 (comment) Signed-off-by: Phil Clifford <philip.clifford@gmail.com>

flexiondotorg · 2026-01-29T08:49:35Z

@cubic-dev-ai Another review, please.

cubic-dev-ai · 2026-01-29T08:49:51Z

@cubic-dev-ai Another review, please.

@flexiondotorg I have started the AI code review. It will take a few minutes to complete.

cubic-dev-ai

1 issue found across 8 files

Confidence score: 4/5

Safe to merge overall; the only issue is a documentation omission rather than runtime behavior
docs/quickget.1 no longer mentions the supported --disable-unattended flag, which could confuse users looking to disable unattended installs
Pay close attention to docs/quickget.1 - restore the missing --disable-unattended option in the advanced options list.

Prompt for AI agents (all issues)


Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="docs/quickget.1">

<violation number="1" location="docs/quickget.1:133">
P2: The advanced options list no longer documents the `--disable-unattended` flag even though quickget still supports it, so the manpage now omits how to disable unattended installs.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

docs/quickget.1

cubic-dev-ai

1 issue found across 8 files

Confidence score: 5/5

Only a minor documentation formatting tweak in docs/quickemu.1, so risk to functionality is negligible
This PR looks safe to merge; the noted issue is low severity and purely cosmetic
Pay close attention to docs/quickemu.1 - keep the --check-all-arch entry colon spacing aligned with the rest of the list.

Prompt for AI agents (all issues)


Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="docs/quickemu.1">

<violation number="1" location="docs/quickemu.1:585">
P3: Align the spacing before the colon in the `--check-all-arch` entry so the quickget options list keeps consistent column alignment.

(Based on your team's feedback about consistent quickget help_message colon alignment.) [FEEDBACK_USED]</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

docs/quickemu.1

philclifford · 2026-02-02T14:47:10Z

Failing CI checks when done locally are reduced to

FAIL: freedos-1.4                         https://www.ibiblio.org/pub/micro/pc-stuff/freedos/files/distributions/1.4/FD14-LiveCD.zip
FAIL: freedos-1.2                         https://www.ibiblio.org/pub/micro/pc-stuff/freedos/files/distributions/1.2/official/FD12CD.iso
FAIL: opensuse-16.1                       https://download.opensuse.org/distribution/leap/16.1/iso/openSUSE-Leap-16.1-DVD-x86_64-Current.iso

and even then FreeDOS seems to pass if you are patient enough (maybe ibiblio.org is struggling)

quickget --check freedos 1.4
PASS: freedos-1.4                         https://www.ibiblio.org/pub/micro/pc-stuff/freedos/files/distributions/1.4/FD14-LiveCD.zip
 
time quickget --check freedos 1.2
PASS: freedos-1.2                         https://www.ibiblio.org/pub/micro/pc-stuff/freedos/files/distributions/1.2/official/FD12CD.iso

real	0m30.689s

opensuse 16.1 artifacts seem to have been removed upstream

cubic-dev-ai

1 issue found across 5 files (changes from recent commits).

Prompt for AI agents (all issues)


Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="docs/quickemu.1.md">

<violation number="1" location="docs/quickemu.1.md:409">
P3: The manpage block is out of sync with `quickget`’s help output: the testing-only options (`--url`, `--check`, `--list*`) are listed in the main options block instead of under the “For testing & development” section. Regenerate the manpage or adjust the block so option grouping matches the actual help message.

(Based on your team's feedback about keeping manpage option formatting aligned and regenerating the manpages.) [FEEDBACK_USED]</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

docs/quickemu.1.md

philclifford · 2026-02-02T20:02:27Z

Squashed generated documentation changes.
@cubic-dev-ai please review again

cubic-dev-ai · 2026-02-02T20:02:48Z

Squashed generated documentation changes.
@cubic-dev-ai please review again

@philclifford I have started the AI code review. It will take a few minutes to complete.

cubic-dev-ai

No issues found across 8 files

Confidence score: 5/5

Automated review surfaced no issues in the provided summaries.
No files require special attention.

chore: align doc submodule commit docs(quickget): adapt whitespace in help_message() needed in manual page regeneration to retain filtering of needed lines currently omits the new flag for --disable-unattended Signed-off-by: Phil Clifford <philip.clifford@gmail.com>

philclifford changed the title ~~Update docs 202601~~ docs: Update docs 202601 Jan 27, 2026

cubic-dev-ai bot reviewed Jan 27, 2026

View reviewed changes

docs/quickemu.1.md Outdated Show resolved Hide resolved

docs/quickget.1 Outdated Show resolved Hide resolved

philclifford force-pushed the update-docs-202601 branch from cd77776 to a2d06e4 Compare January 28, 2026 20:00

cubic-dev-ai bot reviewed Jan 28, 2026

View reviewed changes

docs/quickemu.1 Show resolved Hide resolved

philclifford force-pushed the update-docs-202601 branch from a2d06e4 to ffc88fa Compare January 28, 2026 20:40

cubic-dev-ai bot reviewed Jan 28, 2026

View reviewed changes

docs/quickemu.1 Outdated Show resolved Hide resolved

philclifford added a commit to philclifford/quickemu-docs that referenced this pull request Jan 28, 2026

docs: align colons with spaces before

8ee4128

as per quickemu-project/quickemu#1858 (comment) Signed-off-by: Phil Clifford <philip.clifford@gmail.com>

philclifford added a commit to philclifford/quickemu-docs that referenced this pull request Jan 28, 2026

docs: align colons with spaces before

b524ace

as per quickemu-project/quickemu#1858 (comment) Signed-off-by: Phil Clifford <philip.clifford@gmail.com>

philclifford requested a review from flexiondotorg January 28, 2026 21:39

cubic-dev-ai bot reviewed Jan 29, 2026

View reviewed changes

docs/quickget.1 Outdated Show resolved Hide resolved

cubic-dev-ai bot reviewed Feb 2, 2026

View reviewed changes

docs/quickemu.1 Outdated Show resolved Hide resolved

cubic-dev-ai bot reviewed Feb 2, 2026

View reviewed changes

docs/quickemu.1.md Show resolved Hide resolved

philclifford force-pushed the update-docs-202601 branch from 42c4093 to 335ed50 Compare February 2, 2026 19:43

philclifford changed the title ~~docs: Update docs 202601~~ docs: Align documentation with Release 4.9.8 Feb 2, 2026

cubic-dev-ai bot reviewed Feb 2, 2026

View reviewed changes

philclifford force-pushed the update-docs-202601 branch from 335ed50 to 50f24a3 Compare February 2, 2026 20:54

philclifford force-pushed the update-docs-202601 branch from 50f24a3 to 9507ba7 Compare February 2, 2026 20:55

philclifford changed the title ~~docs: Align documentation with Release 4.9.8~~ docs: align manual pages with release 4.9.8 Feb 2, 2026

flexiondotorg merged commit 81d038c into quickemu-project:master Feb 10, 2026
1 of 8 checks passed

philclifford deleted the update-docs-202601 branch February 10, 2026 23:16

Uh oh!

Conversation

philclifford commented Jan 27, 2026

Description

Type of change

Checklist:

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

philclifford commented Jan 28, 2026

Uh oh!

cubic-dev-ai bot commented Jan 28, 2026

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

flexiondotorg commented Jan 29, 2026

Uh oh!

cubic-dev-ai bot commented Jan 29, 2026

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

philclifford commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

philclifford commented Feb 2, 2026

Uh oh!

cubic-dev-ai bot commented Feb 2, 2026

Uh oh!

cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

philclifford commented Feb 2, 2026 •

edited

Loading