Bug 31993 - http://webkit.org/coding/coding-style.html should mention check-webkit-style
Summary: http://webkit.org/coding/coding-style.html should mention check-webkit-style
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: WebKit Website (show other bugs)
Version: 528+ (Nightly build)
Hardware: PC OS X 10.5
: P2 Normal
Assignee: László Langó
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-11-30 12:27 PST by Eric Seidel (no email)
Modified: 2014-08-27 06:11 PDT (History)
7 users (show)

See Also:


Attachments
Patch (1.80 KB, patch)
2013-11-29 03:57 PST, ezisfake
no flags Details | Formatted Diff | Diff
Patch for landing (1.98 KB, patch)
2014-08-27 05:28 PDT, László Langó
no flags Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Eric Seidel (no email) 2009-11-30 12:27:29 PST
http://webkit.org/coding/coding-style.html should mention check-webkit-style

We now have this nice tool for checking some of the rules of WebKit style.  Our style page should mention the tool and explain its use.
Comment 1 ezisfake 2013-11-29 03:57:18 PST
Created attachment 218051 [details]
Patch
Comment 2 ezisfake 2014-01-15 08:51:11 PST
ping
Comment 3 László Langó 2014-03-14 02:32:02 PDT
(In reply to comment #1)
> Created an attachment (id=218051) [details]
> Patch

I think we need a more detailed description of it's usage.
Comment 4 Darin Adler 2014-08-19 09:22:04 PDT
Comment on attachment 218051 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=218051&action=review

> Websites/webkit.org/coding/contributing.html:94
> +<p>Your patch will be automatically checked for style compliance before uploading if you use webkit-patch upload.

This mention of webkit-patch upload here is not formatted the way the other mentions in this document are.

> Websites/webkit.org/coding/contributing.html:95
> +You can do it manually with the check-webkit-style script and will be checked always after uploading by <a href="http://trac.webkit.org/wiki/EWS">EWS</a>.

Grammar mistake here. It says:

    You can do it and will be checked

I would write something more like this:

    You can check style manually by running the Tools/Scripts/check-webkit-style script. Style will also be checked on each patch after it is uploaded by the <a href="http://trac.webkit.org/wiki/EWS">WebKit Early Warning System</a>.

It’s a little strange to have a link to the wiki from this page. Normally we don’t do that.
Comment 5 László Langó 2014-08-27 05:28:54 PDT
Created attachment 237220 [details]
Patch for landing
Comment 6 WebKit Commit Bot 2014-08-27 06:11:07 PDT
Comment on attachment 237220 [details]
Patch for landing

Clearing flags on attachment: 237220

Committed r173003: <http://trac.webkit.org/changeset/173003>
Comment 7 WebKit Commit Bot 2014-08-27 06:11:12 PDT
All reviewed patches have been landed.  Closing bug.