<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56541] trunk/WebKitSite</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/56541">56541</a></dd>
<dt>Author</dt> <dd>jchaffraix@webkit.org</dd>
<dt>Date</dt> <dd>2010-03-25 07:27:54 -0700 (Thu, 25 Mar 2010)</dd>
</dl>

<h3>Log Message</h3>
<pre>Add a page on how to ask questions
https://bugs.webkit.org/show_bug.cgi?id=35223

Reviewed by David Levin.

* asking_questions.html: Added.
Add a page on how to ask questions based on Ariya Hidayat's mail: how
to get help effectively
(http://article.gmane.org/gmane.os.opendarwin.webkit.user/145/match=get+help+effectively)

* contact.html: Tweaked the wording to make it more clear what the
mailing list are used for. Also changed the formatting to better
underline the different mailing lists.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkWebKitSiteChangeLog">trunk/WebKitSite/ChangeLog</a></li>
<li><a href="#trunkWebKitSitecontacthtml">trunk/WebKitSite/contact.html</a></li>
</ul>

<h3>Added Paths</h3>
<ul>
<li><a href="#trunkWebKitSiteasking_questionshtml">trunk/WebKitSite/asking_questions.html</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkWebKitSiteChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/WebKitSite/ChangeLog (56540 => 56541)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/WebKitSite/ChangeLog        2010-03-25 14:13:56 UTC (rev 56540)
+++ trunk/WebKitSite/ChangeLog        2010-03-25 14:27:54 UTC (rev 56541)
</span><span class="lines">@@ -1,3 +1,19 @@
</span><ins>+2010-03-25  Julien Chaffraix  &lt;jchaffraix@webkit.org&gt;
+
+        Reviewed by David Levin.
+
+        Add a page on how to ask questions
+        https://bugs.webkit.org/show_bug.cgi?id=35223
+
+        * asking_questions.html: Added.
+        Add a page on how to ask questions based on Ariya Hidayat's mail: how
+        to get help effectively
+        (http://article.gmane.org/gmane.os.opendarwin.webkit.user/145/match=get+help+effectively)
+
+        * contact.html: Tweaked the wording to make it more clear what the
+        mailing list are used for. Also changed the formatting to better
+        underline the different mailing lists.
+
</ins><span class="cx"> 2010-03-24  Sam Weinig  &lt;sam@webkit.org&gt;
</span><span class="cx"> 
</span><span class="cx">         Rubber-stamped by Anders Carlsson..
</span></span></pre></div>
<a id="trunkWebKitSiteasking_questionshtml"></a>
<div class="addfile"><h4>Added: trunk/WebKitSite/asking_questions.html (0 => 56541)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/WebKitSite/asking_questions.html                                (rev 0)
+++ trunk/WebKitSite/asking_questions.html        2010-03-25 14:27:54 UTC (rev 56541)
</span><span class="lines">@@ -0,0 +1,143 @@
</span><ins>+&lt;?php
+    $title = &quot;Asking questions on webkit-help&quot;;
+
+$extra_head_content = &lt;&lt;&lt;END
+&lt;style type=&quot;text/css&quot;&gt;
+pre .code {
+   background-color: #F2F2F2;
+}
+
+.right {
+  color: #080 !important;
+}
+
+.wrong {
+  color: #f00 !important;
+}
+&lt;/style&gt;
+END;
+include(&quot;header.inc&quot;);
+?&gt;
+
+&lt;h1&gt; How to ask questions about WebKit &lt;/h1&gt;
+
+The following tips are for new members of any WebKit mailing list who want to get help on learning WebKit.
+These include advice on other ways to find answers and help that go beyond the WebKit's mailing lists.
+
+&lt;h2&gt; Search the archives &lt;/h2&gt;
+
+&lt;p&gt;Your question may have already been answered. Make sure you search at least webkit-help and webkit-dev archives.
+There are two ways to query the archives: doing a web search or the &lt;a
+href=&quot;http://dir.gmane.org/search.php?match=webkit&quot;&gt;gmane archives&lt;/a&gt;.&lt;/p&gt;
+&lt;p&gt;You can limit a web search to the mailing lists' archives by using &quot;site:lists.webkit.org&quot;.
+&lt;p&gt;Here is a small example on how to query information about 'RenderLayer' on the previous mailing lists archives:&lt;/p&gt;
+&lt;ul&gt;
+&lt;li&gt;&lt;a href=&quot;http://www.google.com/search?q=site:lists.webkit.org/pipermail/webkit-dev+RenderLayer&quot;&gt;webkit-dev entries for RenderLayer&lt;/a&gt;&lt;/li&gt;
+&lt;li&gt;&lt;a href=&quot;http://www.google.com/search?q=site:lists.webkit.org/pipermail/webkit-help+RenderLayer&quot;&gt;webkit-help entries for RenderLayer&lt;/a&gt;&lt;/li&gt;
+&lt;/ul&gt;
+
+&lt;h2&gt; Be precise &lt;/h2&gt;
+&lt;p&gt;Give as many details as possible. Generic questions will likely not get a valuable answer.&lt;/p&gt;
+
+&lt;p&gt;Make sure you include at least:
+&lt;ul&gt;
+&lt;li&gt; which port are you using: Mac, Windows, Chromium, Qt, Gtk, Wx, ...&lt;/li&gt;
+&lt;li&gt; which operating system are you using? For Linux, paste the result of &lt;code&gt;uname -a&lt;/code&gt;&lt;/li&gt;
+&lt;/ul&gt;
+&lt;/p&gt;
+&lt;p&gt;Depending on your issue, make also sure to include:
+&lt;ul&gt;
+&lt;li&gt; the revision or branch used&lt;/li&gt;
+&lt;li&gt; which compiler are you using? (including the version)&lt;/li&gt;
+&lt;li&gt; the CPU used&lt;/li&gt;
+&lt;li&gt; the command invoked&lt;/li&gt;
+&lt;li&gt; the &lt;strong&gt;complete output&lt;/strong&gt; of the command. Do not paste only what you think is relevant.&lt;/li&gt;
+&lt;li&gt; the expected result&lt;/li&gt;
+&lt;/ul&gt;
+&lt;/p&gt;
+
+&lt;p&gt;If one of these item is very long (hundreds of lines), do not paste it in the email. Instead use http://pastebin.com/
+(or other similar services) and include the link in the email.&lt;/p&gt;
+
+&lt;p&gt;Since we cannot read your mind, the more you give us, the easier it will be for us to help you.&lt;/p&gt;
+
+&lt;h2&gt; An example of question &lt;/h2&gt;
+
+&lt;p&gt;
+&lt;h4 class=&quot;wrong&quot;&gt;Wrong:&lt;/h4&gt;
+&lt;p&gt;WebKit does not compile!&lt;/p&gt;
+&lt;h4 class=&quot;right&quot;&gt;Right:&lt;/h4&gt;
+&lt;p&gt;When building Apple's port revision 34567 using &lt;code&gt;&quot;WebKitTools/Scripts/build-webkit --debug --no-svg&quot;&lt;/code&gt;, I get the following error:&lt;/p&gt;
+&lt;code&gt;
+Cannot find class Foobar.
+&lt;/code&gt;
+&lt;p&gt;(You can find the complete output here: &lt;a href=&quot;http://pastebin.com/foobar&quot;&gt;http://pastebin.com/foobar&lt;/a&gt;).
+
+I have looked at the archives and the commits but did not find any solution. Does anyone know what could be the issue and whether this has been fixed?
+&lt;/p&gt;
+
+&lt;h2&gt; Usual questions and answers &lt;/h2&gt;
+
+&lt;p&gt;There are some questions that appear regularly on the mailing list. We have included the answers here for your convenience.&lt;/p&gt;
+
+&lt;h3&gt; Does WebKit supports Foo? &lt;/h3&gt;
+
+&lt;p&gt;The most reliable way to answer it is by looking at the source code. WebKit development is fast
+paced. Often the requested feature is already implemented although it has
+not been widely used yet. Bear in mind that sometimes the level of
+supports between different ports is not the same.&lt;/p&gt;
+&lt;p&gt;The following links are also useful:
+&lt;ul&gt;
+&lt;li&gt;&lt;a href=&quot;http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(HTML)&quot;&gt;Wikipedia comparison of the layout engines: HTML support&lt;/a&gt;&lt;br&gt;&lt;/li&gt;
+&lt;li&gt;&lt;a href=&quot;http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(XML)&quot;&gt;Wikpedia comparison of the layout engines: XML support&lt;/a&gt;&lt;br&gt;&lt;/li&gt;
+&lt;li&gt;&lt;a href=&quot;http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(Cascading_Style_Sheets)&quot;&gt;Wikipedia comparison of the layout engines: CSS support&lt;/a&gt;&lt;br&gt;&lt;/li&gt;
+&lt;li&gt;&lt;a href=&quot;http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(Document_Object_Model)&quot;&gt;Wikipedia comparision of the layout engines: DOM support&lt;/a&gt;&lt;br&gt;&lt;/li&gt;
+&lt;li&gt;&lt;a href=&quot;http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(HTML_5)&quot;&gt;Wikipedia comparision of the layout engines: HTML5 support&lt;/a&gt;&lt;br&gt;&lt;/li&gt;
+&lt;li&gt;&lt;a href=&quot;http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(ECMAScript)&quot;&gt;Wikipedia comparison of the layout engines: ECMAScript support&lt;/a&gt;&lt;br&gt;&lt;/li&gt;
+&lt;li&gt;&lt;a href=&quot;http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(Scalable_Vector_Graphics)&quot;&gt;Wikipedia comparison of the layout engines: SVG support&lt;br&gt;&lt;/li&gt;
+&lt;li&gt;&lt;a href=&quot;http://en.wikipedia.org/wiki/Comparison_of_layout_engines_(Non-standard_HTML)&quot;&gt;Wikipedia comparison of the layout engines: non standard HTML support&lt;/a&gt;&lt;br&gt;&lt;/li&gt;
+&lt;/ul&gt;
+&lt;/p&gt;
+
+&lt;h3&gt; I want to port WebKit to a new platform &lt;/h3&gt;
+
+&lt;p&gt;As a starting point, check first &lt;a href=&quot;http://trac.webkit.org/wiki/SuccessfulPortHowTo&quot;&gt;the sucessful port how to page&lt;/a&gt;.&lt;/p&gt;
+
+&lt;p&gt;Granted, it's not complete, so feel free to contribute. Try to find a port similar to what you are targeting and use it
+as a basis, instead of writing everything from scratch. While doing your port, you may find that you wished the page had 
+mentioned that fact. Please modify the page and add it.&lt;/p&gt;
+
+&lt;h3&gt; How does bar work? &lt;/h3&gt;
+
+&lt;p&gt;The best way to answer this is to use your debugger. Set a break point where you want to investigate and get a stack
+trace. Then, you will see which functions call your code.&lt;/p&gt;
+
+&lt;h2&gt; Things to remember when you ask a question &lt;/h2&gt;
+
+&lt;ul&gt;
+&lt;li&gt; We offer our help on a voluntary basis so you can't expect us to be
+100% at your disposal. Be patient. No need to insist on the urgency. Asking urgently
+for an answer usually does not get you the answer faster.&lt;/li&gt;
+
+&lt;li&gt; We love to grow our community, and thus we like to help beginners. After all,
+every expert was a beginner at some point in his/her lifetime. However, nobody likes
+&lt;strong&gt;lazy&lt;/strong&gt; beginners. Thus, if you face a problem, try to analyze and
+solve it yourself first &lt;strong&gt;before&lt;/strong&gt; asking for help.&lt;/li&gt;
+
+&lt;li&gt; WebKit is a big project with a huge code base, so you must be willing
+to spend your time and effort on learning the source code. Remember,
+you can not become a Grand Master just by skimming some chess learning
+books.&lt;/li&gt;
+
+&lt;li&gt;Last but not least, there are often complaints that WebKit code
+is not easy to understand. Well, this is your chance to contribute! We
+have started some helping pages on this, just check out:
+&lt;a href=&quot;http://trac.webkit.org/wiki/WikiStart#GettingAroundtheWebKitSourceCode&quot;&gt;our wiki's page on how to get around the code&lt;/a&gt;&lt;/li&gt;
+&lt;/ul&gt;
+
+&lt;p&gt;Do not hesitate to fill the wiki page with new information which will help
+others to learn!&lt;/p&gt;
+
+&lt;?php
+include(&quot;footer.inc&quot;);
+?&gt;
</ins></span></pre></div>
<a id="trunkWebKitSitecontacthtml"></a>
<div class="modfile"><h4>Modified: trunk/WebKitSite/contact.html (56540 => 56541)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/WebKitSite/contact.html        2010-03-25 14:13:56 UTC (rev 56540)
+++ trunk/WebKitSite/contact.html        2010-03-25 14:27:54 UTC (rev 56541)
</span><span class="lines">@@ -5,21 +5,33 @@
</span><span class="cx"> &lt;h2&gt;Keeping in Touch&lt;/h2&gt;
</span><span class="cx"> 
</span><span class="cx"> &lt;h3&gt;Mailing Lists&lt;/h3&gt;
</span><del>-&lt;p&gt;There are a number of mailing lists for WebKit related topics. Archives for all the lists as well as information on joining them are available on the individual list page.&lt;/p&gt;
</del><ins>+&lt;p&gt;&lt;strong&gt;Before posting to any mailing list&lt;/strong&gt; make sure that you have checked our page on how to &lt;a href=&quot;asking_questions.html&quot;&gt;ask questions about WebKit.&lt;/a&gt;&lt;/p&gt;
+&lt;p&gt;There are a number of mailing lists for WebKit related topics. Archives for all the lists as well as information on joining them are available on the individual list page. There is also a &lt;a href=&quot;http://dir.gmane.org/&quot;&gt;gmane archive&lt;/a&gt; for some of the following mailing lists.&lt;/p&gt;
</ins><span class="cx"> 
</span><del>-&lt;p&gt;&lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-help&quot;&gt;webkit-help&lt;/a&gt; is for requests for help with building webkit, using WebKit's APIs, embedding WebKit, porting WebKit, and so forth.&lt;/p&gt;
</del><ins>+&lt;ul&gt;
+&lt;li&gt;&lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-help&quot;&gt;webkit-help&lt;/a&gt; is for requests for help related to WebKit. It is the main mailing
+list. Most of the questions will go to this mailing list. Usual topics include:
+&lt;ol&gt;
+&lt;li&gt;how to build WebKit&lt;/li&gt;
+&lt;li&gt;how to use WebKit's APIs&lt;/li&gt;
+&lt;li&gt;how to embed WebKit&lt;/li&gt;
+&lt;li&gt;how to port WebKit&lt;/li&gt;
+&lt;/ol&gt;
+&lt;/li&gt;
</ins><span class="cx"> 
</span><del>-&lt;p&gt;&lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-jobs&quot;&gt;webkit-jobs&lt;/a&gt; is for WebKit-related jobs.&lt;/p&gt;
</del><ins>+&lt;li&gt;&lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-jobs&quot;&gt;webkit-jobs&lt;/a&gt; is for WebKit-related jobs.&lt;/li&gt;
</ins><span class="cx"> 
</span><del>-&lt;p&gt;&lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-dev&quot;&gt;webkit-dev&lt;/a&gt; is for discussion of WebKit development.&lt;/p&gt;
</del><ins>+&lt;li&gt;&lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-dev&quot;&gt;webkit-dev&lt;/a&gt; is for discussion of the WebKit project's development per itself.
+If you do not intent to contribute patches to WebKit, you should direct your questions to webkit-help.&lt;/li&gt;
</ins><span class="cx"> 
</span><del>-&lt;p&gt;&lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-reviews&quot;&gt;webkit-reviews&lt;/a&gt; is a list for notification of review requests. Bugzilla automatically notifies this list of all patches awaiting review.&lt;/p&gt;
</del><ins>+&lt;li&gt;&lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-reviews&quot;&gt;webkit-reviews&lt;/a&gt; is a list for notification of review requests. Bugzilla automatically notifies this list of all patches awaiting review.&lt;/li&gt;
</ins><span class="cx"> 
</span><del>-&lt;p&gt;New repository commit information is automatically sent to the &lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-changes&quot;&gt;webkit-changes&lt;/a&gt; mailing list.&lt;/p&gt;
</del><ins>+&lt;li&gt;New repository commit information is automatically sent to the &lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-changes&quot;&gt;webkit-changes&lt;/a&gt; mailing list.&lt;/li&gt;
</ins><span class="cx"> 
</span><del>-&lt;p&gt;New bugs are assigned to the &lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-unassigned&quot;&gt;webkit-unassigned&lt;/a&gt; mailing list by default, which is notified of the new bugs, as well as their updates and changes.&lt;/p&gt;
</del><ins>+&lt;li&gt;New bugs are assigned to the &lt;a href=&quot;http://lists.webkit.org/mailman/listinfo/webkit-unassigned&quot;&gt;webkit-unassigned&lt;/a&gt; mailing list by default, which is notified of the new bugs, as well as their updates and changes.&lt;/li&gt;
</ins><span class="cx"> 
</span><del>-&lt;p&gt;If you would like to discuss development of applications using WebKit on Mac OS X, the right list is one hosted on an Apple list server: &lt;a href=&quot;http://www.lists.apple.com/mailman/listinfo/webkitsdk-dev&quot;&gt;webkitsdk-dev&lt;/a&gt;.&lt;/p&gt;
</del><ins>+&lt;li&gt;If you would like to discuss development of applications using WebKit on Mac OS X, the right list is one hosted on an Apple list server: &lt;a href=&quot;http://www.lists.apple.com/mailman/listinfo/webkitsdk-dev&quot;&gt;webkitsdk-dev&lt;/a&gt;.&lt;/li&gt;
+&lt;/ul&gt;
</ins><span class="cx"> 
</span><span class="cx"> &lt;h3&gt;IRC&lt;/h3&gt;
</span><span class="cx"> 
</span></span></pre>
</div>
</div>

</body>
</html>