| | 1 | = Using Eclipse CDT for developing WebKitGTK+ = |
| | 2 | |
| | 3 | This document is a howto about using Eclipse CDT to develop WebKitGTK+ |
| | 4 | |
| | 5 | |
| | 6 | == Getting Eclipse == |
| | 7 | |
| | 8 | We recommend downloading and installing the last release of Eclipse CDT directly from the official website: https://eclipse.org/cdt/ |
| | 9 | At least on Debian, the packaged version of Eclipse CDT is really ancient. |
| | 10 | |
| | 11 | == Increasing memory limits == |
| | 12 | |
| | 13 | When Eclipse's indexer tries to process the WebKit source, Eclipse will need considerably more memory than it allows itself out of the box. You should increase its memory limits using the eclipse.ini in your installation directory. Set something like -Xms1G -Xmx3G -XX:MaxPermSize=1G (initial heap space of 1 GB, max heap space of 3 GB, max perm-gen space of 1 GB). |
| | 14 | |
| | 15 | If you fail to increase these limits then you will likely find that Eclipse hangs when you try to index or work with the WebKit source later on. |
| | 16 | |
| | 17 | == Generating and importing the project into Eclipse == |
| | 18 | |
| | 19 | The build system of WebKitGTK+ comes with a feature to auto-generate an Eclipse project that later you can import directly. To get this feature working you have to take care of the following: |
| | 20 | |
| | 21 | 1. Ensure that eclipse is in your PATH. The autogenerator only triggers when it can find eclipse on your PATH. |
| | 22 | {{{ |
| | 23 | #!sh |
| | 24 | $ which eclipse |
| | 25 | # The above command should return the complete path to your eclipse binary. |
| | 26 | }}} |
| | 27 | |
| | 28 | 2. If you have just installed eclipse (it was not on your PATH before), then start with a clean build |
| | 29 | {{{ |
| | 30 | #!sh |
| | 31 | rm -fr WebKitBuild/Release |
| | 32 | }}} |
| | 33 | |
| | 34 | 3. Build WebKitGTK+ as usual, and after that ensure to create the following symlinks |
| | 35 | {{{ |
| | 36 | #!sh |
| | 37 | $ Tools/Scripts/build-webkit --gtk |
| | 38 | $ ln -fs WebKitBuild/Release/.project . |
| | 39 | $ ln -fs WebKitBuild/Release/.cproject . |
| | 40 | }}} |
| | 41 | |
| | 42 | 4. Now import the project into eclipse |
| | 43 | {{{ |
| | 44 | 1. File -> Import -> Existing Projects into Workspace -> Next |
| | 45 | 2. Input the path to where WebKitGTK+ is located |
| | 46 | 3. Select the project name that appears and click on Finish |
| | 47 | }}} |
| | 48 | |
| | 49 | == Further information == |
| | 50 | |
| | 51 | Check the Mozilla wiki regarding the usage of Eclipse CDT, they have some tips that you may find useful: https://developer.mozilla.org/en-US/docs/Eclipse_CDT |
