An initial commit to support navigation menu in GitHub Pages website
[jpf-core.git] / docs / install / repo_shell.md
1 # Checkout and Build from Shell Prompt (Unix) #\r
2 \r
3 While there is a CVS repository on the JPF Sourceforge site, it is not in use anymore. The current version is kept in the Subversion repository.\r
4 \r
5 <note> We will shift to a distributed version control system (Mercurial or Git) soon</note>\r
6 \r
7 \r
8 # SVN #\r
9 \r
10 This is not a general introduction of [nor do we cover details of [[https://sourceforge.net/svn/?group_id=136825|Subversion on Sourceforge]((SVN),)(http://subversion.tigris.org|Subversion]]). To obtain the current JPF version, execute the following command from a shell prompt:\r
11 \r
12 ~~~~~~~~ {.bash}\r
13 >svn checkout https://javapathfinder.svn.sourceforge.net/svnroot/javapathfinder/trunk\r
14 ~~~~~~~~\r
15 \r
16 To update later-on, enter from within one of the javapathfinder directories\r
17 \r
18 \r
19 ~~~~~~~~ {.bash}\r
20 >svn update\r
21 ~~~~~~~~\r
22 \r
23 To commit (in case you are a project member and have a sourceforge account), use\r
24 \r
25 \r
26 ~~~~~~~~ {.bash}\r
27 >svn commit -m "commit message" \r
28 ~~~~~~~~\r
29 \r
30 In order to build and test JPF from the commandline, you need Ant and JUnit. If you do not want to use the scripts and versions that are provided with JPF, make sure you have set up your *CLASSPATH* to contain both tools. As of Ant 1.6.5 and JUnit 4.1, this involves the following environment settings:\r
31 \r
32 \r
33 ~~~~~~~~ {.bash}\r
34 >export PATH=$PATH:<your-ant-dir>/bin\r
35 >export CLASSPATH=<your-ant-dir>/lib/ant.jar:<your-junit-dir>/junit-4.1.jar\r
36 ~~~~~~~~\r
37 \r
38 ~~~~~~~~\r
39 <note tip> for your convenience, we have added all required external libraries \r
40 and scripts to the *build-tools* directory, so you do not have to install \r
41 any of the external components.</note>\r
42 ~~~~~~~~\r
43 Now you can proceed as described in section Building JPF from a Command Line. For the impatient reader, this is mainly one command\r
44 \r
45 \r
46 ~~~~~~~~ {.bash}\r
47 >cd javapathfinder-trunk\r
48 >build-tools/bin/ant run-tests\r
49 \r
50 Buildfile: build.xml\r
51 \r
52 init:\r
53     [mkdir] Created dir: /users/pcmehlitz/projects/javapathfinder-trunk/build\r
54  ...\r
55 compile-jpf:\r
56     [javac] Compiling 543 source files to /users/pcmehlitz/projects/javapathfinder-trunk/build/jpf\r
57  ...\r
58 run-tests:\r
59      [echo] --- running Junit tests from build/test..\r
60     [junit] Running TestJavaLangObjectJPF\r
61     [junit] Tests run: 1, Failures: 0, Errors: 0, Time elapsed: 0.876 sec\r
62  ...\r
63 BUILD SUCCESSFUL\r
64 Total time: 2 minutes 25 seconds\r
65 ~~~~~~~~\r
66 \r
67 or (especially for non-Unix folk)\r
68 \r
69 \r
70 ~~~~~~~~ {.bash}\r
71 >java RunAnt run-tests\r
72 ~~~~~~~~\r
73 \r
74 which should compile the whole system and runs the regression test suite with the provided Ant and JUnit versions.