224152 2021-04-03 10:11:02 -0700 Document how to use logging in WebKit 2021-04-05 19:47:16 -0700 1 1 1 Unclassified WebKit Tools / Tests WebKit Nightly Build Unspecified Unspecified RESOLVED FIXED InRadar P2 Normal --- 1 twilco.o twilco.o darin fujii gsnedders rniwa simon.fraser webkit-bug-importer wenson_hsieh oldest_to_newest 1746785 0 twilco.o 2021-04-03 10:11:02 -0700 Add documentation in Introduction.md about how to use logging (e.g. LOG_WITH_STREAM). 1746786 1 425096 twilco.o 2021-04-03 10:15:14 -0700 Created attachment 425096 Patch 1746792 2 twilco.o 2021-04-03 10:33:19 -0700 I know Introduction.md is contentious (https://bugs.webkit.org/show_bug.cgi?id=217017), but I figure we can move the docs added in this patch elsewhere later if we want. FWIW, I find Introduction.md to be really helpful (though I am not the targeted first patch audience anymore). Usually I open it with an easily Ctrl-F'able purpose ("How does logging work?"). This workflow might be a little bit harder if things were split up. 1746838 3 425096 rniwa 2021-04-03 18:21:25 -0700 Comment on attachment 425096 Patch View in context: https://bugs.webkit.org/attachment.cgi?id=425096&action=review > Introduction.md:1347 > +Some places in WebKit use a macro called `LOG_WITH_STREAM`. Here's an example invocation: Please use a single space between sentences. 1746843 4 rniwa 2021-04-03 19:23:24 -0700 (In reply to Tyler Wilcock from comment #2) > I know Introduction.md is contentious > (https://bugs.webkit.org/show_bug.cgi?id=217017), but I figure we can move > the docs added in this patch elsewhere later if we want. Yes, the first thing to do is to move all the necessary information in this document. We can then decide whether splitting up is the right thing to do. Given how bad existing documentation on websites and wiki have gotten, I'm skeptical of that approach. The issue is that nobody would remember to update all the places documents are out of date because it's so hard to find all the references to a given concept, policy, or process. > FWIW, I find Introduction.md to be really helpful (though I am not the > targeted first patch audience anymore). Usually I open it with an easily > Ctrl-F'able purpose ("How does logging work?"). This workflow might be a > little bit harder if things were split up. Right. In fact, Introduction.md is really meant for anyone contributing to WebKit who needs to figure out how to do certain things or venturing into new territory. e.g. if you had never written ref tests, there is explanation for that. If you had never dealt with GC, then there should be a section about that too. As you touch on more areas & technical concepts in WebKit, you should be able to go back to this intro doc to learn the basics. 1746861 5 425129 twilco.o 2021-04-04 07:44:16 -0700 Created attachment 425129 Patch 1746876 6 rniwa 2021-04-04 15:44:17 -0700 Did you mean to put this up for review? 1746880 7 twilco.o 2021-04-04 15:57:02 -0700 Yes, sorry! r? now. 1747229 8 ews-feeder 2021-04-05 19:12:51 -0700 commit-queue failed to commit attachment 425129 to WebKit repository. To retry, please set cq+ flag again. 1747246 9 ews-feeder 2021-04-05 19:46:59 -0700 Committed r275482: <https://commits.webkit.org/r275482> All reviewed patches have been landed. Closing bug and clearing flags on attachment 425129. 1747247 10 webkit-bug-importer 2021-04-05 19:47:16 -0700 <rdar://problem/76248971> 425096 2021-04-03 10:15:14 -0700 2021-04-04 07:44:13 -0700 Patch bug-224152-20210403121513.patch text/plain 2488 twilco.o U3VidmVyc2lvbiBSZXZpc2lvbjogMjc1NDUwCmRpZmYgLS1naXQgYS9DaGFuZ2VMb2cgYi9DaGFu Z2VMb2cKaW5kZXggZjBkY2ZlMjkyNzU2M2NlYjQ3NzMxYzI4YTM5NmY3Yzc2NjkzYjEzZS4uNTg5 Y2IxNTc3NTg3N2ZiNGRlNGE0ZGMwMDMxOTQ2Mjc4ZDkzZjM2OSAxMDA2NDQKLS0tIGEvQ2hhbmdl TG9nCisrKyBiL0NoYW5nZUxvZwpAQCAtMSwzICsxLDE0IEBACisyMDIxLTA0LTAzICBUeWxlciBX aWxjb2NrICA8dHdpbGNvLm9AcHJvdG9ubWFpbC5jb20+CisKKyAgICAgICAgRG9jdW1lbnQgaG93 IHRvIHVzZSBsb2dnaW5nIGluIFdlYktpdAorICAgICAgICBodHRwczovL2J1Z3Mud2Via2l0Lm9y Zy9zaG93X2J1Zy5jZ2k/aWQ9MjI0MTUyCisKKyAgICAgICAgUmV2aWV3ZWQgYnkgTk9CT0RZIChP T1BTISkuCisKKyAgICAgICAgQWRkIGRvY3VtZW50YXRpb24gYWJvdXQgaG93IHRvIHVzZSBsb2dn aW5nIGluIFdlYktpdC4KKworICAgICAgICAqIEludHJvZHVjdGlvbi5tZDoKKwogMjAyMS0wMy0y OCAgRGF2aWQgS2lsemVyICA8ZGRraWx6ZXJAYXBwbGUuY29tPgogCiAgICAgICAgIENvbXBpbGUg V2ViS2l0IHdpdGggVUJTYW4KZGlmZiAtLWdpdCBhL0ludHJvZHVjdGlvbi5tZCBiL0ludHJvZHVj dGlvbi5tZAppbmRleCAzZWJhNGNkZWJlN2Y4NWY2ZmE1YzkxNTY4MzU3ZWVlY2U1MDI1ZmQ0Li5i NjVjYjdjN2E5MzZlNDZjODYwMjMyZTljZDYxYzlhYjgwMzM3ODcwIDEwMDY0NAotLS0gYS9JbnRy b2R1Y3Rpb24ubWQKKysrIGIvSW50cm9kdWN0aW9uLm1kCkBAIC0xMzQ0LDUgKzEzNDQsNDkgQEAg RklYTUU6IFRhbGsgYWJvdXQgaG93IHRvIGRlYnVnIEFQSSB0ZXN0cy4KIAogIyBMb2dnaW5nIGlu IFdlYktpdAogCi1GSVhNRTogV3JpdGUgdGhpcy4KK1NvbWUgcGxhY2VzIGluIFdlYktpdCB1c2Ug YSBtYWNybyBjYWxsZWQgYExPR19XSVRIX1NUUkVBTWAuICBIZXJlJ3MgYW4gZXhhbXBsZSBpbnZv Y2F0aW9uOgorCitgYGAKK0xPR19XSVRIX1NUUkVBTShTY3JvbGxpbmcsIHN0cmVhbSA8PCAiU2Ny b2xsaW5nVHJlZTo6Y29tbWl0VHJlZVN0YXRlIC0gcmVtb3ZpbmcgdW52aXNpdGVkIG5vZGUgIiA8 PCBub2RlSUQpOworYGBgCisKK1RoZSBmaXJzdCBhcmd1bWVudCBpcyB0aGUgX2xvZyBjaGFubmVs XyBhbmQgdGhlIHNlY29uZCBpcyB0aGUgX2xvZyBjb250ZW50Xy4gIEJ5IGRlZmF1bHQsIHRoaXMg bG9nZ2luZyBpcyBlbmFibGVkIGluCitkZWJ1ZyBidWlsZHMgYW5kIGRpc2FibGVkIGluIHJlbGVh c2UgYnVpbGRzIChzZWUgZGVmaW5pdGlvbiBvZiBgTE9HX0RJU0FCTEVEYCkuCisKK1RoZSBvbmx5 IGxvZ3MgdGhhdCB3aWxsIGJlIHByaW50ZWQgYXJlIHRob3NlIHdob3NlIGNoYW5uZWxzIHlvdSBo YXZlIGVuYWJsZWQuICBZb3UgY2FuIHNwZWNpZnkgdGhlIGNoYW5uZWxzIHlvdSB3YW50IHRvCitl bmFibGUgYnkgY29uc3RydWN0aW5nIGEgY29tbWEtc2VwYXJhdGVkIGxpc3Qgd2l0aCB0aGUgZm9s bG93aW5nIHN5bnRheDoKKworKiBgQ2hhbm5lbE5hbWVgIHRvIGVuYWJsZSBsb2dnaW5nIGZvciB0 aGlzIGNoYW5uZWwKKyogYGFsbGAgdG8gZW5hYmxlIGxvZ2dpbmcgZm9yIGFsbCBjaGFubmVscwor KiBgLUNoYW5uZWxOYW1lYCB0byBkaXNhYmxlIGxvZ2dpbmcgZm9yIHRoaXMgY2hhbm5lbAorCitX aGVyZSB5b3Ugc3BlY2lmeSB0aGlzIGxpc3QgZGVwZW5kcyBvbiB0aGUgcGxhdGZvcm0geW91IGFy ZSBydW5uaW5nIFdlYktpdCBvbi4KKworIyMjIExpbnV4CisKK1NldCB0aGUgYFdFQktJVF9ERUJV R2AgZW52aXJvbm1lbnQgdmFyaWFibGUuCisKK2BgYAorV0VCS0lUX0RFQlVHPVNjcm9sbGluZyBU b29scy9TY3JpcHRzL3J1bi1taW5pYnJvd3NlciAtLWd0ayAtLWRlYnVnCitgYGAKKworIyMjIE1h YworCitTZXQgYSB2YWx1ZSBmb3IgdGhlIGBXZWJDb3JlTG9nZ2luZ2Aga2V5IGluIFtzdGFuZGFy ZFVzZXJEZWZhdWx0c10oaHR0cHM6Ly9kZXZlbG9wZXIuYXBwbGUuY29tL2RvY3VtZW50YXRpb24v Zm91bmRhdGlvbi9uc3VzZXJkZWZhdWx0cy8xNDE2NjAzLXN0YW5kYXJkdXNlcmRlZmF1bHRzKS4K KworWW91IG1heSBhbHNvIHBhc3MgdGhpcyBrZXkgYW5kIHZhbHVlIGFzIGFuIGFyZ3VtZW50Ogor CitgYGAKK1Rvb2xzL1NjcmlwdHMvcnVuLW1pbmlicm93c2VyIC0tZGVidWcgLVdlYkNvcmVMb2dn aW5nIFNjcm9sbGluZworYGBgCisKK29yIHNldCB0aGUga2V5IGFuZCB2YWx1ZSBvbiB0aGUgW05T R2xvYmFsRG9tYWluXShodHRwczovL2RldmVsb3Blci5hcHBsZS5jb20vZG9jdW1lbnRhdGlvbi9m b3VuZGF0aW9uL25zZ2xvYmFsZG9tYWluKS4KKworYGBgCitkZWZhdWx0cyB3cml0ZSBOU0dsb2Jh bERvbWFpbiAgV2ViQ29yZUxvZ2dpbmcgLXN0cmluZyBTY3JvbGxpbmcKK1Rvb2xzL1NjcmlwdHMv cnVuLW1pbmlicm93c2VyIC0tZGVidWcKK2BgYAorCisjIyMgV2luZG93cwogCitTZXQgdGhlIGBX ZWJDb3JlTG9nZ2luZ2AgZW52aXJvbm1lbnQgdmFyaWFibGUuCg== 425129 2021-04-04 07:44:16 -0700 2021-04-05 19:47:00 -0700 Patch bug-224152-20210404094415.patch text/plain 2485 twilco.o U3VidmVyc2lvbiBSZXZpc2lvbjogMjc1NDUwCmRpZmYgLS1naXQgYS9DaGFuZ2VMb2cgYi9DaGFu Z2VMb2cKaW5kZXggZjBkY2ZlMjkyNzU2M2NlYjQ3NzMxYzI4YTM5NmY3Yzc2NjkzYjEzZS4uNTg5 Y2IxNTc3NTg3N2ZiNGRlNGE0ZGMwMDMxOTQ2Mjc4ZDkzZjM2OSAxMDA2NDQKLS0tIGEvQ2hhbmdl TG9nCisrKyBiL0NoYW5nZUxvZwpAQCAtMSwzICsxLDE0IEBACisyMDIxLTA0LTAzICBUeWxlciBX aWxjb2NrICA8dHdpbGNvLm9AcHJvdG9ubWFpbC5jb20+CisKKyAgICAgICAgRG9jdW1lbnQgaG93 IHRvIHVzZSBsb2dnaW5nIGluIFdlYktpdAorICAgICAgICBodHRwczovL2J1Z3Mud2Via2l0Lm9y Zy9zaG93X2J1Zy5jZ2k/aWQ9MjI0MTUyCisKKyAgICAgICAgUmV2aWV3ZWQgYnkgTk9CT0RZIChP T1BTISkuCisKKyAgICAgICAgQWRkIGRvY3VtZW50YXRpb24gYWJvdXQgaG93IHRvIHVzZSBsb2dn aW5nIGluIFdlYktpdC4KKworICAgICAgICAqIEludHJvZHVjdGlvbi5tZDoKKwogMjAyMS0wMy0y OCAgRGF2aWQgS2lsemVyICA8ZGRraWx6ZXJAYXBwbGUuY29tPgogCiAgICAgICAgIENvbXBpbGUg V2ViS2l0IHdpdGggVUJTYW4KZGlmZiAtLWdpdCBhL0ludHJvZHVjdGlvbi5tZCBiL0ludHJvZHVj dGlvbi5tZAppbmRleCAzZWJhNGNkZWJlN2Y4NWY2ZmE1YzkxNTY4MzU3ZWVlY2U1MDI1ZmQ0Li4w YTIxYmE2MTQyMzc5NzQ3YTg2NzNkMjNmZTZkMDQzN2JlMzBkYjE2IDEwMDY0NAotLS0gYS9JbnRy b2R1Y3Rpb24ubWQKKysrIGIvSW50cm9kdWN0aW9uLm1kCkBAIC0xMzQ0LDUgKzEzNDQsNDkgQEAg RklYTUU6IFRhbGsgYWJvdXQgaG93IHRvIGRlYnVnIEFQSSB0ZXN0cy4KIAogIyBMb2dnaW5nIGlu IFdlYktpdAogCi1GSVhNRTogV3JpdGUgdGhpcy4KK1NvbWUgcGxhY2VzIGluIFdlYktpdCB1c2Ug YSBtYWNybyBjYWxsZWQgYExPR19XSVRIX1NUUkVBTWAuIEhlcmUncyBhbiBleGFtcGxlIGludm9j YXRpb246CisKK2BgYAorTE9HX1dJVEhfU1RSRUFNKFNjcm9sbGluZywgc3RyZWFtIDw8ICJTY3Jv bGxpbmdUcmVlOjpjb21taXRUcmVlU3RhdGUgLSByZW1vdmluZyB1bnZpc2l0ZWQgbm9kZSAiIDw8 IG5vZGVJRCk7CitgYGAKKworVGhlIGZpcnN0IGFyZ3VtZW50IGlzIHRoZSBfbG9nIGNoYW5uZWxf IGFuZCB0aGUgc2Vjb25kIGlzIHRoZSBfbG9nIGNvbnRlbnRfLiBCeSBkZWZhdWx0LCB0aGlzIGxv Z2dpbmcgaXMgZW5hYmxlZCBpbgorZGVidWcgYnVpbGRzIGFuZCBkaXNhYmxlZCBpbiByZWxlYXNl IGJ1aWxkcyAoc2VlIGRlZmluaXRpb24gb2YgYExPR19ESVNBQkxFRGApLgorCitUaGUgb25seSBs b2dzIHRoYXQgd2lsbCBiZSBwcmludGVkIGFyZSB0aG9zZSB3aG9zZSBjaGFubmVscyB5b3UgaGF2 ZSBlbmFibGVkLiBZb3UgY2FuIHNwZWNpZnkgdGhlIGNoYW5uZWxzIHlvdSB3YW50IHRvCitlbmFi bGUgYnkgY29uc3RydWN0aW5nIGEgY29tbWEtc2VwYXJhdGVkIGxpc3Qgd2l0aCB0aGUgZm9sbG93 aW5nIHN5bnRheDoKKworKiBgQ2hhbm5lbE5hbWVgIHRvIGVuYWJsZSBsb2dnaW5nIGZvciB0aGlz IGNoYW5uZWwKKyogYGFsbGAgdG8gZW5hYmxlIGxvZ2dpbmcgZm9yIGFsbCBjaGFubmVscworKiBg LUNoYW5uZWxOYW1lYCB0byBkaXNhYmxlIGxvZ2dpbmcgZm9yIHRoaXMgY2hhbm5lbAorCitXaGVy ZSB5b3Ugc3BlY2lmeSB0aGlzIGxpc3QgZGVwZW5kcyBvbiB0aGUgcGxhdGZvcm0geW91IGFyZSBy dW5uaW5nIFdlYktpdCBvbi4KKworIyMjIExpbnV4CisKK1NldCB0aGUgYFdFQktJVF9ERUJVR2Ag ZW52aXJvbm1lbnQgdmFyaWFibGUuCisKK2BgYAorV0VCS0lUX0RFQlVHPVNjcm9sbGluZyBUb29s cy9TY3JpcHRzL3J1bi1taW5pYnJvd3NlciAtLWd0ayAtLWRlYnVnCitgYGAKKworIyMjIE1hYwor CitTZXQgYSB2YWx1ZSBmb3IgdGhlIGBXZWJDb3JlTG9nZ2luZ2Aga2V5IGluIFtzdGFuZGFyZFVz ZXJEZWZhdWx0c10oaHR0cHM6Ly9kZXZlbG9wZXIuYXBwbGUuY29tL2RvY3VtZW50YXRpb24vZm91 bmRhdGlvbi9uc3VzZXJkZWZhdWx0cy8xNDE2NjAzLXN0YW5kYXJkdXNlcmRlZmF1bHRzKS4KKwor WW91IG1heSBhbHNvIHBhc3MgdGhpcyBrZXkgYW5kIHZhbHVlIGFzIGFuIGFyZ3VtZW50OgorCitg YGAKK1Rvb2xzL1NjcmlwdHMvcnVuLW1pbmlicm93c2VyIC0tZGVidWcgLVdlYkNvcmVMb2dnaW5n IFNjcm9sbGluZworYGBgCisKK29yIHNldCB0aGUga2V5IGFuZCB2YWx1ZSBvbiB0aGUgW05TR2xv YmFsRG9tYWluXShodHRwczovL2RldmVsb3Blci5hcHBsZS5jb20vZG9jdW1lbnRhdGlvbi9mb3Vu ZGF0aW9uL25zZ2xvYmFsZG9tYWluKS4KKworYGBgCitkZWZhdWx0cyB3cml0ZSBOU0dsb2JhbERv bWFpbiAgV2ViQ29yZUxvZ2dpbmcgLXN0cmluZyBTY3JvbGxpbmcKK1Rvb2xzL1NjcmlwdHMvcnVu LW1pbmlicm93c2VyIC0tZGVidWcKK2BgYAorCisjIyMgV2luZG93cwogCitTZXQgdGhlIGBXZWJD b3JlTG9nZ2luZ2AgZW52aXJvbm1lbnQgdmFyaWFibGUuCg==