Bug 1668239

Summary:	[man page] Gluster(8) - Missing disperse-data parameter Gluster Console Manager man page
Product:	[Community] GlusterFS	Reporter:	Shriya Mulay <smulay>
Component:	disperse	Assignee:	bugs <bugs>
Status:	CLOSED NEXTRELEASE	QA Contact:
Severity:	medium	Docs Contact:
Priority:	medium
Version:	mainline	CC:	bugs
Target Milestone:	---	Keywords:	EasyFix, Triaged
Target Release:	---
Hardware:	All
OS:	Linux
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:	1667954	Environment:
Last Closed:	2020-02-18 11:55:44 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:
Bug Depends On:
Bug Blocks:	1667954

Description Shriya Mulay 2019-01-22 09:44:29 UTC

+++ This bug was initially created as a clone of Bug #1667954 +++

Document URL: 

man 8 gluster

Section Number and Name: 

COMMANDS -> Volume Commands

Describe the issue: 

No man-page reference for `disperse-data` parameter when creating a new volume (gluster(8)):
---
        volume create <NEW-VOLNAME> [stripe <COUNT>] [replica <COUNT>] [disperse [<COUNT>]] [redundancy <COUNT>] [transport <tcp|rdma|tcp,rdma>] <NEW-BRICK> ...
              Create a new volume of the specified type using the specified bricks and transport type (the default transport type is tcp).  To create a volume  with  both  transports  (tcp  and  rdma),  give
              'transport tcp,rdma' as an option.
---

However "Usage:" message shows disperse-data:
---
volume create <NEW-VOLNAME> [stripe <COUNT>] [replica <COUNT> [arbiter <COUNT>]] [disperse [<COUNT>]] [disperse-data <COUNT>] [redundancy <COUNT>] [transport <tcp|rdma|tcp,rdma>] <NEW-BRICK>?<vg_name>... [force]
---

Suggestions for improvement: 

Add disperse-data to "man 8 gluster" explaining its utilization scenario.

Additional information:

If this bug should be proposed for a different release, please manually change the proposed release flag.

Comment 1 Worker Ant 2019-08-18 12:48:55 UTC

REVIEW: https://review.gluster.org/23258 (Updating gluster 8 manual.) posted (#1) for review on master by Rishubh Jain

Comment 2 Rishubh Jain 2019-08-18 12:54:43 UTC

https://review.gluster.org/#/c/glusterfs/+/23258 Updates the gluster manual with 'disperse-data <count>' but does not include details about utilization scenerio. Please refer here[https://access.redhat.com/documentation/en-us/red_hat_gluster_storage/3.1/html/administration_guide/chap-red_hat_storage_volumes-creating_dispersed_volumes_1] for the utilization scenerio.

Comment 4 Worker Ant 2020-02-18 11:55:44 UTC

REVIEW: https://review.gluster.org/23258 (Updating gluster manual.) merged (#4) on master by Pranith Kumar Karampuri