Improve protocols documentation
ClosedPublic

Authored by romangg on Mar 26 2018, 10:51 PM.

Details

Summary

Improves the outputmanagement and outputdevice protocol documentation.

Diff Detail

Repository
R127 KWayland
Branch
improveOutputManagementDoc
Lint
No Linters Available
Unit
No Unit Test Coverage
romangg created this revision.Mar 26 2018, 10:51 PM
Restricted Application added a project: Frameworks. · View Herald TranscriptMar 26 2018, 10:51 PM
romangg requested review of this revision.Mar 26 2018, 10:51 PM
romangg added a comment.EditedMar 26 2018, 10:57 PM

Currently I'm reading through these protocols for my 5.13 color correction work and I was wondering about the output management related protocol documentation, which seems to me faulty in many areas. Please take into account that I haven't yet written on any Wayland protocols when reviewing my changes.

davidedmundson added inline comments.
src/client/protocols/outputdevice.xml
67 ↗(On Diff #30673)

earlier you changed all the "compositor" to "server"

160 ↗(On Diff #30673)

you've changed 1/2 properties ->events

tbh, properties was fine, everything is events in wayland terms,but semantically they're still properties and it separates them from the "done" event

romangg updated this revision to Diff 30925.Mar 30 2018, 12:31 PM
romangg marked an inline comment as done.
  • Say properties
romangg added inline comments.Mar 30 2018, 12:33 PM
src/client/protocols/outputdevice.xml
67 ↗(On Diff #30673)

The usage of terms compositor and server is not clearly regulated in the Wayland world besides that these terms describe the same "application" (for example KWin). I try to use "server" whenever I talk about this application communicating with clients and "compositor" whenever I talk about this application in its capability of arranging surfaces to a final output image.

davidedmundson accepted this revision.Apr 25 2018, 2:10 PM
This revision is now accepted and ready to land.Apr 25 2018, 2:10 PM
This revision was automatically updated to reflect the committed changes.