Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.
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 1425306

Summary: typo error in virt-tail man page
Product: Red Hat Enterprise Linux 7 Reporter: Xianghua Chen <xchen>
Component: libguestfsAssignee: Richard W.M. Jones <rjones>
Status: CLOSED ERRATA QA Contact: Virtualization Bugs <virt-bugs>
Severity: low Docs Contact:
Priority: low    
Version: 7.4CC: ptoscano, wshi, xchen
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: libguestfs-1.36.1-1.el7 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-08-01 22:11:26 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:
Bug Depends On: 1359086    
Bug Blocks:    

Description Xianghua Chen 2017-02-21 07:24:31 UTC
Description of problem:
Typo error in virt-tail man page:

EXAMPLE
       Follow /var/log/messages inside a virtual machine called "mydomain":
        virt-tail -d mydomain /etc/fstab

The “/var/log/messages” should be consistent with "/etc/fstab".


Version-Release number of selected component (if applicable):
libguestfs-1.34.3-2.el7.x86_64
>From repo:  https://people.redhat.com/~rjones/libguestfs-RHEL-7.4-preview/

How reproducible:
100%

Steps:


Actual results:


Expected results:


Additional info:

Comment 1 Richard W.M. Jones 2017-02-21 08:30:57 UTC
I'm somewhat confused what the problem is here.  Can you describe
exactly what is the issue?

In any case, the original POD markup is correct:

=head1 EXAMPLE                                                                  
                                                                                
Follow F</var/log/messages> inside a virtual machine called C<mydomain>:        
                                                                                
 virt-tail -d mydomain /etc/fstab

Comment 2 Xianghua Chen 2017-02-21 09:20:35 UTC
(In reply to Richard W.M. Jones from comment #1)
> I'm somewhat confused what the problem is here.  Can you describe
> exactly what is the issue?
> 
> In any case, the original POD markup is correct:
> 
> =head1 EXAMPLE                                                              
> 
>                                                                             
> 
> Follow F</var/log/messages> inside a virtual machine called C<mydomain>:    
> 
>                                                                             
> 
>  virt-tail -d mydomain /etc/fstab

Shouldn't the “/var/log/messages” be consistent with "/etc/fstab"?
The example is saying that follow the file : /var/log/mesages, but the command line you use /etc/fstab , I think that would confuse the user.

Comment 3 Richard W.M. Jones 2017-02-21 11:25:35 UTC
/etc/fstab is in a verbatim section.

It all looks good in the HTML version:

http://libguestfs.org/virt-tail.1.html#example

I don't really think this is a bug.  It's just that the
text-based man page output doesn't have enough formatting
available to show verbatim sections in a different font.

Comment 4 Pino Toscano 2017-02-21 11:40:15 UTC
Rich: the issue is that the man page says "see how you can monitor /var/log/messages", but the example for it (which follows) mentions /etc/fstab.

Comment 5 Richard W.M. Jones 2017-02-21 12:07:44 UTC
Oh I see ...  yes, this is a bug, patch posted:

https://github.com/libguestfs/libguestfs/commit/2643c4d5f425b216d0d3fadee8f0f4ed69cfafba

Comment 7 Xianghua Chen 2017-03-28 06:18:27 UTC
Verify with packages:
libguestfs-1.36.2-3.el7.x86_64

Steps:
1.
# man virt-tail
... ...
EXAMPLE
       Follow /var/log/messages inside a virtual machine called "mydomain":

        virt-tail -d mydomain /var/log/messages



So verified.

Comment 8 errata-xmlrpc 2017-08-01 22:11:26 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://access.redhat.com/errata/RHBA-2017:2023