Bug 639603

Summary: Unable to locate #virt-mem ( Documentation Bug)
Product: Red Hat Enterprise Linux 6 Reporter: Humble Chirammal <hchiramm>
Component: libvirtAssignee: Justin Clift <jclift>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: medium Docs Contact:
Priority: low    
Version: 6.1CC: ccui, dallan, dyuan, eblake, kwade, llim, mzhan, rjones, vbian, xen-maint
Target Milestone: rc   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: libvirt-0.8.7-1.el6 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2011-05-19 13:22:27 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 645519    

Description Humble Chirammal 2010-10-02 13:10:14 UTC
Description of problem:

#man virsh says about a command #virt-mem even-though it is not shipped with the product.

--snip-- from #man virsh

LICENSE
       virsh is distributed under the terms of the GNU LGPL v2+.  This is free software; see the source for copying
       conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE

SEE ALSO
       virt-install(1), virt-xml-validate(1), virt-top(1), virt-mem(1), virt-df(1), <http://www.libvirt.org/>


--/snip--

How-ever not able to find the same with RHEL 6 version.

This could be a documentation bug.



Version-Release number of selected component (if applicable):


How reproducible:

N/A

Steps to Reproduce:

[root@dhcp210-84 ~]# man 1 virt-mem
No entry for virt-mem in section 1 of the manual


[root@dhcp210-84 ~]# find / -name virt-mem
[root@dhcp210-84 ~]# locate virt-mem
[root@dhcp210-84 ~]#

Actual results:

Unable to find the binary.

Expected results:

Either the documentation should be corrected or need to provide the same .


--Humble

Comment 1 Richard W.M. Jones 2010-10-26 22:13:33 UTC
virt-mem in the manual page needs to be removed.  It
refers to an old program that we no longer ship.

Comment 2 Justin Clift 2010-11-22 14:49:49 UTC
The documentation has been fixed, in the libvirtd and virsh man pages, in the main libvirt source code upstream.  It will be available in libvirt 0.8.6.

The same fix has been submitted for RHEL 6.1 as well.

Comment 3 Justin Clift 2011-01-07 17:59:46 UTC
This was accepted upstream in libvirt 0.8.6:

commit 257cc1a1b3f970d22f13d7416cb8f95795eed1b4
Author: Justin Clift <jclift>
Date:   Mon Nov 22 22:55:35 2010 +1100

    docs: removed outdated reference to virt-mem

    The virt-mem program is no longer shipped, but was still being
    referenced at the bottom of the virsh and libvirtd man pages.

    This patch removes it from those man pages, addressing
    BZ# 639603:

      https://bugzilla.redhat.com/show_bug.cgi?id=639603

Comment 4 Jiri Denemark 2011-01-09 23:58:28 UTC
Built into libvirt-0.8.7-1.el6

Comment 5 Cui Chun 2011-01-10 09:39:40 UTC
Verified, pass.

Test environment:
libvirt-0.8.7-1.el6
qemu-kvm-0.12.1.2-2.128.el6
kernel-2.6.32-94.el6

Steps:

1.Check the manual page, the "virt-mem" has been removed.

---------snip----from #man virsh-----------

LICENSE
       virsh is distributed under the terms of the GNU LGPL v2+.  This is free software; see
       the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY
       or FITNESS FOR A PARTICULAR PURPOSE

SEE ALSO
       virt-install(1), virt-xml-validate(1), virt-top(1), virt-df(1),
       <http://www.libvirt.org/>

-----------/snip----------

2.Unable to find the binary also.
# man 1 virt-mem
No entry for virt-mem in section 1 of the manual
# find / -name virt-mem
# locate virt-mem

Comment 7 Vivian Bian 2011-01-26 09:34:31 UTC
Verified, pass.

Test environment:
libvirt-0.8.7-3.el6
qemu-kvm-0.12.1.2-2.129.el6
kernel-2.6.32-94.el6

Steps:

1.Check the manual page, the "virt-mem" has been removed.

---------snip----from #man virsh-----------

LICENSE
       virsh is distributed under the terms of the GNU LGPL v2+.  This is free
software; see
       the source for copying conditions. There is NO warranty; not even for
MERCHANTABILITY
       or FITNESS FOR A PARTICULAR PURPOSE

SEE ALSO
       virt-install(1), virt-xml-validate(1), virt-top(1), virt-df(1),
       <http://www.libvirt.org/>

-----------/snip----------

2.Unable to find the binary also.
# man 1 virt-mem
No entry for virt-mem in section 1 of the manual
# find / -name virt-mem
# locate virt-mem

Comment 8 Min Zhan 2011-04-19 13:03:15 UTC
Besides the above comment 5 and comment 7, I think # man libvirtd page should be also checked.

And the result is below with libvirt-0.8.7-18.el6.x86_64 :

1. Check manual page for virsh and libvirtd

# man libvirtd
...
LICENSE
       libvirtd is distributed under the terms of the GNU LGPL v2.1+.  This is
       free software; see the source for copying conditions. There is NO
       warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
       PURPOSE

SEE ALSO
       virsh(1), virt-install(1), virt-xml-validate(1), virt-top(1),
       virt-df(1), <http://www.libvirt.org/>


# man virsh
...
ICENSE
       virsh is distributed under the terms of the GNU LGPL v2+.  This is free
       software; see the source for copying conditions. There is NO warranty;
       not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE

SEE ALSO
       virt-install(1), virt-xml-validate(1), virt-top(1), virt-df(1),
       <http://www.libvirt.org/>

2.Unable to find the binary also.
# man 1 virt-mem
No entry for virt-mem in section 1 of the manual
# find / -name virt-mem
# locate virt-mem

Comment 9 Richard W.M. Jones 2011-04-19 13:12:25 UTC
(In reply to comment #8)
> Besides the above comment 5 and comment 7, I think # man libvirtd page should
> be also checked.
> 
> And the result is below with libvirt-0.8.7-18.el6.x86_64 :
> 
> 1. Check manual page for virsh and libvirtd

Neither libvirtd nor virsh manual pages reference virt-mem.  What's
the issue?

> 2.Unable to find the binary also.
> # man 1 virt-mem
> No entry for virt-mem in section 1 of the manual
> # find / -name virt-mem
> # locate virt-mem

Because virt-mem doesn't exist.

Comment 10 Min Zhan 2011-04-19 13:18:49 UTC
I notice previous check have ignored libvirtd man page. So I supplement libvirtd man page check in Comment 8.  And according to Comment 8, this bug status should keep Verified.

Comment 15 errata-xmlrpc 2011-05-19 13:22:27 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 therefore 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-2011-0596.html