Bug 596354

Summary: guestfish.1.html and guestfs.3.html declared "XHTML 1.0 Strict" but are not in fact well-formed XML
Product: [Community] Virtualization Tools Reporter: Richard W.M. Jones <rjones>
Component: libguestfsAssignee: Richard W.M. Jones <rjones>
Status: CLOSED UPSTREAM QA Contact:
Severity: low Docs Contact:
Priority: low    
Version: unspecifiedCC: mbooth, virt-maint
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-11-30 15:12:52 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:
Attachments:
Description Flags
Validation errors in guestfish.1.html
none
Validation errors in guestfs.3.html none

Description Richard W.M. Jones 2010-05-26 16:14:50 UTC
Description of problem:

Using xmllint to validate these two files gives the
errors which I will attach.

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

libguestfs 1.3.16

How reproducible:

Always.

Steps to Reproduce:
1. xmllint --valid /usr/share/doc/libguestfs-devel-1.3.16/guestfs.3.html > /dev/null
2. xmllint --valid /usr/share/doc/guestfish-1.3.16/guestfish.1.html > /dev/null
3.
  
Actual results:

Validation errors.

Expected results:

Should be strict XHTML.

Additional info:

Comment 1 Richard W.M. Jones 2010-05-26 16:21:26 UTC
Created attachment 416913 [details]
Validation errors in guestfish.1.html

Comment 2 Richard W.M. Jones 2010-05-26 16:21:49 UTC
Created attachment 416915 [details]
Validation errors in guestfs.3.html

Comment 3 Richard W.M. Jones 2012-11-30 15:12:52 UTC
Since this commit we are no longer claiming that the HTML
files are Strict.  (In fact, the Perl class doesn't even
bother adding a DOCTYPE at all).

commit 1e17a32060feb937b3972f61b37f9116ad7d8d9a
Author: Richard W.M. Jones <rjones>
Date:   Mon Jul 16 19:41:39 2012 +0100

    Replace podwrapper shell script with custom Perl script.
    
    This uses Pod::Simple so it properly parses the input POD and can
    generate proper custom output as required specifically by libguestfs.
    
    One immediate benefit is that links between and within manual pages
    now work mostly correctly.