Bug 227858

Summary: xen - man pages need reviewed for accuracy
Product: Red Hat Enterprise Linux 5 Reporter: Stephen Tweedie <sct>
Component: xenAssignee: Richard W.M. Jones <rjones>
Status: CLOSED ERRATA QA Contact:
Severity: medium Docs Contact:
Priority: medium    
Version: 5.0CC: dmalcolm, herrold, jlaska, xen-maint
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: RHBA-2008-0305 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2008-05-21 15:19:31 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---
Bug Depends On: 225603    
Bug Blocks:    
Attachments:
Description Flags
Patch to fix incorrect xm create documentation none

Comment 1 RHEL Product and Program Management 2007-03-21 22:06:29 UTC
This request was evaluated by Red Hat Product Management for inclusion in a Red
Hat Enterprise Linux maintenance release.  Product Management has requested
further review of this request by Red Hat Engineering, for potential
inclusion in a Red Hat Enterprise Linux Update release for currently deployed
products.  This request is not yet committed for inclusion in an Update
release.

Comment 2 RHEL Product and Program Management 2007-09-07 19:55:32 UTC
This request was previously evaluated by Red Hat Product Management
for inclusion in the current Red Hat Enterprise Linux release, but
Red Hat was unable to resolve it in time.  This request will be
reviewed for a future Red Hat Enterprise Linux release.

Comment 3 R P Herrold 2007-09-23 02:29:41 UTC
One clear staleness is this:

per the man page:

 without config file
                 xm create /dev/null ramdisk=initrd.img \
                    kernel=/boot/vmlinuz-2.6.12.6-xenU \
                    name=ramdisk nics=0 vcpus=1 \
                    memory=64 root=/dev/ram0

============================

running a variant of this:
[root@couch ~]#  xm create /dev/null
ramdisk=/var/ftp/pub/install/ftpinstall/images/pxeboot/initrd.img
kernel=/var/ftp/pub/install/ftpinstall/images/pxeboot/vmlinuz  name=ramdisk
nics=1 vcpus=1 memory=64 root=/dev/ram0
Using config file "/dev/null".
Warning: The nics option is deprecated.  Please use an empty vif entry instead:

  vif = [ '' ]

Error: (22, 'Invalid argument')
[root@couch ~]#     

returns a clear error in the page as to 'nics'.

==================================

continuing:

we get an error in the proposed config file suggested by the present man page:

[root@couch ~]#  xm create /dev/null
ramdisk=/var/ftp/pub/install/ftpinstall/images/pxeboot/initrd.img
kernel=/var/ftp/pub/install/ftpinstall/images/pxeboot/vmlinuz  name=ramdisk
vif='mac=00:16:3e:66:4c:d8,bridge=xenbr0'  vcpus=1 memory=64 root=/dev/ram0
Using config file "/dev/null".
Error: (22, 'Invalid argument')
[root@couch ~]#               

Error 22 -- Invalid Argement implies some error, but there is NO WAY clear from
the man page to diagnose it.  any thoughts?

Comment 4 Richard W.M. Jones 2008-01-17 13:15:04 UTC
Just an update to this:

(1) The FIXMEs in the xm man page are gone (fixed in RHEL 5.1
when we updated the Xen userspace).

(2) The 'xm create' documentation is still wrong.  I'm preparing
a patch for this right now.

Comment 5 Richard W.M. Jones 2008-01-17 15:20:58 UTC
and (3) I can't reproduce the 'Error 22 -- Invalid Argument'.  The following
command works just fine for me under RHEL 5.1:

/usr/sbin/xm create /dev/null \
  ramdisk=/boot/initrd-2.6.18-53.el5xen.img \
  kernel=/boot/vmlinuz-2.6.18-53.el5xen \
  name=test vif='' vcpus=1 memory=64 root=/dev/ram0

Comment 6 Richard W.M. Jones 2008-01-17 15:36:58 UTC
Created attachment 292005 [details]
Patch to fix incorrect xm create documentation

This patch fixes the incorrect 'xm create' documentation in the manpage.

Comment 7 Daniel Berrange 2008-01-17 22:15:51 UTC
Built for RHEL-5.2

Build                                     Tag                   Built by
----------------------------------------  --------------------  ----------------
xen-3.0.3-46.el5                          dist-5E-qu-candidate  berrange


Comment 10 errata-xmlrpc 2008-05-21 15:19:31 UTC
An advisory has been issued which should help the problem
described in this bug report. This report is therefore being
closed with a resolution of ERRATA. For more information
on the solution and/or where to find the updated files,
please follow the link below. You may reopen this bug report
if the solution does not work for you.

http://rhn.redhat.com/errata/RHBA-2008-0305.html