Commit Graph

56 Commits

Author SHA1 Message Date
Frediano Ziglio
12da078a9f docs: Add some documentation on spice threading model
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2017-09-11 18:03:57 +01:00
Pavel Grunt
11e04a100d manual: Remove outdated GL acceleration info
No need to reference a copr. Everything has been merged and relevant
component versions are mentioned.

Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2017-04-07 08:55:03 +02:00
Pavel Grunt
609b03e45d manual: Update folder sharing instruction
Link to the folder with latest releases and remove outdate info about
the service registration.

Acked-by: Victor Toso <victortoso@redhat.com>
2017-04-07 08:54:04 +02:00
Frediano Ziglio
7e395c3984 style: Change boolean style convention
Following
https://lists.freedesktop.org/archives/spice-devel/2017-February/035800.html
, the consensus was to use 'bool' rather than 'gboolean', and to use
true/false rather than TRUE/FALSE. New code should attempt to follow
the new style.

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2017-02-27 12:35:25 +00:00
Frediano Ziglio
5277ac8921 style: Group together indentation sections
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2017-02-27 11:53:37 +00:00
Jonathon Jongsma
790cf16d32 Manual: add info about QEMU_AUDIO_DRV
hramrach on IRC had an issue with audio not working. He was using
suse and his qemu defaulted to using the pulseaudio audio driver instead
of spice.  Explicitly setting the audio driver to spice using the
QEMU_AUDIO_DRV environment variable solved the problem. Add this tip to
the manual for others having the same issue in the future.
2016-12-05 15:46:33 -06:00
Jonathon Jongsma
4c99109329 Switch example sound device to 'hda'
Recommended sound device for newer operating systems is Intel HD audio
(hda). Use this in the commandline examples.
2016-12-05 15:46:33 -06:00
Uri Lublin
1f800090ef manual: usbredir: remove the note about usbclerk
The usbdk driver is preferred over usbclerk.

Signed-off-by: Uri Lublin <uril@redhat.com>
2016-12-01 12:08:32 +02:00
Uri Lublin
a668da95a4 manual: move usbdk to the client subsection
Also added "clients" to the sentence to make it clear
that usbdk is to be installed on the client machine.

Signed-off-by: Uri Lublin <uril@redhat.com>
2016-12-01 12:08:32 +02:00
Uri Lublin
3f8457febe manual: smartcard: add id=ccid to qemu command line
Add it to "-chardev spicevmc" option.

Without it I get:
qemu-system-x86_64: -chardev spicevmc,name=smartcard: chardev: no id specified

Signed-off-by: Uri Lublin <uril@redhat.com>
2016-12-01 12:08:32 +02:00
Christophe Fergeau
087b914e0a doc: Remove mention that qxl.guestdebug is Windows-only
The Linux QXL KMS driver also uses it.

Acked-by: Frediano Ziglio <fziglio@redhat.com>
2016-10-14 16:39:22 +01:00
Frediano Ziglio
1e6bdba552 style: Specify function definition indentation
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Jonathon Jongsma <jjongsma@redhat.com>
2016-10-11 10:28:22 +01:00
Li Zhijian
42db9054d1 docs/spice_style.txt: fix typo
'then' -> 'than'
'character' -> 'characters'

Signed-off-by: Li Zhijian <lizhijian@cn.fujitsu.com>
2016-09-13 16:44:47 +02:00
snir sheriber
1e467acb2a User-Manual: mention webdav is disabled by default
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-08-02 17:17:46 +02:00
Frediano Ziglio
091d6400e4 style: Add some abbreviations
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2016-05-25 14:43:03 +01:00
Frediano Ziglio
4e7572b41d style: Sort abbreviations alphabetically
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2016-05-25 14:42:57 +01:00
Frediano Ziglio
a3c0859122 style: Add an abbreviation
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Eduardo Lima (Etrunko) <etrunko@redhat.com>
2016-05-20 05:53:57 +01:00
Frediano Ziglio
9fd82215d1 style: Add some documentation for names
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Jonathon Jongsma <jjongsma@redhat.com>
2016-05-18 00:24:37 +01:00
Frediano Ziglio
7673b388f5 style: put some notes on inclusion order
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2016-05-12 15:29:21 +01:00
Frediano Ziglio
448f037a3c style: use capital case for C language
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-05-11 12:54:09 +01:00
Frediano Ziglio
0149b37946 style: remove outdated void argument
For C is better to have void instead of arguments as otherwise
K&R rules apply.

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-05-11 12:54:06 +01:00
Frediano Ziglio
04c238e09e style: update file name style
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-05-11 12:54:05 +01:00
Frediano Ziglio
fb336b8a1c style: update copyright lines
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-05-11 12:54:03 +01:00
Frediano Ziglio
586a07a2d3 style: fix condition indentation example
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-05-11 12:54:01 +01:00
Frediano Ziglio
a3871e62a7 style: we are now using capital FIXME and TODO
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-05-11 12:53:29 +01:00
Frediano Ziglio
12a7005a2f style: remove documentation for C++
C++ usage was removed with spicec (the old client).

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-05-11 09:51:18 +01:00
Frediano Ziglio
7f439a8b6c style: remove spice client section
Spice client is no more in this repository and also the style was changed

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-05-11 09:47:51 +01:00
Frediano Ziglio
4f8fcfa2f6 removed converted Spice_style.odt
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-05-10 17:45:31 +01:00
Frediano Ziglio
fafeb957c6 converts Spice_style.odt to asciidoc spice_style.txt
The conversion try keeps the content as is no matter if updated or not.
Asciidoc format is already used for manual.
Using a text format make easier to see git diff and send patches.
Also it's easier to convert to different format and copy to web pages.

