1298246 - Update documentation for APZ IPDL protocols

Status: RESOLVED FIXED

(Core :: Graphics, defect)

Description

[Ryan Hunt [:rhunt] (on leave until early May)]

With the changes in Bug 1289650, the documentation comments on the APZ protocols should be updated/expanded.

Comment 1

[Ryan Hunt [:rhunt] (on leave until early May)]

Attachment: Bug 1298246 - Update documentation for APZ IPDL protocols.

Review commit: https://reviewboard.mozilla.org/r/74430/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/74430/

Comment 2

[Ryan Hunt [:rhunt] (on leave until early May)]

Comment on attachment 8785117 [details]
Bug 1298246 - Update documentation for APZ IPDL protocols.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/74430/diff/1-2/

Comment 3

[Kartikaya Gupta (email:[e-mail])]

Comment on attachment 8785117 [details]
Bug 1298246 - Update documentation for APZ IPDL protocols.

https://reviewboard.mozilla.org/r/74430/#review72398

::: gfx/layers/ipc/PAPZ.ipdl:37
(Diff revision 2)
> - * PBrowser parent actor doesn't necessarily live in the main process, for
> + * in the main process, or to the compositor thread in the gpu processs.
> - * example with nested browsers). This will typically be set up when the layers
> - * id is allocated for the PBrowser.
>   *
> - * Opened through PContent and runs on the main thread in both parent and child.
> + * PAPZParent lives in the compositor thread, while PAPZChild lives wherever the remoted
> + * GeckoContentController lives. RemoteContentController implements PAPZParent, while

s/lives/lives (generally the main thread of the main or content process)/

::: gfx/layers/ipc/PAPZCTreeManager.ipdl:38
(Diff revision 2)
> + * PAPZCTreeManager is a protocol for remoting a IAPZCTreeManager.
> + *
> + * APZCTreeManagerParent and APZCTreeManagerChild implement this protocol.
> + */

I'd like to see a bit more information here about what threads the two endpoints are on.

Comment 4

[Ryan Hunt [:rhunt] (on leave until early May)]

Comment on attachment 8785117 [details]
Bug 1298246 - Update documentation for APZ IPDL protocols.

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/74430/diff/2-3/

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/b329531116d3
Update documentation for APZ IPDL protocols. r=kats

Comment 6

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/b329531116d3