Bug 870273
| Summary: | coding errors in virsh man page | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 6 | Reporter: | yanbing du <ydu> |
| Component: | libvirt | Assignee: | Jiri Denemark <jdenemar> |
| Status: | CLOSED ERRATA | QA Contact: | Virtualization Bugs <virt-bugs> |
| Severity: | low | Docs Contact: | |
| Priority: | low | ||
| Version: | 6.4 | CC: | acathrow, dallan, dyasny, dyuan, eblake, mzhan, rwu, yupzhang |
| Target Milestone: | rc | ||
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | libvirt-0.10.2-6.el6 | Doc Type: | Bug Fix |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2013-02-21 07:11:08 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: | |||
Fixed upstream by v1.0.0-rc1-18-g61299a1:
commit 61299a1c983a64c7e0337b94232fdd2d42c1f4f2
Author: Jiri Denemark <jdenemar>
Date: Fri Oct 26 12:25:14 2012 +0200
virsh: Fix POD syntax
The first two hunks fix "Unterminated I<...> sequence" error and the
last one fixes "’=item’ outside of any ’=over’" error.
I'm tired of this repeatedly happening. We need to also fix the Makefile to grep for 'POD ERRORS' after creating the man page, and fail the build loudly at that point, rather than letting this sneak through. (In reply to comment #3) > I'm tired of this repeatedly happening. We need to also fix the Makefile to > grep for 'POD ERRORS' after creating the man page, and fail the build loudly > at that point, rather than letting this sneak through. Yeah, agreed these kinds of problems should not pop up at all. (In reply to comment #3) > I'm tired of this repeatedly happening. We need to also fix the Makefile to > grep for 'POD ERRORS' after creating the man page, and fail the build loudly > at that point, rather than letting this sneak through. https://www.redhat.com/archives/libvir-list/2012-October/msg01596.html Verified this issue with libvirt-0.10.2-6.el6.x86_64.
#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/>
libvirt-0.10.2 2012-10-29 VIRSH(1)
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. http://rhn.redhat.com/errata/RHSA-2013-0276.html |
Description of problem: There's a 'POD ERRORS' item at the end of virsh man page: #man virsh ... SEE ALSO virt-install(1), virt-xml-validate(1), virt-top(1), virt-df(1), <http://www.libvirt.org/> POD ERRORS Hey! The above document had some coding errors, which are explained below: Around line 730: Unterminated I<...> sequence Around line 771: Unterminated I<...> sequence Around line 2927: ’=item’ outside of any ’=over’ libvirt-0.10.2 2012-10-23 VIRSH(1) (END) Version-Release number of selected component (if applicable): libvirt-0.10.2-5.el6.x86_64 How reproducible: 100% Steps to Reproduce: 1.#man virsh 2. 3. Actual results: Expected results: No such errors. Additional info: