Bug 955539

Summary:	help info description for vol-upload is incorrect
Product:	Red Hat Enterprise Linux 6	Reporter:	Cui Lei <lcui>
Component:	libvirt	Assignee:	Ján Tomko <jtomko>
Status:	CLOSED ERRATA	QA Contact:	Virtualization Bugs <virt-bugs>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	6.4	CC:	cwei, dyuan, mzhan, rbalakri, xuzhang, yanyang
Target Milestone:	rc	Keywords:	Upstream
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	libvirt-0.10.2-31.el6	Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:	955537	Environment:
Last Closed:	2014-10-14 04:15:56 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:	955537
Bug Blocks:

Description Cui Lei 2013-04-23 09:15:52 UTC

The issue is still on RHEL6
+++ This bug was initially created as a clone of Bug #955537 +++

Description of problem:
#virsh help vol-upload
...
DESCRIPTION
    Upload a file into a volume
...
#man virsh and check the vol-upload part
"Upload the contents of local-file to a storage volume."

Help info description for vol-upload is incorrect, should use 'contents' instead of 'file', and consistent with manual doc



'vol-download' will not wipe the volume. We can see it from 'virsh-volume.c' and 'libvirt.c'(virStorageVolDownload).
But the manpage says: vol-name-or-key-or-path is the name or key or path of the volume to wipe.
In fact, ‘vol-upload’ will wipe the volume.

Version-Release number of selected component (if applicable):
libvirt-1.0.4-1.el7.x86_64

How reproducible:
100%

Steps to Reproduce:
1. #virsh help vol-upload
2. #man virsh and check the vol-upload part

Actual results:
Both of the description of virsh vol-upload are different, help info description is incorrect
Expected results:
Should use 'contents' instead of 'file', and consistent with manual doc

Additional info

Comment 1 Ján Tomko 2013-04-30 12:42:01 UTC

man page has been fixed fixed upstream by:
commit 11e295705a4c19aee71ab6bb9334b31174adbcd1
Author:     Martin Kletzander <mkletzan>
AuthorDate: 2013-04-02 14:33:49 +0200
Commit:     Martin Kletzander <mkletzan>
CommitDate: 2013-04-02 17:06:40 +0200

    manual: Fix copy-paste errors
    
    Descriptions for vol-download and vol-upload didn't make much sense.
    
    Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=923613


help description has been fixed by:
commit ce284bb56dce0c35ec3e3bf3f019bca67ae0fab8
Author:     Ján Tomko <jtomko>
AuthorDate: 2013-04-30 14:19:49 +0200
Commit:     Ján Tomko <jtomko>
CommitDate: 2013-04-30 14:19:49 +0200

    virsh: clarify vol-{down,up}load description
    
    Mention file/volume contents instead of just 'file'/'volume'.

Comment 2 Jiri Denemark 2013-06-11 10:07:03 UTC

We decided not to rebase libvirt in RHEL 6.5 to avoid stability issues
we faced in 6.4. This bug has already been trivially fixed upstream but
it is not considered important enough to be backported to RHEL 6.5.

Thus I'm pushing this bug to RHEL 6.6 (and setting Upstream keyword to
indicate we have patches upstream) for now. If you don't agree with
this resolution, please, give us reasons which you think are strong
enough for us to reevaluate the decision not to backport patches for
this bug.

Comment 7 Yang Yang 2014-07-14 07:50:44 UTC

The bug is verified in libvirt-0.10.2-40.el6.x86_64

Steps:
1. # virsh help vol-upload
  NAME
    vol-upload - upload file contents to a volume

  SYNOPSIS
    vol-upload <vol> <file> [--pool <string>] [--offset <number>] [--length <number>]

  DESCRIPTION
    Upload file contents to a volume

  OPTIONS
    [--vol] <string>  vol name, key or path
    [--file] <string>  file
    --pool <string>  pool name or uuid
    --offset <number>  volume offset to upload to
    --length <number>  amount of data to upload

2. # virsh help vol-download
  NAME
    vol-download - download volume contents to a file

  SYNOPSIS
    vol-download <vol> <file> [--pool <string>] [--offset <number>] [--length <number>]

  DESCRIPTION
    Download volume contents to a file

  OPTIONS
    [--vol] <string>  vol name, key or path
    [--file] <string>  file
    --pool <string>  pool name or uuid
    --offset <number>  volume offset to download from
    --length <number>  amount of data to download

The file/volume is replaced by {file,volume} contents. And in vol-download help page, "Download" is replaced by "download".
So set the bug to verified.

Comment 9 errata-xmlrpc 2014-10-14 04:15:56 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/RHBA-2014-1374.html