<html><head><meta http-equiv="Content-Type" content="text/html charset=utf-8"></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class=""><div class="">Follow up on this:</div><div class=""><br class=""></div><div><blockquote type="cite" class=""><div class="">On Jan 29, 2016, at 11:38 AM, Filip Pizlo <<a href="mailto:fpizlo@apple.com" class="">fpizlo@apple.com</a>> wrote:</div><br class="Apple-interchange-newline"><div class=""><meta http-equiv="Content-Type" content="text/html charset=utf-8" class=""><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class="">I started coverting the documentation to Markdown. I don’t think this is a good idea.<div class=""><br class=""></div><div class="">- Markdown has no definition lists. The entire IR document is a definition list. I don’t want B3’s documentation to be blocked on this issue.</div></div></div></blockquote><div><br class=""></div><div>It turns out that it does have them, but they are very weak. For example, you can’t have code blocks or paragraphs inside them. We want to have code blocks inside opcode definitions, to show examples.</div><br class=""><blockquote type="cite" class=""><div class=""><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class=""><div class="">- Markdown’s conversion step makes the workflow awkward. I’m not going to use some Markdown editing app - that will prevent me from being able to properly format code examples. I need a code editor for that.</div></div></div></blockquote><div><br class=""></div><div>This was hard to get around. This isn’t a problem with Markdown, but rather, a problem with using Wordpress to render Markdown that is in svn. There is no way to preview the Markdown before committing it. That would lead to unusual problems, where after a patch is landed, the patch author or someone else would have to do a bunch of blind follow-up commits to fix any style issues, like code blocks that don’t fit properly or whatever.</div><div><br class=""></div><div>Considering that we will have to be hacking raw HTML inside those Markdown files (due to definition lists), the lack of preview basically means that you have no way of predicting what the your HTML will render like.</div><br class=""><blockquote type="cite" class=""><div class=""><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class=""><div class=""><br class=""></div><div class="">I think that this documentation should be HTML. I don’t think we should expend a lot of energy to formatting it nicely. The point of this document is for it to be read by engineers while they hack code.</div></div></div></blockquote><div><br class=""></div><div>I landed raw HTML documentation: <a href="http://trac.webkit.org/changeset/195841" class="">http://trac.webkit.org/changeset/195841</a></div><div><br class=""></div><div>I filed this bug about improving its style: <a href="https://bugs.webkit.org/show_bug.cgi?id=153674" class="">https://bugs.webkit.org/show_bug.cgi?id=153674</a></div><div><br class=""></div><div>-Filip</div><div><br class=""></div><br class=""><blockquote type="cite" class=""><div class=""><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class=""><div class=""><br class=""></div><div class="">-Filip</div><div class=""><br class=""></div><div class=""><br class=""><div class=""><blockquote type="cite" class=""><div class="">On Jan 29, 2016, at 10:12 AM, Timothy Hatcher <<a href="mailto:timothy@apple.com" class="">timothy@apple.com</a>> wrote:</div><br class="Apple-interchange-newline"><div class=""><meta http-equiv="Content-Type" content="text/html charset=utf-8" class=""><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class=""><div class="">I also added:</div><div class=""><br class=""></div><div class=""><a href="https://webkit.org/documentation/b3/air/" class="">https://webkit.org/documentation/b3/air/</a> loads /docs/b3/assembly-intermediate-representation.md</div><br class=""><div class=""><blockquote type="cite" class=""><div class="">On Jan 29, 2016, at 10:05 AM, Filip Pizło <<a href="mailto:fpizlo@apple.com" class="">fpizlo@apple.com</a>> wrote:</div><br class="Apple-interchange-newline"><div class=""><meta http-equiv="content-type" content="text/html; charset=utf-8" class=""><div dir="auto" class=""><div class="">Thank you! I'll convert them today. <br class=""><br class="">-Filip</div><div class=""><br class="">On Jan 29, 2016, at 10:02 AM, Timothy Hatcher <<a href="mailto:timothy@apple.com" class="">timothy@apple.com</a>> wrote:<br class=""><br class=""></div><blockquote type="cite" class=""><div class=""><meta http-equiv="Content-Type" content="text/html charset=utf-8" class=""><div class="">Markdown is pretty similar to the wiki formatting and very simple.</div><div class=""><br class=""></div><div class="">You can look at a cheatsheet if you login to the blog: <a href="https://webkit.org/wp/wp-admin/post.php?post=4300&action=edit" class="">https://webkit.org/wp/wp-admin/post.php?post=4300&action=edit</a></div><div class=""><br class=""></div><div class=""><div class="">I have also used this HTML to Markdown converter before: <a href="http://domchristie.github.io/to-markdown/" class="">http://domchristie.github.io/to-markdown/</a></div></div><div class=""><br class=""></div><div class="">The pages are created:</div><div class=""><br class=""></div><div class=""><a href="https://webkit.org/documentation/b3/" class="">https://webkit.org/documentation/b3/</a> loads /docs/b3/bare-bones-backend.md</div><div class=""><a href="https://webkit.org/documentation/b3/intermediate-representation/" class="">https://webkit.org/documentation/b3/intermediate-representation/</a> loads /docs/b3/intermediate-representation.md</div><div class=""><br class=""></div><div class="">Once those files are added to SVN, they will get picked up by the site. I can change those to point to other names if you want something different.</div><div class=""><br class=""></div><div class="">— Timothy Hatcher</div><br class=""><div class=""><blockquote type="cite" class=""><div class="">On Jan 29, 2016, at 9:34 AM, saam barati <<a href="mailto:saambarati1@gmail.com" class="">saambarati1@gmail.com</a>> wrote:</div><br class="Apple-interchange-newline"><div class=""><meta http-equiv="content-type" content="text/html; charset=utf-8" class=""><div dir="auto" class=""><div class="">I'm happy to convert the document to markdown. Can you send me your latest revision or post it to the website?</div><div class=""><br class=""></div><div class="">I usually look at:</div><div class=""><a href="http://daringfireball.net/projects/markdown/syntax" class="">http://daringfireball.net/projects/markdown/syntax</a></div><div class="">For a refresher on the syntax.</div><div class=""><br class=""></div><div class="">Tim, could you create a page that loads the markdown file?</div><div class=""><br class=""></div><div class="">Thanks,<br class=""><div class="">Saam</div></div><div class=""><br class="">On Jan 29, 2016, at 12:06 AM, Filip Pizło <<a href="mailto:fpizlo@apple.com" class="">fpizlo@apple.com</a>> wrote:<br class=""><br class=""></div><blockquote type="cite" class=""><div class=""><meta http-equiv="content-type" content="text/html; charset=utf-8" class=""><div class="">I'm all for this but I don't know anything about markdown. </div><div class=""><br class=""></div><div class="">What's the best way to proceed?<br class=""><br class="">-Filip</div><div class=""><br class="">On Jan 28, 2016, at 9:24 PM, Timothy Hatcher <<a href="mailto:timothy@apple.com" class="">timothy@apple.com</a>> wrote:<br class=""><br class=""></div><blockquote type="cite" class=""><div class=""><meta http-equiv="content-type" content="text/html; charset=utf-8" class=""><div class="">They should be markdown files like we do for the code style and policy documents.</div><div class=""><br class=""></div><div class=""><a href="https://trac.webkit.org/browser/trunk/Websites/webkit.org/code-style.md" class="">https://trac.webkit.org/browser/trunk/Websites/webkit.org/code-style.md</a></div><div class=""><br class=""></div><div class="">We can then make Wordpress pages on the site that load the markdown.<br class=""><br class="">Maybe put them in a /docs/b3/ directory?<br class=""><br class=""><div class=""><div class="">— Timothy Hatcher</div></div></div><div class=""><br class="">On Jan 28, 2016, at 4:48 PM, Filip Pizlo <<a href="mailto:fpizlo@apple.com" class="">fpizlo@apple.com</a>> wrote:<br class=""><br class=""></div><blockquote type="cite" class=""><div class=""><meta http-equiv="Content-Type" content="text/html charset=utf-8" class="">I guess we could put it in Websites/<a href="http://webkit.org/b3" class="">webkit.org/b3</a>. Then patches could edit both B3 and the documentation in one go, and the documentation would go live when it’s committed.<div class=""><br class=""></div><div class="">Does anyone object to this?</div><div class=""><br class=""></div><div class="">-Filip<br class=""><div class=""><br class=""></div><div class=""><br class=""><div class=""><blockquote type="cite" class=""><div class="">On Jan 28, 2016, at 4:39 PM, Saam barati <<a href="mailto:sbarati@apple.com" class="">sbarati@apple.com</a>> wrote:</div><br class="Apple-interchange-newline"><div class=""><meta http-equiv="Content-Type" content="text/html charset=utf-8" class=""><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class="">Yeah. That’d be the easiest way to keep it up IMO.<div class=""><br class=""></div><div class="">Saam</div><div class=""><br class=""><div class=""><blockquote type="cite" class=""><div class="">On Jan 28, 2016, at 4:37 PM, Filip Pizło <<a href="mailto:fpizlo@apple.com" class="">fpizlo@apple.com</a>> wrote:</div><br class="Apple-interchange-newline"><div class=""><meta http-equiv="content-type" content="text/html; charset=utf-8" class=""><div dir="auto" class=""><div class="">+1</div><div class=""><br class=""></div><div class="">Do you think we should move the documentation to a file in svn so that it can be reviewed as part of patch review?<br class=""><br class="">-Filip</div><div class=""><br class="">On Jan 28, 2016, at 4:32 PM, Saam barati <<a href="mailto:sbarati@apple.com" class="">sbarati@apple.com</a>> wrote:<br class=""><br class=""></div><blockquote type="cite" class=""><div class=""><meta http-equiv="Content-Type" content="text/html charset=utf-8" class="">This is great. Thanks Fil.<div class=""><br class=""><div class="">I propose that we do all that we can to keep this updated.</div><div class="">I suggest that all patches that change to the IR should also include with it </div><div class="">a change to the documentation, and that reviewers should require this.</div><div class=""><br class=""></div><div class="">It’d also be great if other significant changes that seem like the deserve</div><div class="">a mention in the documentation also get added as part of patches.</div><div class=""><br class=""></div><div class="">Saam</div><div class=""><br class=""><div class=""><blockquote type="cite" class=""><div class="">On Jan 28, 2016, at 4:23 PM, Filip Pizlo <<a href="mailto:fpizlo@apple.com" class="">fpizlo@apple.com</a>> wrote:</div><br class="Apple-interchange-newline"><div class=""><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" class="">Hi everyone,<div class=""><br class=""></div><div class="">We’ve been working on a new compiler backend for the FTL JIT, which we call B3. It stands for “Bare Bones Backend”. We recently enabled it on X86/Mac, and we’re working hard to enable it on other platforms.</div><div class=""><br class=""></div><div class="">If you’re interested in how it works, I’ve started writing documentation. I’ll be adding more to it soon!</div><div class=""><a href="https://trac.webkit.org/wiki/BareBonesBackend" class="">https://trac.webkit.org/wiki/BareBonesBackend</a></div><div class=""><a href="https://trac.webkit.org/wiki/B3IntermediateRepresentation" class="">https://trac.webkit.org/wiki/B3IntermediateRepresentation</a></div><div class=""><br class=""></div><div class="">-Filip</div><div class=""><br class=""></div></div>_______________________________________________<br class="">webkit-dev mailing list<br class=""><a href="mailto:webkit-dev@lists.webkit.org" class="">webkit-dev@lists.webkit.org</a><br class=""><a href="https://lists.webkit.org/mailman/listinfo/webkit-dev" class="">https://lists.webkit.org/mailman/listinfo/webkit-dev</a><br class=""></div></blockquote></div><br class=""></div></div></div></blockquote></div></div></blockquote></div><br class=""></div></div></div></blockquote></div><br class=""></div></div></div></blockquote><blockquote type="cite" class=""><div class=""><span class="">_______________________________________________</span><br class=""><span class="">webkit-dev mailing list</span><br class=""><span class=""><a href="mailto:webkit-dev@lists.webkit.org" class="">webkit-dev@lists.webkit.org</a></span><br class=""><span class=""><a href="https://lists.webkit.org/mailman/listinfo/webkit-dev" class="">https://lists.webkit.org/mailman/listinfo/webkit-dev</a></span><br class=""></div></blockquote></div></blockquote></div></blockquote><blockquote type="cite" class=""><div class=""><span class="">_______________________________________________</span><br class=""><span class="">webkit-dev mailing list</span><br class=""><span class=""><a href="mailto:webkit-dev@lists.webkit.org" class="">webkit-dev@lists.webkit.org</a></span><br class=""><span class=""><a href="https://lists.webkit.org/mailman/listinfo/webkit-dev" class="">https://lists.webkit.org/mailman/listinfo/webkit-dev</a></span><br class=""></div></blockquote></div></div></blockquote></div><br class=""></div></blockquote></div></div></blockquote></div><br class=""></div></div></blockquote></div><br class=""></div></div>_______________________________________________<br class="">webkit-dev mailing list<br class=""><a href="mailto:webkit-dev@lists.webkit.org" class="">webkit-dev@lists.webkit.org</a><br class="">https://lists.webkit.org/mailman/listinfo/webkit-dev<br class=""></div></blockquote></div><br class=""></body></html>