Bug 1595624

Summary: Help/Man page update needed in 'gluster-block create'
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Sweta Anandpara <sanandpa>
Component: gluster-blockAssignee: Bhumika Goyal <bgoyal>
Status: CLOSED ERRATA QA Contact: Rachael <rgeorge>
Severity: medium Docs Contact:
Priority: high    
Version: cns-3.10CC: atumball, bgoyal, hchiramm, kramdoss, madam, pkarampu, prasanna.kalever, rhs-bugs, sanandpa, sankarshan, storage-qa-internal, vbellur, xiubli
Target Milestone: ---   
Target Release: OCS 3.11   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: gluster-block-0.2.1-27.el7rhgs Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-10-24 04:52:58 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:    
Bug Blocks: 1629575    

Description Sweta Anandpara 2018-06-27 08:44:33 UTC 
Description of problem:
======================
With the availability of new option to specify an (existing) storage file in gluster-block create command, the field 'size' is rendered optional when that particular field is given. 
Even if the field 'size' is given with 'storage' field, it errors out saying that size should not be specified.
// Hint: do not use <size> in combination with [storage <filename>] option

This has to be reflected correctly in man page and 'gluster-block create help' command.


Version-Release number of selected component (if applicable):
===============================================================
glusterfs-3.8.4-54.12
gluster-block-0.2.1-20


How reproducible:
=================
Always


Steps to Reproduce:
=====================
1. Execute "man gluster-block"
2. Execute "gluster-block create help"


Actual results:
===============
# gluster-block create help
argument '<volname/blockname>'(help) is incorrect
gluster-block create <volname/blockname> [ha <count>] [auth <enable|disable>] [prealloc <full|no>] [storage <filename>] [ring-buffer <size-in-MB-units>] <HOST1[,HOST2,...]> <size> [--json*]
# 
Man page: 
create <VOLNAME/NEW-BLOCKNAME> [ha <COUNT>] [auth <enable|disable>] [prealloc <full|no>] [storage <filename>] [ring-buffer <size-in-MB-units>] <HOST1[,HOST2,..]> <BYTES>

Expected results:
================= 
It is misleading to see <size> OR <bytes> as required field in both the views above.
Comment 3 Bhumika Goyal 2018-07-25 09:51:28 UTC 
PR posted here: https://github.com/gluster/gluster-block/pull/100/
Comment 4 Humble Chirammal 2018-09-19 07:29:51 UTC 
(In reply to Bhumika Goyal from comment #3)
> PR posted here: https://github.com/gluster/gluster-block/pull/100/

Can you provide Devel ack ?
Comment 12 errata-xmlrpc 2018-10-24 04:52:58 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/RHEA-2018:2987