Commit Graph

77 Commits

Author SHA1 Message Date
Kevin Pouget
224a79acd3 manual: document host-side video streaming
Signed-off-by: Kevin Pouget <kpouget@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
2019-07-04 14:33:54 +01:00
Snir Sheriber
0591a09ca5 manual: Typo at Folder sharing section
Reported here:
https://gitlab.freedesktop.org/spice/spice-space-pages/issues/1

Acked-by: Frediano Ziglio <fziglio@redhat.com>
2019-07-02 12:15:09 +03:00
Thiago Mendes
6470b537d6 Converting Spice_for_newbies.odt to AsciiDoctor format
https://gitlab.freedesktop.org/spice/spice-server/issues/10

Acked-by: Frediano Ziglio <fziglio@redhat.com>
2019-05-31 15:06:10 +01:00
Thiago Mendes
ddb2795b65 Converting Spice_protocol.odt to Asciidoc
https://gitlab.freedesktop.org/spice/spice-server/issues/10

Acked-by: Frediano Ziglio <fziglio@redhat.com>
2019-05-31 15:01:54 +01:00
Thiago Mendes
b052fb73b6 Converting Vd_interfaces.odt to Asciidoc
https://gitlab.freedesktop.org/spice/spice-server/issues/10

Acked-by: Frediano Ziglio <fziglio@redhat.com>
2019-05-31 15:01:37 +01:00
Frediano Ziglio
5ee2af0fe5 docs: Remove obsolete paragraph
ClientCbs were removed, all is automated in RedChannel.

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Victor Toso <victortoso@redhat.com>
2019-05-29 10:23:40 +01:00
Frediano Ziglio
c52b88c895 docs: Add some notes on event scheduling and threading
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Victor Toso <victortoso@redhat.com>
2019-05-29 10:23:35 +01:00
Frediano Ziglio
ed68d491fd Do not check for HAVE_CONFIG_H
This should always be defined and including config.h is a requirement.

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Victor Toso <victortoso@redhat.com>
2019-04-30 09:26:55 +01:00
Frediano Ziglio
f0f6380b81 docs: Fix typo
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Uri Lublin <uril@redhat.com>
2019-03-27 08:36:35 +00:00
Frediano Ziglio
dab09ad66b build: Clean a generated file
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Eduardo Lima (Etrunko) <etrunko@redhat.com>
2019-03-26 15:47:44 +00:00
Christophe Fergeau
046be756fc doc: Document G_MESSAGES_DEBUG use
Explain how to get more verbose logs out of spice-server

Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
2019-02-08 17:17:00 +01:00
Eduardo Lima (Etrunko)
495d1612c4 Add support for building with meson/ninja
In a comparison with current autotools build system, meson/ninja
provides a huge improvement in build speed, while keeping the same
functionalities currently available and being considered more user
friendly.

The new system coexists within the same repository with the current one,
so we can do more extensive testing of its functionality before deciding
if the old system can be removed, or for some reason, has to stay for
good.

- Meson: https://mesonbuild.com

  This is the equivalent of autogen/configure step in autotools. It
  generates the files that will be used by ninja to actually build the
  source code.

  The project has received lots of traction recently, with many GNOME
  projects willing to move to this new build system. The following wiki
  page has more details of the status of the many projects being ported:

    https://wiki.gnome.org/Initiatives/GnomeGoals/MesonPorting

  Meson has a python-like syntax, easy to read, and the documentation
  on the project is very complete, with a dedicated page on how to port
  from autotools, explaining how most common use cases can be
  implemented using meson.

    http://mesonbuild.com/Porting-from-autotools.html

  Other important sources of information:

    http://mesonbuild.com/howtox.html
    http://mesonbuild.com/Syntax.html
    http://mesonbuild.com/Reference-manual.html

- Ninja: https://ninja-build.org

  Ninja is the equivalent of make in an autotools setup, which actually
  builds the source code. It has being used by large and complex
  projects such as Google Chrome, Android and LLVM. There is not much to
  say about ninja (other than it is much faster than make) because we
  won't interact directly with it as much, as meson does the middle man
  job here. The reasoning for creating ninja in the first place is
  explained on the following post:

    http://neugierig.org/software/chromium/notes/2011/02/ninja.html

  Also its manual provides more in-depth information about the design
  principles:

    https://ninja-build.org/manual.html

- Basic workflow:

  Meson package is available for most if not all distros, so, taking
  Fedora as an example, we only need to run:

    # dnf -y install meson ninja-build.

  With Meson, building in-tree is not possible at all, so we need to
  pass a directory as argument to meson where we want the build to be
  done. This has the advantage of creating builds with different options
  under the same parent directory, e.g.:

    $ meson ./build --prefix=/usr
    $ meson ./build-extra -Dextra-checks=true -Dalignment-checks=true

  After configuration is done, we call ninja to actually do the build.

    $ ninja -C ./build
    $ ninja -C ./build install

  Ninja defaults to parallel builds, and this can be changed with the -j
  flag.

    $ ninja -j 10 -C ./build

- Hacking:

  * meson.build: Mandatory for the project root and usually found under
                 each directory you want something to be built.

  * meson_options.txt: Options that can interfere with the result of the
                       build.

Signed-off-by: Eduardo Lima (Etrunko) <etrunko@redhat.com>
Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Victor Toso <victortoso@redhat.com>
2018-08-30 11:10:45 -03:00
Christophe Fergeau
65c018fbbb docs: Add documentation for the streaming device
Signed-off-by: Christophe Fergeau <cfergeau@redhat.com>
2018-08-17 14:23:48 +02:00
Snir Sheriber
6f19579254 docs: Update links in README and manual
Signed-off-by: Snir Sheriber <ssheribe@redhat.com>
Acked-by: Eduardo Lima (Etrunko) <etrunko@redhat.com>
2018-05-10 16:59:35 +03:00
Christophe de Dinechin
afb90c1640 Add mention of fall-through comments
Signed-off-by: Christophe de Dinechin <dinechin@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
2018-02-09 11:47:45 +01:00
Christophe de Dinechin
b34478a652 Add mention of header guards
Signed-off-by: Christophe de Dinechin <dinechin@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
2018-02-09 10:11:30 +00:00
Frediano Ziglio
5088afb05a style: Update style to include some C++ element
This style is used by other SPICE projects like spice-streaming-agent.
See discussion "Coding style and naming conventions for C++" at
https://lists.freedesktop.org/archives/spice-devel/2018-January/041562.html.

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Lukáš Hrázký <lhrazky@redhat.com>
2018-02-08 14:26:10 +00:00
Christophe de Dinechin
c2faefc2e1 Fix indentation in macro example
Signed-off-by: Christophe de Dinechin <dinechin@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
2018-02-07 21:11:58 +00:00
Christophe de Dinechin
9417d77bef Fix grammatical error
Signed-off-by: Christophe de Dinechin <dinechin@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
2018-02-07 21:11:52 +00:00
Christophe de Dinechin
c05c12f0ed Update copyright date
Signed-off-by: Christophe de Dinechin <dinechin@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
2018-02-07 21:11:46 +00:00
Jonathon Jongsma
8705e3d123 Mention vmport in user manual
For server mode mouse to work properly with spice, vmport must be
disabled in qemu. To do this, we need to pass vmport=off to the -machine
option.
2017-10-04 11:09:15 -05:00
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