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

[Victor Toso]

Hi,

On Fri, Sep 30, 2016 at 08:44:53AM +0200, Pavel Grunt wrote:
> 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
>
> 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.

I disagree on having the documentation _only_ in the website. IMHO, the
website should be updated every release or so, with the generated
documentation at that given release.

If we should have the documentation in one of our repos, I would prefer
that we keep it spice server.

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

Indeed

>
> Pavel
>
> On Thu, 2016-09-29 at 12:28 +0100, Frediano Ziglio wrote:
> > Small update for this patchset:
> > - fix headers in "Extended protocol documentation";
> > - added some more documentation on attributes.
> > 
> > Frediano Ziglio (4):
> >   Start adding protocol file documentation
> >   Start writing some documentation on protocol
> >   Extended protocol documentation
> >   More work on attribute protocol documentation
> > 
> >  Makefile.am             |   2 +-
> >  configure.ac            |   2 +
> >  docs/Makefile.am        |  17 ++
> >  docs/spice_protocol.txt | 423
> > ++++++++++++++++++++++++++++++++++++++++++++++++
> >  m4/spice_manual.m4      |  32 ++++
> >  5 files changed, 475 insertions(+), 1 deletion(-)
> >  create mode 100644 docs/Makefile.am
> >  create mode 100644 docs/spice_protocol.txt
> >  create mode 100644 m4/spice_manual.m4
> > 
> 
> _______________________________________________
> Spice-devel mailing list
> Spice-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/spice-devel
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <https://lists.freedesktop.org/archives/spice-devel/attachments/20160930/2364e081/attachment.sig>