Wayland design and source code documentation

[Jasper St. Pierre]

Wayland has a lot of components: the code generator, the protocol, the
client/server lib implementation, the design decisions we made to tie it
all together. Yes, we aren't the greatest at documentation and we know that
a lot is missing, but in general we assume experience with traditional
toolkits, compositors/WMs, and in some cases, leftover knowledge from X11.

There's also Weston, the de facto, most feature-complete, reference
compositor. That has input management, output management, rendering,
protocol implementations, clients, etc.

In order for us to help you through the codebase and improve documentation,
we sort of need to know what pieces you're interested in, and what you're
having trouble understanding.


On Wed, Dec 18, 2013 at 3:57 AM, Artsiom Anikeyenka
<arty.anikey at gmail.com>wrote:

> Hmmm, thanks, but I've seen those. I though maybe there is something more.
> Ok I guess the good question will be:
>
> Do most of developers find it detailed and descriptive enough?
>
> I mean I'm still learning so maybe I just don't know enough to understand.
>
> Thanks, and have a very good day :)
>
>
>
> On Wed, Dec 18, 2013 at 2:02 AM, Bryce W. Harrington <
> b.harrington at samsung.com> wrote:
>
>> On Tue, Dec 17, 2013 at 11:32:09PM +0300, Artsiom Anikeyenka wrote:
>> > Hi guys,
>> >
>> > Is there a detailed documentation of wayland source code. Any good
>> > visualization of the design? Are there any plans on adding/creating
>> those?
>> >
>> > Thanks and be good.
>>
>> http://wayland.freedesktop.org/architecture.html
>>
>> http://wayland.freedesktop.org/docs/html/
>>
>> The former includes a couple block diagrams.
>>
>> The latter includes the client and server API's and the protocol
>> specification, which are generated from the wayland codebases.
>>
>> Bryce
>
>
>
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel
>
>


-- 
  Jasper
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freedesktop.org/archives/wayland-devel/attachments/20131218/022691ed/attachment.html>