[webkit-dev] A more detailed source tree overview
rniwa at webkit.org
Mon May 14 12:38:13 PDT 2012
I too share the concern that this wiki page will get out of date pretty
Like out-dated comments, out-dated (and therefore misleading) documentation
is often more harmful than not having documentation at all because readers
often don't even check whether it's out-dated or not.
On Mon, May 14, 2012 at 10:50 AM, Adam Barth <abarth at webkit.org> wrote:
> Unfortunately, the information in WebKitSourceLayout.md is much too
> detailed. It contains many facts that happen to be true at this
> moment, but are likely to change at any moment. It's unlikely that
> we'll keep this documentation up to date, which means it's just going
> to get stale and perhaps cause confusion.
> I would encourage you to dive in and fix bugs rather than trying to
> understand all of the code at the beginning. Our experience is that
> folks can make useful contributions to the project without
> understanding everything in detail ahead of time. The code review
> process is our main technique for teaching new contributors about the
> codebase. Contributing code also scales nicely in that you can
> contribute patches that grow in complexity as your understanding of
> the codebase grows.
> On Mon, May 14, 2012 at 9:07 AM, Breckin Loggins
> <bloggins+webkit at greatfoundry.com> wrote:
> > Hi all,
> > I've been trying to familiarize myself with the WebKit source tree. I
> > started at https://trac.webkit.org/wiki/HighLevelOverview but it is a
> > sparse. While I was checking out and building the code I decided to do
> > deeper browsing and document my findings. The resulting markdown doc is
> > attached.
> > Questions:
> > 1. Does this look like something you'd like to see added to the Wiki?
> > of the remarks are assumptions and may be incorrect (I marked ones where
> > was REALLY guessing with "(?)"). I'll be happy to fix any inaccuracies.
> > 2. I have a trac account but I didn't want to edit the existing High
> > Overview page or add a new page without permission. Is there
> > somewhere for the process of submitting wiki changes (as opposed to
> > committing code patches)?
> > Also, I think the markdown syntax will need to be tweaked and some links
> > changed to Wiki-relative ones rather than absolute URLs. I'll be sure to
> > change that once I get some guidance on adding this to the Wiki.
> > Thanks and Regards,
> > Breckin
> > _______________________________________________
> > webkit-dev mailing list
> > webkit-dev at lists.webkit.org
> > http://lists.webkit.org/mailman/listinfo.cgi/webkit-dev
> webkit-dev mailing list
> webkit-dev at lists.webkit.org
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the webkit-dev