Bug 1362025

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

Description of problem
======================

GlusterFS command line tool `glusterfs` has (so far) undocumented output
option `--xml` which servers as a stable machine readable output format.
Unless we have really good reason to keep this secret, we should consider
to document this feature properly.

Moreover Storage QE seems to already use this feature.

Version-Release number of selected component (if applicable)
============================================================

Red Hat Storage 3 Administration Guide (from documentation-devel)
glusterfs man pages (glusterfs-3.6.0.11-1.el6rhs.x86_64)

--- Additional comment from Stanislav Graf on 2014-08-12 10:20:55 EDT ---

Setting 3.1 instead of generic rhs-future as a proposal for acks, resetting acks. I think QE would be OK to move it also to 3.0.1 if there will be time for it.

--- Additional comment from Nagaprasad Sathyanarayana on 2015-03-26 08:30:46 EDT ---

After having triaged, it was agreed by all leads that this BZ can not be fixed for 3.1.0 release.

--- Additional comment from Anjana Suparna Sriram on 2015-08-11 05:15:29 EDT ---

Hi Martin,

Are you suggesting that a new man page needs to be created or the Admin Guide needs to be updated?

--- Additional comment from Martin Bukatovic on 2015-08-11 05:35:03 EDT ---

I think that updating man page gluster(8) (so that --xml flag is described) is
a must have. And since this feature could be easily missed, it would also make
sense to mention it in the Admin Guide - short note would be enough.

Also I noticed I made a mistake in the description of this BZ, the cli tool is
`gluster` and so related man page is gluster.8.gz from glusterfs-cli package.

--- Additional comment from Red Hat Bugzilla Rules Engine on 2015-09-09 04:35:32 EDT ---

Since this bug does not have release flag 'rhgs-3.1.z+', the Target Release is being automatically reset to '---'

--- Additional comment from Rejy M Cyriac on 2015-09-11 03:51:04 EDT ---

Changed component as per observation recorded at Comment 4

--- Additional comment from Anjana Suparna Sriram on 2016-01-14 03:04:16 EST ---

Kaushal,

This bug does not pertain to documentation. Please review Comment 4.

Regards,
Anjana

--- Additional comment from Kaushal on 2016-01-18 04:42:31 EST ---

We need a separate component for man-pages, which are technically documentation. Since there isn't such a component now, I'd moved this to 'Documentation', which I assumed was for all general documentation bugs, not covered under the other 'doc_*' components.

--- Additional comment from Rejy M Cyriac on 2016-01-18 04:51:22 EST ---

(In reply to Kaushal from comment #8)
> We need a separate component for man-pages, which are technically
> documentation. Since there isn't such a component now, I'd moved this to
> 'Documentation', which I assumed was for all general documentation bugs, not
> covered under the other 'doc_*' components.

As per policy, the downstream components are based on package names, and so unless we have a downstream package for man-pages, the bugs on man-pages have to use the same component as for the package in which it is shipped. At the component, we could have separate sub-component for the man-pages if required though.

--- Additional comment from Laura Bailey on 2016-03-03 19:54:42 EST ---

Rejy, does comment 9 mean this should be moved to the glusterfs component?

--- Additional comment from Rejy M Cyriac on 2016-03-04 07:09:41 EST ---

(In reply to Laura Bailey from comment #10)
> Rejy, does comment 9 mean this should be moved to the glusterfs component?

That is what I believe to be the right one. I have set it to that component.

Atin,

This is a pretty old bug. Is the issue still valid ? If so, being a 'man' page fix, I suspect it could be done easily.

Could this be fixed for RHGS 3.1.3 ?

--- Additional comment from Atin Mukherjee on 2016-08-01 02:04:15 EDT ---

http://review.gluster.org/15027 is merged in mainline. Moving the state to POST.