Bug 1093988

Hi Yaniv,

Thank you for creating this bug.

I have created a draft of the man page, and just need to smooth out a few details and formatting and I should be able to post a copy of it here for you.

I have one question about part of the content - who would you like me to add to the author group?

Let me know if you have a preference, and I will update the file and get it to you.

Kind regards,

Andrew

It doesn't matter much, we will update it later or I'll comment on the patch itself when you post it

Created attachment 892728 [details]
vdsm-tool man page

Hi Yaniv,

Attached is the man page file for the vdsm-tool.

1. The text used is taken from the output for the command, which I have edited
   a little in some places to ensure overall consistency.

2. The man page type (1) reflects that of other, similar command line tools 
   such as vdsClient.

3. The copyright date and type are taken from the details in the vdsm-tool 
   source files.

4. The author group has been left blank for now, and contains only a 
   placeholder - <Author group>.

Please let me know if you have any questions!

Kind regards,

Andrew

first, i just want to note that we intend to do more improvement to the tool arguments. such as -verbos and -logfile for the vdsm-tool call. those might require update. 

second, each subcommand, like configure, has its own parameters, which are not stated at all. if you call 'vdsm-tool configure -h' you should see it. maybe we should also add it in recursively for all command

Hi Yaniv,

Thank you for your feedback.

Understood - will there be a set date after which I can write up the finalized options for the tool?

For now, I will look into adding a description of each of the parameters for the options, and will upload the finished version when the work on the tool has finished up.

Thanks once again!

Kind regards,

Andrew

Hey Andrew, 
No need for extra work! please hold.. we are currently working on few patches to improve the output. first I propose to patch in [1] and see the output. I attached it here.

we plan to take in also [2] which adds -v and -l to vdsm-tool root parameters.

[1] http://gerrit.ovirt.org/#/c/26575
[2] http://gerrit.ovirt.org/#/c/27481

take a look! it will be merged soon

Created attachment 894550 [details]
full output

Hi Yaniv,

Thank you for the update!

Understood - thank you for posting the attachment! I will hold off on further changes for now, and will keep an eye on the two patches in Comment #6. 

Please let me know when you are ready for the man page file to be updated and I will work with the updated options for vdsm-tool. Otherwise, please me know if there is anything at all you would like me to do! :)

Kind regards,

Andrew

Andrew, the documentation changes merged to master branch. please grab latest code and post a patch with updated manual page if possible

Hi Yaniv,

Thank you for the update!

Would you like me to post an actual patch to gerrit, or is it ok just to provide the man page as a file like my previous attachment?

I will get to work on updating the man page.

Kind regards,

Andrew

Hi Yaniv,

I have updated the man page and added the file to the make files and spec file so that the man page is now installed alongside the vdsm-python package.

The following oVirt gerrit contains the changes:

[1] http://gerrit.ovirt.org/#/c/28196/

Let me know if there is anything else I can do for you!

Kind regards,

Andrew

thanks. under review

ok

# rpm -qld vdsm-python
/usr/share/man/man1/vdsm-tool.1.gz
# rpm -q vdsm
vdsm-4.16.5-2.el6ev.x86_64

oVirt 3.6.0 has been released on November 4th, 2015 and should fix this issue.
If problems still persist, please open a new BZ and reference this one.