Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 231735 - =app-emulation/kvm-70 documentation fixes needed for renamed qemu-img and qemu-ifup
Summary: =app-emulation/kvm-70 documentation fixes needed for renamed qemu-img and qem...
Status: RESOLVED FIXED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All All
: High trivial (vote)
Assignee: Doug Goldstein (RETIRED)
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2008-07-14 02:20 UTC by Carlo Marcelo Arenas Belon
Modified: 2008-07-16 07:56 UTC (History)
1 user (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
documentation changes for reflecting renaming qemu-img as kvm-img (kvm-70-qemu-kvm-img-doc.patch,3.11 KB, patch)
2008-07-14 02:22 UTC, Carlo Marcelo Arenas Belon
Details | Diff
missing documentation updates for renaming qemu-ifup as kvm-ifup (kvm-70-qemu-kvm-ifup-doc.patch,2.13 KB, patch)
2008-07-14 02:22 UTC, Carlo Marcelo Arenas Belon
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Carlo Marcelo Arenas Belon 2008-07-14 02:20:30 UTC
the ebuild in the portage tree renames qemu-img to kvm-img and the qemu-ifup script to kvm-ifup but doesn't update the documentation to reflect that.

Reproducible: Always

Steps to Reproduce:
1. emerge -DNvu kvm
2. man kvm-img
3. man kvm

Actual Results:  
references to qemu-img instead of kvm-img in the documentation, and references to qemu-ifup instead of kvm-ifup as the script that will be called when using -net tap

Expected Results:  
documentation consistent with the code

kvm-70-qemu-kvm-ifup-doc.patch could be consolidated with kvm-70-qemu-kvm-doc.patch as it is complementary.

kvm-70-qemu-kvm-img-doc.patch will cover for most of the changes required by the renaming of qemu-img to kvm-img outside of the build system but will still leave the title for kvm-img(1) referencing the original name file of "qemu-img"
Comment 1 Carlo Marcelo Arenas Belon 2008-07-14 02:22:01 UTC
Created attachment 160305 [details, diff]
documentation changes for reflecting renaming qemu-img as kvm-img
Comment 2 Carlo Marcelo Arenas Belon 2008-07-14 02:22:50 UTC
Created attachment 160306 [details, diff]
missing documentation updates for renaming qemu-ifup as kvm-ifup
Comment 3 Daniel Gryniewicz (RETIRED) gentoo-dev 2008-07-15 18:25:43 UTC
I believe I've fixed these in 71.  The manpages still aren't perfect, since there's a *lot* of qemu-isms in them that don't apply to kvm, but maintaining good man pages is not something I'm interested in.

Feel free to re-open if I've missed anything.
Comment 4 Carlo Marcelo Arenas Belon 2008-07-16 07:56:59 UTC
masking the fact that userspace kvm is really qemu wasn't the intention of this set of patches and neither writing kvm specific documentation based on the one available from qemu.

the important issues that they were meant to address were mistakes in the documentation, man pages or usage for the commands that were renamed and that were incorrectly referring to the original names which were no longer valid.

not sure why you decided to reimplement the fixes when patches were provided, but some of the snippets missing from them in the reimplementation fixed :

* kvm-img --help refers to itself as qemu-img

and renaming qemu-nbd to kvm-nbd (which shouldn't have any conflict with qemu, as there had been yet a release from qemu that includes that) might just add
to the maintenance cost of this patch for no reason.