[Spice-devel] [RFC PATCH 0/2] Protocol file documentation

Frediano Ziglio fziglio at redhat.com
Fri Sep 9 09:44:18 UTC 2016


Yesterday we spent a bit trying to understand some extra
bytes from the network protocol.
We realized that not having a documentation can lead to
problem.
So I just write some initial patch to add documentation.
- Is the format (markdown) a good format?
- Should the file be installed somewhere?
- Is spice-common the right repository?
- Did initial documentation (patch 2/2) look a good
  start?

Any comments are welcome. Patches more :)

Frediano Ziglio (2):
  Start adding protocol file documentation
  Start writing some documentation on protocol

 Makefile.am             |  2 +-
 configure.ac            |  2 ++
 docs/Makefile.am        | 17 +++++++++++++++++
 docs/spice_protocol.txt | 50 +++++++++++++++++++++++++++++++++++++++++++++++++
 m4/spice_manual.m4      | 32 +++++++++++++++++++++++++++++++
 5 files changed, 102 insertions(+), 1 deletion(-)
 create mode 100644 docs/Makefile.am
 create mode 100644 docs/spice_protocol.txt
 create mode 100644 m4/spice_manual.m4

-- 
2.7.4



More information about the Spice-devel mailing list