1560149 - write down the design of document-splitting

Status: RESOLVED FIXED

(Core :: Graphics: WebRender, task)

Description

[Aria Beingessner [:Gankra]]

This needs to be written down, as the two people who know the most about this are going on leave (and one of them doesn't report to gfx, so we can't expect them to maintain it indefinitely).

Comment 1

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

I'm working on this right now as a matter of fact

Comment 2

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

WIP so far: https://github.com/staktrace/gecko/blob/fe76d58316c2/gfx/docs/DocumentSplitting.rst (EDIT: this is obsolete now, see updated link in comment 4)

Still need to fill in some stuff about the trickier bits of the implementation, but any feedback is welcome.

Comment 3

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

And also, the parts of document splitting that are internal to WR (i.e. in rust code) I'm not familiar with, so if there's anything there that needs documenting, Doug, please write up something.

Comment 4

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

Updated: https://github.com/staktrace/gecko/blob/docsplit_doc/gfx/docs/DocumentSplitting.rst

I think this is all that I can write for now, will put up the patch for review. Please provide feedback on what else you'd like to see documented.

Comment 5

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

Attachment: Bug 1560149 - Add some documentation for document splitting. r?dthayer,Gankro

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/34b35632f194
Add some documentation for document splitting. r=dthayer

Comment 7

[Stefan Hindli [:stefan_hindli]]

Backed out changeset 34b35632f194 (Bug 1560149) for linting failure in /builds/worker/checkouts/gecko/gfx/docs/DocumentSplitting.rst:162 CLOSED TREE

https://treeherder.mozilla.org/#/jobs?repo=autoland&resultStatus=testfailed%2Cbusted%2Cexception&classifiedState=unclassified&selectedJob=254224975

https://treeherder.mozilla.org/logviewer.html#/jobs?job_id=254224975&repo=autoland&lineNumber=300

Comment 8

[Pulsebot]

Backout by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ca0726ea50cb
Backed out changeset 34b35632f194 for linting failure in /builds/worker/checkouts/gecko/gfx/docs/DocumentSplitting.rst:162 CLOSED TREE

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/405f857977e5
Add some documentation for document splitting. r=dthayer

Comment 10

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

https://hg.mozilla.org/mozilla-central/rev/405f857977e5

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/edd9db03dc12
Followup to fix some typos. r=me

Comment 12

[Razvan Maries]

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