Related: https://bugs.freedesktop.org/show_bug.cgi?id=95258

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Pavel Grunt <pgrunt@redhat.com>
2016-05-10 17:45:15 +01:00
Eduardo Lima (Etrunko)
036cb65a7e Fix make dist
spicec screenshot has been removed since commit b0186fe126

Signed-off-by: Eduardo Lima (Etrunko) <etrunko@redhat.com>
2016-04-25 17:10:04 -03:00
Pavel Grunt
b0186fe126 manual: Remove spicec screenshot 2016-04-22 17:07:09 +02:00
Pavel Grunt
be29eb0eea manual: No need to use sudo to run qemu 2016-04-22 17:07:09 +02:00
Pavel Grunt
d3530802b3 manual: Recommend UsbDk instead of USB Clerk 2016-04-22 17:07:09 +02:00
Pavel Grunt
cd5a1d7c09 manual: Recommend enabling monitors using remote-viewer's menu 2016-04-22 17:07:09 +02:00
Christophe Fergeau
b248815119 doc: Be more explicit about virgl requirements
This is an attempt at listing the versions of the various packages which
needs to be up to date for a functional virgl + spice.
2016-04-01 15:16:44 +02:00
Christophe Fergeau
782c7508e2 doc: Add virgl documentation
Document how to use virgl with QEMU/libvirt

virt-manager documentation still needs to be added.
2016-03-24 13:56:59 +01:00
Christophe Fergeau
1f41c295d9 manual: Document path to vdagent logs on Windows 2015-11-19 18:57:25 +01:00
Christophe Fergeau
0050ab7a4e manual: Small formatting fixes
The XML namespace to use with libvirt when adding custom QEMU arguments
looks better in a monospace font.
asciidoc will also replace the '->' in '<->' with an arrow character,
which looks bad. This commit reformulates the sentence to avoid the use
of <->
2015-11-19 18:57:25 +01:00
Christophe Fergeau
b4932ae646 syntax-check: manual: Remove duplicate word 2015-10-19 14:25:36 +02:00
Christophe Fergeau
2cf810e99e manual: Fix Arnon last name
It's "Gilboa", not "Giloba"
2015-10-01 17:56:43 +02:00
Christophe Fergeau
3d16f8c0f0 manual: Add section about debugging
This details the basics for now, but can be detailed in the future.
2015-10-01 17:56:43 +02:00
Marc-André Lureau
c309e761e8 manual: add smartcard channel section
Add some basic instructions to setup smartcard channel

Signed-off-by: Marc-André Lureau <marcandre.lureau@gmail.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2015-09-15 16:22:14 +02:00
Marc-André Lureau
1b6918f82f manual: add missing space
Signed-off-by: Marc-André Lureau <marcandre.lureau@gmail.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2015-09-15 16:22:11 +02:00
Marc-André Lureau
a9d9d4b448 manual: update webdav virt-manager section
virt-manager can add webdav channel for a while now.

Signed-off-by: Marc-André Lureau <marcandre.lureau@gmail.com>
Acked-by: Christophe Fergeau <cfergeau@redhat.com>
2015-09-15 16:22:07 +02:00
Christophe Fergeau
3d83525861 manual: Add missing closure of XML tag
The <model type='qxl'> examples in the reference documentation are
missing a closing tag.
2014-11-17 17:56:08 +01:00
Christophe Fergeau
719764f7ad docs: Fix make distcheck 2014-05-15 15:26:51 +02:00
Christophe Fergeau
37bf7a5163 doc: Generate chunked manual
This commit makes use of a2x in order to generate a chunked manual in
addition to the "all in one page" one.
2014-04-16 16:33:44 +02:00
Marc-André Lureau
b9bf654143 manual: improve text about ~/Public 2014-03-25 15:46:29 +01:00
Marc-André Lureau
fb72d198e3 manual: fix xml highlighting 2014-03-19 17:28:46 +01:00
Marc-André Lureau
06d646352e manual: add folder sharing section 2014-03-19 17:14:44 +01:00