Changes between Version 20 and Version 21 of CommitterTips


Ignore:
Timestamp:
Mar 3, 2011 6:39:37 AM (10 years ago)
Author:
Adam Roben
Comment:

Added a tip about using auto-props to set the MIME type for PNGs correctly

Legend:

Unmodified
Added
Removed
Modified
  • CommitterTips

    v20 v21  
    4343When using "svn commit" to submit a patch, the commit message should be the ChangeLog message(s) for the patch.  WebKit maintains a script called "commit-log-editor" that populates the commit message for you.  To configure the editor that commit-log-editor opens, you can set the SVN_LOG_EDITOR environment variable to the editor of your choice (e.g. nano).  See the commit-log-editor source code [http://trac.webkit.org/browser/trunk/Tools/Scripts/commit-log-editor] for alternative options and to see how commit-log-editor decides what editor to use.
    4444
    45 3. '''Apply the patch to your local checkout.'''
     453. '''Set up Subversion.'''
     46
     47Subversion has a handy feature called `auto-props` that will ensure that new binary files you add to the repository are given the correct MIME type. To set this up, find the following two lines in `~/.subversion/config` and uncomment them:
     48
     49{{{
     50enable-auto-props = yes
     51
     52*.png = svn:mime-type=image/png
     53}}}
     54
     55Note that this will work even if you use `git-svn` to commit changes to WebKit.
     56
     574. '''Apply the patch to your local checkout.'''
    4658
    4759Use the "svn-apply" script to apply the patch to your local checkout.  Make sure the date and reviewer are correct in the ChangeLogs (e.g. by using the -r|--reviewer flag).  Alternatively, if the patch has been submitted to [http://bugs.webkit.org], you can use "webkit-patch apply-from-bug".  This script will find the patch and set the reviewer for you.
    4860
    49 4. '''Update your local checkout, if necessary.'''
     615. '''Update your local checkout, if necessary.'''
    5062
    5163If time has elapsed since applying the patch to your local checkout, you may need to update your checkout with the latest repository changes.  If an update causes a conflict in any ChangeLog files, you can use the resolve-ChangeLogs script to quickly resolve these conflicts and ensure that your ChangeLog changes are at the top.
     
    5365Alternatively, you can use the "update-webkit" script, which is smart enough to run resolve-ChangeLogs automatically, if necessary.
    5466
    55 5. '''Commit the changes.'''
     676. '''Commit the changes.'''
    5668
    5769Use the following command to commit changes--
     
    6880'''Note:''' The first time you commit, your SVN client may not pass your correct username (unless you use the --username option).  In this case, simply hit enter at the first password prompt.  This will cause a username prompt to appear and then a subsequent password prompt.  For the username prompt, type in the username you registered in [http://trac.webkit.org] above (i.e. your account e-mail address).  Your username will then be cached for future uses of the client.
    6981
    70 6. '''Register the commit in bugs.webkit.org.'''
     827. '''Register the commit in bugs.webkit.org.'''
    7183
    7284If you are committing a patch in [http://bugs.webkit.org], you should add a comment to the report with text like the following:
     
    7688Then change the status of the report to RESOLVED.
    7789
    78 7. '''Make sure you didn't break anything.'''
     908. '''Make sure you didn't break anything.'''
    7991
    8092Monitor [http://build.webkit.org/console] to make sure your patch doesn't turn any of the buildbots red!