Bug 595350

Summary: DOCS: /usr/sbin/libvirtd does not have a man page
Product: Red Hat Enterprise Linux 6 Reporter: Daniel Berrangé <berrange>
Component: libvirtAssignee: Justin Clift <jclift>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: medium Docs Contact:
Priority: low    
Version: 6.0CC: ccui, dallan, jclift, kwade, llim, veillard, 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:
: 618750 (view as bug list) Environment:
Last Closed: 2011-05-19 13:18:55 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: 618750, 628871    

Description Daniel Berrangé 2010-05-24 12:31:06 UTC
Description of problem:
All executables in /usr/bin and /usr/sbin should have man pages. libvirtd does not have one.

Version-Release number of selected component (if applicable):
0.8.1-1.el6

How reproducible:
Always

Steps to Reproduce:
1. man libvirtd
2.
3.
  
Actual results:
None found

Expected results:


Additional info:

Comment 2 RHEL Program Management 2010-06-07 15:59:24 UTC
This request was evaluated by Red Hat Product Management for inclusion in a Red
Hat Enterprise Linux major release.  Product Management has requested further
review of this request by Red Hat Engineering, for potential inclusion in a Red
Hat Enterprise Linux Major release.  This request is not yet committed for
inclusion.

Comment 3 Justin Clift 2010-07-08 19:25:25 UTC
A patch has been submitted upstream for adding a man page for libvirtd:

  https://www.redhat.com/archives/libvir-list/2010-July/msg00171.html

Comment 4 Justin Clift 2010-07-09 14:41:38 UTC
The patch for this has been pushed into upstream source.

Comment 5 Justin Clift 2010-07-12 19:44:05 UTC
Additional patch, removing the requirement of unicode support in pod2man:

  https://www.redhat.com/archives/libvir-list/2010-July/msg00251.html

I still need to get this included in RHEL 6.

Comment 7 Daniel Veillard 2010-10-11 15:36:02 UTC
Patch is upstream, 

Daniel

Comment 8 Justin Clift 2011-01-07 18:13:10 UTC
This was included in upstream libvirt some time ago, by these two commits:

commit c6a6dc1d2d04b1d5aeb6978577f4d08a216f93ed
Author: Justin Clift <jclift>
Date:   Fri Jul 9 19:21:39 2010 +1000

    libvirtd: add man page for libvirtd

    With gracious thanks to Chris Lalancette for helping knock the
    description section into shape.

    This addresses BZ #595350

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


commit de7d4c6ae7b08db0e00a8250e4d0dff134702b4d
Author: Justin Clift <jclift>
Date:   Tue Jul 13 05:33:35 2010 +1000

    man pages: update authors and copyright notice for libvirtd and virsh

    This patch removes the individual author names from the libvirtd and virsh
    man pages, instead referring to the main AUTHORS file distributed with
    libvirt.  This approach is needed, as we can't guarantee unicode support
    across all versions of pod2man used with libvirt.

    Additionally, this patch includes the libvirtd man page in the spec file
    used with "make rpm".  Without this patch "make rpm" is broken.

Comment 9 Jiri Denemark 2011-01-09 23:57:53 UTC
Built into libvirt-0.8.7-1.el6

Comment 10 Cui Chun 2011-01-10 10:24:34 UTC
Verified. Passed. 

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. # man libvirtd
 manual page can be shown correctly.

2.compare manual page with libvirtd help
  All options has been descripted in manual page.

Comment 12 Cui Chun 2011-02-01 02:32:50 UTC
Rechecked it on the following test environment according to comment 10. It is passed.

Test environment:
libvirt-0.8.7-4.el6
qemu-kvm-0.12.1.2-2.132.el6
kernel-2.6.32-94.el6

Comment 17 errata-xmlrpc 2011-05-19 13:18:55 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