870273 – coding errors in virsh man page

RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 870273 - coding errors in virsh man page

Summary: coding errors in virsh man page

Keywords:
Status:	CLOSED ERRATA
Alias:	None
Product:	Red Hat Enterprise Linux 6
Classification:	Red Hat
Component:	libvirt
Sub Component:
Version:	6.4
Hardware:	Unspecified
OS:	Unspecified
Priority:	low
Severity:	low
Target Milestone:	rc
Target Release:	---
Assignee:	Jiri Denemark
QA Contact:	Virtualization Bugs
Docs Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+	depends on / blocked

Reported:	2012-10-26 02:30 UTC by yanbing du
Modified:	2013-02-21 07:11 UTC (History)
CC List:	8 users (show)
Fixed In Version:	libvirt-0.10.2-6.el6
Doc Type:	Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed:	2013-02-21 07:11:08 UTC
Target Upstream Version:
Embargoed:

Attachments	(Terms of Use)

Links
System	ID	Private	Priority	Status	Summary	Last Updated
Red Hat Product Errata	RHSA-2013:0276	0	normal	SHIPPED_LIVE	Moderate: libvirt security, bug fix, and enhancement update	2013-02-20 21:18:26 UTC

Description yanbing du 2012-10-26 02:30:14 UTC

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:

Comment 2 Jiri Denemark 2012-10-26 11:48:57 UTC

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.

Comment 3 Eric Blake 2012-10-26 14:20:21 UTC

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.

Comment 4 Dave Allan 2012-10-26 14:55:36 UTC

(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.

Comment 5 Eric Blake 2012-10-26 16:07:54 UTC

(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

Comment 6 Jiri Denemark 2012-10-29 08:55:50 UTC

In POST: http://post-office.corp.redhat.com/archives/rhvirt-patches/2012-October/msg01188.html

Comment 7 yuping zhang 2012-10-30 05:41:56 UTC

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)

Comment 9 yuping zhang 2012-10-30 07:20:11 UTC

Change the bug status to VERIFIED as comment 7.

Comment 10 errata-xmlrpc 2013-02-21 07:11:08 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.

http://rhn.redhat.com/errata/RHSA-2013-0276.html

Note You need to log in before you can comment on or make changes to this bug.