Documentation error: hostfwd syntax wrong

Bug #474969 reported by Muelli
10
This bug affects 1 person
Affects Status Importance Assigned to Milestone
QEMU
Fix Released
Undecided
Unassigned
qemu-kvm (Ubuntu)
Fix Released
Low
Dustin Kirkland 
Lucid
Fix Released
Low
Dustin Kirkland 

Bug Description

Binary package hint: qemu-kvm

The manpage is wrong. Currently it reads
               To redirect telnet connections from host port 5555 to telnet
               port on the guest, use the following:

                       # on the host
                       qemu -net user,hostfwd=tcp:5555::23 [...]
                       telnet localhost 5555

but the correct syntax is -net user,hostfwd=tcp::2223-:22

Also, the documentation should mention that you *need* a -net nic for a -net user. That took me hours to figure out.

ProblemType: Bug
Architecture: amd64
Date: Thu Nov 5 01:26:04 2009
DistroRelease: Ubuntu 9.10
KvmCmdLine: Error: command ['ps', '-C', 'kvm', '-F'] failed with exit code 1: UID PID PPID C SZ RSS PSR STIME TTY TIME CMD
MachineType: LENOVO 766636G
Package: kvm 1:84+dfsg-0ubuntu16+0.11.0+0ubuntu6.3
PccardctlIdent:
 Socket 0:
   no product info available
PccardctlStatus:
 Socket 0:
   no card
ProcCmdLine: root=/dev/mapper/cryptroot source=UUID=9c3d5596-27c6-4fd5-bfcd-fa8eef6f1230 ro quiet splash crashkernel=384M-2G:64M,2G-:128M
SourcePackage: qemu-kvm
Uname: Linux 2.6.32-999-generic x86_64
dmi.bios.date: 07/01/2008
dmi.bios.vendor: LENOVO
dmi.bios.version: 7NETB6WW (2.16 )
dmi.board.name: 766636G
dmi.board.vendor: LENOVO
dmi.board.version: Not Available
dmi.chassis.asset.tag: No Asset Information
dmi.chassis.type: 10
dmi.chassis.vendor: LENOVO
dmi.chassis.version: Not Available
dmi.modalias: dmi:bvnLENOVO:bvr7NETB6WW(2.16):bd07/01/2008:svnLENOVO:pn766636G:pvrThinkPadX61s:rvnLENOVO:rn766636G:rvrNotAvailable:cvnLENOVO:ct10:cvrNotAvailable:
dmi.product.name: 766636G
dmi.product.version: ThinkPad X61s
dmi.sys.vendor: LENOVO

Related branches

Revision history for this message
Muelli (ubuntu-bugs-auftrags-killer) wrote :
Mathias Gug (mathiaz)
Changed in qemu-kvm (Ubuntu):
importance: Undecided → Low
status: New → Confirmed
Revision history for this message
Dustin Kirkland  (kirkland) wrote :

This documentation change should also address the limitation identified in Bug #453617.

Changed in qemu-kvm (Ubuntu):
status: Confirmed → Triaged
assignee: nobody → Brian Thomason (brian-thomason)
Changed in qemu-kvm (Ubuntu Lucid):
milestone: none → ubuntu-10.04-beta-1
Revision history for this message
Dustin Kirkland  (kirkland) wrote :

Assigning this bug to Brian Thomason, as he asked for some bugzapping work.

Brian, this should be relatively straight forward to fix. The manpages are generated from the file qemu-options.hx in the source tree. The syntax is a little funny, but you shouldn't have to add any new sections; just correct whats there. Please address the documentation concerns from this bug, as well as Bug #453617. Please test the options/examples you cite in the documentation. Once you have the changes, create a patch suitable for the debian/patches directory. Please test the build, generate the .deb files, extract the manpage and ensure that the generated manpage is suitable. Once you have that, we'll need to submit that patch to upstream QEMU, which I'll help you with. Please attach the patch here for review as soon as you have it.

Thanks!

Revision history for this message
Brian Thomason (brian-thomason) wrote :

Here is a patch for the changes to qemu-options.hx. Let me know if you want a full blown debdiff or want me to look into the actual parameter parsing issue.

Thanks!

tags: added: patch
Changed in qemu-kvm (Ubuntu Lucid):
status: Triaged → In Progress
Thierry Carrez (ttx)
Changed in qemu-kvm (Ubuntu Lucid):
milestone: ubuntu-10.04-beta-1 → none
Changed in qemu-kvm (Ubuntu Lucid):
assignee: Brian Thomason (brian-thomason) → Dustin Kirkland (kirkland)
Revision history for this message
Launchpad Janitor (janitor) wrote :

This bug was fixed in the package qemu-kvm - 0.12.3-0ubuntu6

---------------
qemu-kvm (0.12.3-0ubuntu6) lucid; urgency=low

  [ Dustin Kirkland ]
  * debian/postinst: clean up jaunty-era conffiles on upgrade, LP: #455411
  * debian/links, debian/qemu-kvm-extras.links: install non-x86 arch
    manpages in the qemu-kvm-extras package, LP: #478552

  [ Brian Thomason ]
  * debian/patches/better_describe_-net_options.patch: improve port
    forwarding documentation, LP: #474969, LP: #453617
 -- Dustin Kirkland <email address hidden> Fri, 05 Mar 2010 18:39:19 -0600

Changed in qemu-kvm (Ubuntu Lucid):
status: In Progress → Fix Released
Revision history for this message
Nigel Babu (nigelbabu) wrote :

Changing to Fix Released and unsubscribing ubuntu-reviewers

Changed in qemu:
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.