doc: revise autogenerated manpages - #498
Open
andreasglashauser wants to merge 8 commits into
Open
andreasglashauser wants to merge 8 commits into
andreasglashauser wants to merge 8 commits into
Conversation
Describe actual behavior (resume of suspended qubes, handling of internal qubes with --all, exit codes) and remove the autogenerated placeholder admonition. QubesOS/qubes-issues#11056
Explain what tags are for (qrexec policy matching, automatic created-by-/guivm-/audiovm- tags), fix the 'del' synopsis (it accepts exactly one tag) and remove the autogenerated placeholder admonition. QubesOS/qubes-issues#11056
Document confirmation prompts (including IKNOWWHATIAMDOING for --all), dependency errors, glob patterns in VMNAME, exit codes; remove the autogenerated placeholder admonition. QubesOS/qubes-issues#11056
Describe what exactly gets copied (volumes, properties, tags, features, notes, firewall, devices), pool selection, and remove the autogenerated placeholder admonition. QubesOS/qubes-issues#11056
Document exit codes (0/1/3), AND-combination of state options, scripting usage example; remove the autogenerated placeholder admonition. QubesOS/qubes-issues#11056
Describe dependency startup, parallel start of multiple qubes, glob patterns, temporary drive attachment semantics and exit codes; remove the autogenerated placeholder admonition. QubesOS/qubes-issues#11056
Add description of restore semantics (restore as new qubes, dom0 home to home-restore-<timestamp>, passphrase/confirmation flow, positional arguments, untrusted-backup considerations) and remove the autogenerated placeholder admonition. QubesOS/qubes-issues#11056
Explain what the tool actually does (start qubes-guid / pacat-simple-vchan in the GUI/Audio qube), describe its three operation modes (one-shot, --watch, --notify-monitor-layout), fix --notify-monitory-layout typo in synopsis, document the default pidfile path; remove the autogenerated placeholder admonition. QubesOS/qubes-issues#11056
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #498 +/- ##
=======================================
Coverage 76.84% 76.85%
=======================================
Files 53 53
Lines 9434 9436 +2
=======================================
+ Hits 7250 7252 +2
Misses 2184 2184 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrite the eight manpages that still carried the "autogenerated from command-line parser" placeholder.
fixes QubesOS/qubes-issues#11056
Disclosure per the AI contribution guidance: I used Kimi K3 for phrasing ideas. I always reworked its suggestions into my own drafts, so i did not copy them. Commit messages were generated by a personal of mine running a small local LLM.