[Spice-devel] [PATCH v2 0/4] Protocol file syntax documentation

Frediano Ziglio fziglio at redhat.com
Fri Sep 30 11:02:37 UTC 2016


> 
> Hi Frediano!
> 
> Thank you for looking into it
> 
> imho it is confusing to document spice-protocol which is defined in
> spice-common in spice server git repository.
> 
> ^ that sentence is strange
> 

All protocol files (spice.proto and python code) are in spice-common,
not in spice-protocol. I think that between spice-server, spice-common
and spice-protocol spice-common is the best place...

> I know the documentation files are in the spice server git repo, imo
> it is wrong.
> 
> I would put this kind of information on our website, so it is easy to
> give the reference to a "rendered" document in case somebody asks on
> irc or by an email.
> 

... but I agree this documentation could be moved to some other
place. I would like however to have the history a repository (and we
are using git for the website) so website is also fine.
At the end is just a single file.

Where's the website git repository?
Where can I store the document file?
I expect to use the same format (markdown).

> Of course any documentation is better than no documentation.
> 
> Pavel
> 

Sure

Frediano


More information about the Spice-devel mailing list