After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 755300 - "Share the clipboard" page should add information on spice packages needed
"Share the clipboard" page should add information on spice packages needed
Status: RESOLVED FIXED
Product: gnome-boxes
Classification: Applications
Component: documentation
3.16.x
Other Linux
: Normal normal
: --
Assigned To: Maintainers of Gnome user documentation
GNOME Boxes maintainer(s)
Depends on:
Blocks:
 
 
Reported: 2015-09-20 13:02 UTC by Federico Bruni
Modified: 2016-09-20 08:15 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
created with `git format-patch` (967 bytes, patch)
2015-09-21 21:19 UTC, Federico Bruni
none Details | Review
second patch (1.17 KB, patch)
2015-09-22 23:08 UTC, Federico Bruni
none Details | Review
third patch (1.30 KB, patch)
2015-09-23 21:26 UTC, Federico Bruni
committed Details | Review

Description Federico Bruni 2015-09-20 13:02:29 UTC
This page is too much concise:
https://help.gnome.org/users/gnome-boxes/stable/clipboard.html.en

I would add which spice packages are needed to make it work.
I've just verified that the guest machine must have spice-vdagent installed. I would add a note about it.

In the host I have these packages installed:

# dnf list installed spice*
Last metadata expiration check performed 3:26:46 ago on Sun Sep 20 11:33:42 2015.
Installed Packages
spice-glib.x86_64                                   0.29-1.fc22                                  @System
spice-gtk3.x86_64                                   0.29-1.fc22                                  @System
spice-server.x86_64                                 0.12.5-6.fc22                                @System
spice-vdagent.x86_64                                0.15.0-3.fc22                                @System
Comment 1 Zeeshan Ali 2015-09-21 13:11:44 UTC
(In reply to Federico Bruni from comment #0)
> This page is too much concise:
> https://help.gnome.org/users/gnome-boxes/stable/clipboard.html.en
> 
> I would add which spice packages are needed to make it work.
> I've just verified that the guest machine must have spice-vdagent installed.
> I would add a note about it.

Sure but our help pages aren't even correct in many places, unfortunately. We haven't received much love from the under-resourced docs team for a while. :( If you could help in this regard, that would be lovely.

> In the host I have these packages installed:
> 
> # dnf list installed spice*
> Last metadata expiration check performed 3:26:46 ago on Sun Sep 20 11:33:42
> 2015.
> Installed Packages
> spice-glib.x86_64                                   0.29-1.fc22             
> @System
> spice-gtk3.x86_64                                   0.29-1.fc22             
> @System
> spice-server.x86_64                                 0.12.5-6.fc22           
> @System
> spice-vdagent.x86_64                                0.15.0-3.fc22           
> @System

You need spice-vdagent in the guest and not at all in the host, the rest are needed on host but your distro should take care of that through package dependencies.
Comment 2 Zeeshan Ali 2015-09-21 13:13:56 UTC
BTW, would be nice if distros would install install spice-vdagent by default if running under a VM. At least the systemd ones that can easily find that info through systemd-detect-virt command.
Comment 3 Federico Bruni 2015-09-21 21:19:30 UTC
Created attachment 311805 [details] [review]
created with `git format-patch`

I have a poor knowledge of Mallard and english is not my first language, but I hope that it's better than nothing.
Let me know if you want to change something.
Comment 4 Zeeshan Ali 2015-09-22 12:42:04 UTC
Review of attachment 311805 [details] [review]:

Actually pretty good for a first patch. Some comments below:

Please follow these guidelines that best you can for commit messages: https://wiki.gnome.org/Git/CommitMessages

::: help/C/clipboard.page
@@ +37,3 @@
+    <em>spice-vdagent</em>. If the guest is running a different operating
+    system, check out the <link href="http://www.spice-space.org/download.html">
+    SPICE download page</link>.</p>

Looks good but you want to mention that express installation handles this for you. I'd start with that actually: "While express installations typically takes care of making copy&paste available to you, express installation is not available for all operating systems. In such cases or if you choose manual installation,.."
Comment 5 Federico Bruni 2015-09-22 23:08:38 UTC
Created attachment 311914 [details] [review]
second patch

ok, I've tried to follow your advice
Comment 6 Zeeshan Ali 2015-09-23 11:50:51 UTC
Review of attachment 311914 [details] [review]:

Almost there. I could have fixed the patch for you but you know that thing they say "give a man a fish and you feed him for a day; teach a man to fish..". :)

Shortlog is still longer than 50 chars while it can easily be less if you summarize and make use of details section to explain, if you like.

::: help/C/clipboard.page
@@ +33,3 @@
 
+  <note style="important">
+    <p>While express installation typically takes care of making copy and

"copy and paste" needs to be put inside quotes or written copy&paste. I'll just write "shared clipboard" instead.

@@ +36,3 @@
+    paste available to you, express installation is not available for all
+    operating systems. In such cases or if you choose manual installation,
+    the SPICE vdagent must be installed in the guest. In most Linux

"must be" sounds too strong. I'd "needs to be installed" and I'll prepend " for shared clipboard to work" to be completely clear.

@@ +37,3 @@
+    operating systems. In such cases or if you choose manual installation,
+    the SPICE vdagent must be installed in the guest. In most Linux
+    distributions the package is called <em>spice-vdagent</em>. If the

"distribution" is a bit geeky these days, they are just operating systems, with same base. I'd write "Linux-based operating systems".
Comment 7 Federico Bruni 2015-09-23 21:26:12 UTC
Created attachment 311986 [details] [review]
third patch

thanks for the review
find attached the third patch
Comment 8 Zeeshan Ali 2015-09-24 13:48:07 UTC
Review of attachment 311986 [details] [review]:

Looks good, just a tiny nitpick that I'll fix before pusing: The shortlog now doesn't actually say anything. I'll modify it to "help: Add note about spice-vdagent".
Comment 9 Zeeshan Ali 2015-09-24 13:53:15 UTC
Pushed the patch with minor fixes. Not sure how helpful it is, given the rest of the info on that page is not correct.