Bug 1083786
| Summary: | remote-viewer should add introduction for new added functions into man page and help info. | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Linux 6 | Reporter: | CongDong <codong> |
| Component: | virt-viewer | Assignee: | Virt Viewer Maint <virt-viewer-maint> |
| Status: | CLOSED ERRATA | QA Contact: | Virtualization Bugs <virt-bugs> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 6.6 | CC: | cfergeau, dblechte, dyuan, fidencio, gkong, jjongsma, juzhou, marcandre.lureau, mjenner, mzhan, rbalakri, tzheng |
| Target Milestone: | rc | ||
| Target Release: | --- | ||
| Hardware: | x86_64 | ||
| OS: | Linux | ||
| Whiteboard: | |||
| Fixed In Version: | virt-viewer-2.0-1.el6 | Doc Type: | Bug Fix |
| Doc Text: |
No doc needed
|
Story Points: | --- |
| Clone Of: | 970825 | Environment: | |
| Last Closed: | 2015-07-22 06:30: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: | 970825, 1179477 | ||
| Bug Blocks: | |||
|
Comment 3
Jonathon Jongsma
2015-02-09 16:37:03 UTC
I can reproduce this issue with package:
virt-viewer-0.6.0-11.el6.x86_64
Then try to verify with new build:
virt-viewer-2.0-2.el6.x86_64
Steps:
1. check remote-viewer manual page:
...
CONNECTION FILE
remote-viewer connection file is of INI file format, with a mandatory [virt-viewer] group and "type" key.
Example
Opening a file with the following content will start remote-viewer in fullscreen and connect to the host "betsiboka" using the SPICE protocol:
[virt-viewer]
type=spice
host=betsiboka
port=5900
fullscreen=1
Result: Manual page is clear for user.
2. check remote-viewer help info:
# remote-viewer --help
Usage:
remote-viewer [OPTION...] URI|VV-FILE
Remote viewer client
Question: VV-FILE added, but the usage for remote-viewer are in two lines, but in old virt-viewer version(virt-viewer-0.6.0-11.el6.x86_64) they are in 1 line:
# remote-viewer --help
Usage:
remote-viewer [OPTION...] -- URI - Remote viewer client
and in rhel7(virt-viewer-0.6.0-12.el7.x86_64) it also in 1 line:
# remote-viewer --help
Usage:
remote-viewer [OPTION...] URI|VV-FILE - Remote viewer client
so do you think we will fix this issue in this or next virt-viewer version, thanks.
Since in Comment 5, # remote-viewer --help Usage: remote-viewer [OPTION...] URI|VV-FILE Remote viewer client ^ format is not clear to read Assigned this bug back, thanks. This was an intentional change: https://git.fedorahosted.org/cgit/virt-viewer.git/commit/?id=de3e27b3336bde25019ab50a54796b8b1926c6d9 Set help output summary correctly Use g_option_context_set_summary() to provide a brief description of the executable instead of tacking the summary onto the end of the commandline. Is it that unclear to read? Would it be better with something more descriptive than "Remote viewer client"? (In reply to Christophe Fergeau from comment #7) > This was an intentional change: > > https://git.fedorahosted.org/cgit/virt-viewer.git/commit/ > ?id=de3e27b3336bde25019ab50a54796b8b1926c6d9 > > Set help output summary correctly > > Use g_option_context_set_summary() to provide a brief description of the > executable instead of tacking the summary onto the end of the commandline. > > Is it that unclear to read? Would it be better with something more > descriptive than "Remote viewer client"? Thanks for your reply, i read the patch, since put them into 2 lines is by designed, so for me is ok. And according to Comment 5, move this bug to VERIFIED. 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://rhn.redhat.com/errata/RHBA-2015-1322.html |