Bug 1365004

Summary: Regenerate docs while building downstream package
Product: Red Hat Enterprise Linux 7 Reporter: Michal Privoznik <mprivozn>
Component: libvirtAssignee: Michal Privoznik <mprivozn>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.3CC: dyuan, pzhang, rbalakri
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: libvirt-2.0.0-5.el7 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-11-03 18:51:56 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Michal Privoznik 2016-08-08 11:04:07 UTC
Description of problem:
Even though downstream libvirt has gained support for multiple devices, the docs doesn't reflect that. Debugging the issue led to the following upstream commit:

commit e396de03f31d87f3e81c7820739951d50367ddb8
Author:     Michal Privoznik <mprivozn>
AuthorDate: Mon Aug 8 11:36:01 2016 +0200
Commit:     Michal Privoznik <mprivozn>
CommitDate: Mon Aug 8 11:49:35 2016 +0200

    docs: Distribute subsite.xsl
    
    So, I've ran into very interesting problem lately. When doing the
    following, I've encountered an error:
    
      libvirt.git $ make dist && tar -xJf libvirt-2.2.0.tar.xz && \
                    cd libvirt-2.2.0 && ./configure && \
                    rm docs/formatdomain.html && make -C docs
    
      make: Entering directory 'docs'
      make: *** No rule to make target 'formatdomain.html', needed by 'web'.  Stop.
      make: Leaving directory 'docs'
    
    I had no idea what was going on, so I've nailed down the commit
    that "broke it" via running git-bisect. It was this one:
    7659bd9221b9dd1cdf. But that shed no more light until I realized
    that the commit might actually just exposed a problem we had. And
    guess what - I've nailed it down. Of course we are not
    distributing subsite.xsl that's why make prints error message.
    Very misleading one I must say.
    
    Signed-off-by: Michal Privoznik <mprivozn>



However, in order to fix the issue in downstream package, we need a bug too.

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

libvirt-2.0.0-4.el7

How reproducible:

100 %

Steps to Reproduce:
1. Install latest libvirt
2. Check that a feature is there and works (e.g. iommu device - bug 1235581)
3. Observe missing no reference to the feature in libvirt-docs

Actual results:
IOMMU device is not mentioned in libvirt-docs.


Expected results:
IOMMU device is mentioned in libvirt-docs.


Additional info:

Comment 3 Pei Zhang 2016-08-26 06:27:11 UTC
Verified version :
libvirt-2.0.0-6.el7

I can reproduce and verify it like following :

1. Install libvirt-2.0.0-4.el7, check there is no IOMMU related info in doc

# rpm -q libvirt-docs
libvirt-docs-2.0.0-4.el7.x86_64

# cat /usr/share/doc/libvirt-docs-2.0.0/html/formatdomain.html | grep IOMMU


2. Install libvirt-2.0.0-6.el7, check there is information about IOMMU.

# rpm -q libvirt-docs
libvirt-docs-2.0.0-6.el7.x86_64

# cat /usr/share/doc/libvirt-docs-2.0.0/html/formatdomain.html | grep IOMMU

                    <a href="#elementsIommu">IOMMU devices</a>
          <a name="elementsIommu" shape="rect" id="elementsIommu">IOMMU devices</a>
      The <code>iommu</code> element can be used to add an IOMMU device.
......

Move to verified.

Comment 5 errata-xmlrpc 2016-11-03 18:51:56 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://rhn.redhat.com/errata/RHSA-2016-2577.html