Bug 1246882

Summary: man virt-customize shows synopsis twice
Product: [Fedora] Fedora Reporter: Chris Murphy <bugzilla>
Component: libguestfsAssignee: Richard W.M. Jones <rjones>
Status: CLOSED UPSTREAM QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 22CC: mbooth, ptoscano, rjones, virt-maint
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2015-07-28 13:13:33 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 Chris Murphy 2015-07-26 15:56:15 UTC
Description of problem:


Version-Release number of selected component (if applicable):
libguestfs-tools-1.29.50-1.fc22.noarch

How reproducible:
Always


Steps to Reproduce:
1. man virt-customize
2.
3.

Actual results:

SYNOPSIS
        virt-customize [--options] -d domname
           [--chmod PERMISSIONS:FILE] [--commands-from-file FILENAME]
           [--copy SOURCE:DEST] [--copy-in LOCALPATH:REMOTEDIR]
           [--delete PATH] [--edit FILE:EXPR] [--firstboot SCRIPT]
           [--firstboot-command 'CMD+ARGS'] [--firstboot-install PKG,PKG..]
           [--hostname HOSTNAME] [--install PKG,PKG..]
           [--link TARGET:LINK[:LINK..]] [--mkdir DIR] [--move SOURCE:DEST]
           [--password USER:SELECTOR] [--root-password SELECTOR]
           [--run SCRIPT] [--run-command 'CMD+ARGS'] [--scrub FILE]
           [--ssh-inject USER[:SELECTOR]] [--truncate FILE]
           [--truncate-recursive PATH] [--timezone TIMEZONE] [--touch FILE]
           [--update] [--upload FILE:DEST] [--write FILE:CONTENT]
           [--no-logfile] [--password-crypto md5|sha256|sha512]
           [--selinux-relabel]

        virt-customize [--options] -a disk.img [-a disk.img ...]
           [--chmod PERMISSIONS:FILE] [--commands-from-file FILENAME]
           [--copy SOURCE:DEST] [--copy-in LOCALPATH:REMOTEDIR]
           [--delete PATH] [--edit FILE:EXPR] [--firstboot SCRIPT]
           [--firstboot-command 'CMD+ARGS'] [--firstboot-install PKG,PKG..]
           [--hostname HOSTNAME] [--install PKG,PKG..]
           [--link TARGET:LINK[:LINK..]] [--mkdir DIR] [--move SOURCE:DEST]
           [--password USER:SELECTOR] [--root-password SELECTOR]
           [--run SCRIPT] [--run-command 'CMD+ARGS'] [--scrub FILE]
           [--ssh-inject USER[:SELECTOR]] [--truncate FILE]
           [--truncate-recursive PATH] [--timezone TIMEZONE] [--touch FILE]
           [--update] [--upload FILE:DEST] [--write FILE:CONTENT]
           [--no-logfile] [--password-crypto md5|sha256|sha512]
           [--selinux-relabel]



Expected results:

Once is better.

Additional info:

Comment 1 Pino Toscano 2015-07-27 06:51:01 UTC
(In reply to Chris Murphy from comment #0)
> SYNOPSIS
>         virt-customize [--options] -d domname
> [...]
> 
>         virt-customize [--options] -a disk.img [-a disk.img ...]
> [...]

It is not repeated twice the same, but showing respectively the case for a libvirt domain and for local disk images.

Comment 2 Richard W.M. Jones 2015-07-27 12:32:18 UTC
I don't believe this is a bug either.  However to reduce confusion
I have posted this patch:

https://www.redhat.com/archives/libguestfs/2015-July/msg00147.html

After applying this patch the synopsis looks like this:

SYNOPSIS
        virt-customize [--options]
           [ -d domname | -a disk.img [-a disk.img ...] ]
           [--chmod PERMISSIONS:FILE] [--commands-from-file FILENAME]
           [--copy SOURCE:DEST] [--copy-in LOCALPATH:REMOTEDIR]
           [--delete PATH] [--edit FILE:EXPR] [--firstboot SCRIPT]
           [--firstboot-command 'CMD+ARGS'] [--firstboot-install PKG,PKG..]
           [--hostname HOSTNAME] [--install PKG,PKG..]
           [--link TARGET:LINK[:LINK..]] [--mkdir DIR] [--move SOURCE:DEST]
           [--password USER:SELECTOR] [--root-password SELECTOR]
           [--run SCRIPT] [--run-command 'CMD+ARGS'] [--scrub FILE]
           [--sm-attach SELECTOR] [--sm-register] [--sm-remove]
           [--sm-unregister] [--ssh-inject USER[:SELECTOR]] [--truncate FILE]
           [--truncate-recursive PATH] [--timezone TIMEZONE] [--touch FILE]
           [--update] [--upload FILE:DEST] [--write FILE:CONTENT]
           [--no-logfile] [--password-crypto md5|sha256|sha512]
           [--selinux-relabel] [--sm-credentials SELECTOR]

Comment 3 Richard W.M. Jones 2015-07-28 13:13:33 UTC
Upstream in commit dbbf4b8afe305a284963675cf640e3f2ac523d98.