diff options
author | Pavel Grunt <pgrunt@redhat.com> | 2015-10-30 14:48:20 +0100 |
---|---|---|
committer | Pavel Grunt <pgrunt@redhat.com> | 2015-10-30 14:53:37 +0100 |
commit | a30d502210bb56e1dfe348446e98a6723b881422 (patch) | |
tree | b4a36a4fd8c15972c8f5768f0fc338a5bb945c72 | |
parent | 7fc043f5964faa0baffcd939c2ecfc3cc3c93599 (diff) |
style: Use headings instead of strong
-rw-r--r-- | content/pages/developers.rst | 15 | ||||
-rw-r--r-- | content/pages/documentation.rst | 39 | ||||
-rw-r--r-- | content/pages/faq.rst | 36 | ||||
-rw-r--r-- | content/pages/features.rst | 6 | ||||
-rw-r--r-- | content/pages/home.rst | 3 |
5 files changed, 66 insertions, 33 deletions
diff --git a/content/pages/developers.rst b/content/pages/developers.rst index e6b67b7..0d81216 100644 --- a/content/pages/developers.rst +++ b/content/pages/developers.rst @@ -1,7 +1,8 @@ Developers ############################################################################### -**New to Spice?** +New to Spice? ++++++++++++++ Spice project provies documentation that will help you get familiar with Spice. Start by reading Spice For Newbies for getting information about Spice basic @@ -9,7 +10,8 @@ architecture and Spice components. You can use Spice user manual for information on how to get, make and use Spice. Read SPICE Protocol and VD-Interfaces which contain additional and more specific information. -**Like to get involved?** +Like to get involved? ++++++++++++++++++++++ The Spice project is open for contribution. As the project activity is spread across many areas of interest, a variety of C/C++ programmers will find areas of @@ -20,7 +22,8 @@ If you choose to get involved, you are obligated to keep Spice project standards. Commit and forget style is unacceptable; code maintenance and bug fixing is part of the trade. -**Still like to get involved?** +Still like to get involved? ++++++++++++++++++++++++++++ You can start by reading the Spice documentation (see New to Spice? section) and the Spice style document (xf86-video-qxl is under another style). Browse Spice @@ -32,7 +35,8 @@ change, coordinate it with Spice project members. Doing so will reduce the chance that you'll do a duplicate work, while it will also reduce the chance that your patch will get rejected. -**Like to send a patch?** +Like to send a patch? ++++++++++++++++++++++ Before sending a patch to spice-devel@lists.freedesktop.org make sure that it follows these guidelines: @@ -48,7 +52,8 @@ follows these guidelines: - The patch was prepared using git format-patch - The patch successfully compiles on all supported platforms -**Like to send a patch but don't have time for all the “nonsense”?** +Like to send a patch but don't have time for all the “nonsense”? +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ If it is a simple bug fix, send the patch to spice-devel@lists.freedesktop.org and specify that you don't care what we do with the patch. We will do with it diff --git a/content/pages/documentation.rst b/content/pages/documentation.rst index 13e64bc..5e81a61 100644 --- a/content/pages/documentation.rst +++ b/content/pages/documentation.rst @@ -18,36 +18,42 @@ Documentation .. _UsbDk Presentation: {filename}/static/docs/UsbDk_at_a_Glance.pdf .. _UsbDk Manual: {filename}/static/docs/UsbDk_Software_Development_Manual.pdf .. _VD Interfaces: {filename}/static/docs/vd_interfaces.pdf +.. _Spice Reference Manual: spice-user-manual.html +.. _spice-gtk API documentation: spice-gtk.html -Copyright license templates that must be appended to newlyadded files - GPL_, -LGPL_, `Apache 2.0`_ and BSD_ - -**Spice Reference Manual** +`Spice Reference Manual`_ ++++++++++++++++++++++++++ This describes the various features provided by SPICE, and how to make use of them when using QEMU/libvirt/virt-manager. -**spice-gtk API documentation** +`spice-gtk API documentation`_ +++++++++++++++++++++++++++++++ This describes spice-gtk C API. +Documents ++++++++++ + Important: The pdf docs were written for spice 0.4 and is thus not wholly up to date. -**Spice For Newbies** - +Spice For Newbies +^^^^^^^^^^^^^^^^^ Contains basic information about Spice's architecture, components, and features |br| Download `spice for newbies`_ -**Spice User Manual** +Spice User Manual +^^^^^^^^^^^^^^^^^ Includes all of the information you need to use Spice, such as downloading, building, installing, and executing |br| Download `spice user manual`_ -**SPICE Protocol** +SPICE Protocol +^^^^^^^^^^^^^^ Outlines the complete definition of the SPICE remote computing protocol |br| Download `spice protocol`_ @@ -58,7 +64,8 @@ Outlines the complete definition of the SPICE client <-> agent protocol |br| TODO `Go to AgentProtocol wiki page`_ -**VD Interfaces** +VD Interfaces +^^^^^^^^^^^^^ The following is a clip from VD-Interfaces specification paper. @@ -94,22 +101,26 @@ changes. Spice project plans to make an effort to push this specification forward in order to benefit all. |br| Download the complete specification of `VD interfaces`_ -**Spice style** +Spice style +^^^^^^^^^^^ Defines Spice project's coding style and coding conventions |br| Download `spice style`_ -**Red Hat Summit 2009** +Red Hat Summit 2009 +^^^^^^^^^^^^^^^^^^^ Spice session presentation at Red Hat Summit 2009 |br| Download `ODP version`_ or `PDF version`_ -**UsbDk** +UsbDk +^^^^^ Download `UsbDk Presentation`_ |br| Download `UsbDk Manual`_ -**License** +License +^^^^^^^ Copyright license templates that must be appended to newlyadded files - GPL_, LGPL_, `Apache 2.0`_ and BSD_ diff --git a/content/pages/faq.rst b/content/pages/faq.rst index 48763e2..d2becf7 100644 --- a/content/pages/faq.rst +++ b/content/pages/faq.rst @@ -4,7 +4,13 @@ FAQ :slug: faq :modified: 2015-10-12 12:20 -**Why Spice?** +.. _Download: download.html +.. _Documentation: documentation.html +.. _Developers: developers.html +.. _Spice User Manual: spice-user-manual.html + +Why Spice? +++++++++++ Adequate user experience and the lack of a good solution for virtual machine remote access were what sparked the Spice project. To ensure that Spice is a @@ -15,38 +21,46 @@ success, the following project goals were set: #. To maintain low CPU consumption in order to have high VM density on the host #. To provide high-quality video streaming -**Why choose Spice?** +Why choose Spice? ++++++++++++++++++ - Spice offers greater user experience and increased usability and reliability - Spice has a lot more space to evolve - Spice is open source - Spice architecture is cross-platform, allowing for greater interoperability -**Under what license is Spice distributed?** +Under what license is Spice distributed? +++++++++++++++++++++++++++++++++++++++++ Most of Spice sources are distributed under GPL v2. For some exceptions the project uses LGPL or BSD style licenses. Documents are distributed under Creative Commons Attribution-Share Alike 3.0 license. -**How does Spice work?** +How does Spice work? +++++++++++++++++++++ Download Spice for Newbies for information on Spice basic architecture, components, and features. -**How do I get Spice?** +How do I get Spice? ++++++++++++++++++++ -Refer to our Download page or the Spice User Manual. +Refer to our Download_ page or the `Spice User Manual`_. -**How do I use Spice?** +How do I use Spice? ++++++++++++++++++++ -Download Spice User Manual for detailed information. +Consult `Spice User Manual`_ for detailed information. -**How can I contribute to Spice?** +How can I contribute to Spice? +++++++++++++++++++++++++++++++ Your help and feedback are welcomed. If you are a Spice user, refer to the -Support page. For developers, refer to the Developers page. +Documentation_ page. For developers, refer to the Developers_ page. -**I built Spice server on a 32-bit machine and it failed. What can I do?** +I built Spice server on a 32-bit machine and it failed. What can I do? +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ +TODO: Verify Building Spice server on 32-bit machine is not supported because Spice server is dependent on 64-bit atomic operations. However, you can build Spice client for a diff --git a/content/pages/features.rst b/content/pages/features.rst index d8922b6..ce7506d 100644 --- a/content/pages/features.rst +++ b/content/pages/features.rst @@ -5,7 +5,8 @@ Features :submenu: documentation :modified: 2015-10-20 10:20 -**Current Features** +Current Features +++++++++++++++++ - Graphic commands - processes and transmits 2D graphic commands - Video streaming - heuristically identifies video streams and transmits M-JPEG @@ -33,7 +34,8 @@ Features - USB redirection - allows clients to use their USB devices with Spice servers - Linux features parity -**Future Features** +Future Features ++++++++++++++++ - Network tunneling (in progress) - using virtual network interface to enable sharing of network resources. Currently the focus is on printer sharing but is diff --git a/content/pages/home.rst b/content/pages/home.rst index aeba7aa..c6c12da 100644 --- a/content/pages/home.rst +++ b/content/pages/home.rst @@ -12,7 +12,8 @@ of the solution to be easily utilized by a third-party component. Currently, the project main focus is to provide high-quality remote access to QEMU virtual machine. Seeking to help break down the barriers to virtualization adoption by overcoming traditional desktop virtualization challenges, emphasizing user experience. For this purpose, Red Hat introduced the SPICE remote computing protocol that is used for Spice client-server communication. Other components developed include QXL display device and driver, etc. -**Current Features** +Current Features +++++++++++++++++ - Graphic commands - processes and transmits 2D graphic commands - Video streaming - heuristically identifies video streams and transmits M-JPEG |