Bug 1668239 - [man page] Gluster(8) - Missing disperse-data parameter Gluster Console Manager man page
Summary: [man page] Gluster(8) - Missing disperse-data parameter Gluster Console Manag...
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: GlusterFS
Classification: Community
Component: disperse
Version: mainline
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: bugs@gluster.org
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks: 1667954
TreeView+ depends on / blocked
 
Reported: 2019-01-22 09:44 UTC by Shriya Mulay
Modified: 2020-02-18 11:55 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of: 1667954
Environment:
Last Closed: 2020-02-18 11:55:44 UTC
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Gluster.org Gerrit 23258 0 None Merged Updating gluster manual. 2020-02-18 11:55:43 UTC

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


Note You need to log in before you can comment on or make changes to this bug.