doc remix
[eclipsethinslicer.git] / Svelte / doc / HOWTOINSTALLSOURCE-GITGUI.txt
blobaf7ad43a4d2147d47046e5f4a38440fa6bf57b06
1 HOWTO DOWNLOAD ECLIPSE THIN SLICER SOURCE CODE USING WINDOWS GIT-GUI
3 NOTE: If you prefer to use the git command line, see 
4 HOWTOINSTALLSOURCE-GITBASH.txt
6 1. Download and install git from
7 http://code.google.com/p/msysgit/downloads/list
8 (Git-1.5.5-preview20080413.exe is fine)
9 Git is a powerful distributed version control system used to keep the slicer source code.
11 WARNING: If you download git-1.5.5 or later, the autocrlf option, which 
12 converts between Windows and UNIX newlines, will be on by default. This 
13 causes problems with the WALA and slicer repositories and it will look 
14 like you have modified files when you have not, which may result in 
15 merge errors. If you are using git-1.5.5 or later, open Git Bash and 
16 type the following command to disable the autocrlf option:
18 git config --global core.autocrlf false
20 You only have to do this once.
22 2. Get WALA, WALA incubator, and Eclipse Thin Slicer source code via git
23 Open Git Gui, click "Clone Existing Repository". For URL, type:
24 git://repo.or.cz/wala.git
25 For directory, choose a new empty directory to hold the WALA source code.
26 I reccommend having a directory such as "git" and then subdirectories for
27 wala, walaincubator, and eclipsethinslicer.
29 Clone the repository, and then repeat the process for the following two
30 repositories:
31 git://repo.or.cz/walaincubator.git
32 git://repo.or.cz/eclipsethinslicer.git
34 3. Create/switch branches (actually merge this step with download)
35 In Git-GUI open with the "wala" repository, create a remote tracking
36 branch by doing the following:
37 a. go to Branch -> Create
38 b. choose "Match Tracking Branch Name" under Branch Name
39 c. choose v1.1.2-jdt and click Create.
40 d. go to Branch -> Checkout and checkout the branch you created.
42 This is a version of WALA, branched off from v1.1.2, with a JDT WALA
43 backend. You can repeat this to make more local branches for v1.1.2,
44 v1.1.2-LOCALBUGFIXES (WALA v1.1.2 with additional bugfixes), if you wish
45 to look at / work with these versions.
47 In Git-GUI open with the "walaincubator" repository, and create a remote
48 tracking branch as above for branch v1.1.2. Then check it out too.
50 You do not have to do this with the slicer, the default branch (master) is
51 what you want.
53 4. As described the WALA Getting Started Guide
54 (http://wala.sourceforge.net/wiki/index.php/UserGuide:Getting_Started),
55 install the following in the wala repository directory:
56 * in com.ibm.wala.cast.java/lib:
57 polyglot.jar
58 java_cup.jar
60 * in com.ibm.wala.cast.js/lib:
61 js.jar
62 xalan.jar
64 5. Launch Eclipse and create a new fresh workspace. Go to File -> Import.
65 Under General, choose "Existing Projects into Workspace". Find the
66 directory that contains you used git to download the Eclipse Thin Slicer
67 into -- i.e. the directory which contains "Svelte" and choose this, and
68 then import the Svelte project. Repeat for "wala" and "walaincubator".
69 From "wala", you need everything but com.ibm.wala.j2ee. From
70 "walaincubator", you just need com.ibm.wala.eclipse and
71 com.ibm.wala.eclipse.tests
73 6. Debug or run the projects using the "wala.eclipse" launcher. In the new
74 workspace you should be ready to use the slicer. Try opening a java file,
75 selecting some text, and hitting the "CI" button.