Changes for page Getting the Wonder Source Code

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Download Wonder Source, Build, Install and Upgrade
	1	+Downloading, Building, Installing and Upgrading Wonder Source Code

Content

...	...	@@ -9,70 +9,139 @@
9	9	* Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs
10	10	* Discover the many Hidden Treasures of Wonder.
11	11
12		-== Source Frameworks Initial Installation ==
	12	+== Downloading ==
13	13
14	14	{{tip title="Now with more Git"}}
15	15	As of March 25th, 2011 the Wonder source code is now maintained on [GitHub|https://github.com/] at [https://github.com/projectwonder]. So you'll need to be familiar with the [Git|http://git-scm.com/] Source Code Management system. You will use it to checkout a local copy of the repository (a "clone" in Git terms) allowing you to have direct access to the Wonder source.
16	16	{{/tip}}
17	17
18		-Open a terminal and navigate to a directory where you want to maintain a source "working copy" and just use the following easy-peasy commands to clone Wonder source to your own hard-drive.
	18	+Open a terminal and navigate to a directory where you want to maintain a source "working copy" and just use the following easy-peasy commands to clone Wonder source to your computer.
19	19
20		-1. Clone the source repository from github into a new directory named "WonderSource".
	20	+1. h5. Clone the source repository from github into a new directory named "WonderSource".
21	21
22	22	{{note title="Read Only"}}
23	23	Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
24	24	{{/note}}
25	25
26		-{{code}}
	26	+{{code value="none"}}
27	27	git clone git://github.com/projectwonder/wonder.git WonderSource
28	28	{{/code}}
29	29
30		-1. Navigate into the working copy root
	30	+You should see output something like this:
31	31
32		-{{code}}
	32	+{{noformat}}
	33	+
	34	+Cloning into WonderSource...
	35	+remote: Counting objects: 174269, done.
	36	+remote: Compressing objects: 100% (57304/57304), done.
	37	+remote: Total 174269 (delta 107374), reused 173934 (delta 107067)
	38	+Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done.
	39	+Resolving deltas: 100% (107374/107374), done.
	40	+
	41	+{{/noformat}}
	42	+
	43	+1. h5. Navigate into the working copy root
	44	+
	45	+{{code value="none"}}
33	33	cd WonderSource
34	34	{{/code}}
35	35
36	36	{{note title="WebObjects 5.3.3 Compatability"}}
37		-If you are still using old WebObjects 5.3.3, then you need to execute this git command to switch to the branch for WebObjects 5.3.3:{code}git checkout --track origin/Wonder_5_0_0_Legacy{code}
	50	+If you are still using old WebObjects 5.3.3, then you need to execute this git command to switch to the branch for WebObjects 5.3.3: {code}git checkout --track origin/Wonder_5_0_0_Legacy{code}
	51	+You should get output like this:
	52	+{noformat}
	53	+Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin.
	54	+Switched to a new branch 'Wonder_5_0_0_Legacy'
	55	+{noformat}
38	38
39	39	{{/note}}
40	40
41		-1. Build the frameworks from the source.
	59	+== Building ==
42	42
43		-{{code}}
	61	+In general, it is recommended that you use Hudson/Jenkins to build your WebObjects frameworks and applications, but it is not required. You can build either from the Terminal as outlined below, or from within Eclipse directly.
	62	+
	63	+{{tip title="Pro Tip"}}
	64	+If you use Hudson/Jenkins to build your WebObjects applications, then you do not need to actually build or install the Project Wonder frameworks on your development machine, just having the individual Wonder source code projects open in your eclipse workspace is sufficient. Your Hudson/Jenkins server will need the built frameworks installed. See the [Hudson/Jenkins Page|WO:Installing and Using the Hudson build server] for more information.
	65	+{{/tip}}
	66	+
	67	+{{note title="Requires WebObjects"}}
	68	+
	69	+These build instructions require the WebObjects frameworks to already be installed in the normal location:
	70	+* Mac OS X: {{/System/Library/Framworks/}}
	71	+* Linux: {{/Library/Frameworks}}
	72	+
	73	+Otherwise you will get compiler errors like this:
	74	+{noformat}
	75	+[wocompile] /Wonder/WonderGit/WonderSource/Frameworks/Core/JavaWOExtensions/Sources/com/webobjects/woextensions/JSAlertPanel.java:10:
	76	+ package com.webobjects.appserver does not exist
	77	+[wocompile] import com.webobjects.appserver.WOContext;
	78	+{noformat}
	79	+
	80	+{{/note}}
	81	+
	82	+You can build the Wonder frameworks from the source code you just cloned to the default (##/Roots##) directory with the following command:
	83	+
	84	+===== Build the frameworks from the "cloned" source. =====
	85	+
	86	+{{code value="none"}}
44	44	ant frameworks
45	45	{{/code}}
46	46
47		-1. Install the frameworks (this just copies the built frameworks from /Roots to the runtime Frameworks directory, usually at /Library/Frameworks)
	90	+== Installing ==
48	48
49		-{{code}}
	92	+Assuming you already cloned and installed Wonder from source using the method outlined above, you can use the following procedure pull the latest changes into your local repository.
	93	+
	94	+===== Install the frameworks =====
	95	+
	96	+{{code value="none"}}
50	50	sudo ant frameworks.install
51	51	{{/code}}
52	52
53		-== Source Frameworks Upgrade Installation ==
	100	+This copies the built frameworks from ##/Roots## to the runtime Frameworks directory:
54	54
55		-Assuming you already cloned and installed Wonder from source using the method outlined above, you can use the following procedure pull the latest changes into your local repository.
	102	+* Mac OS X: ##/Library/Framworks/##
	103	+* Linux: ##/Local/Library/Frameworks##
56	56
57		-{{code title="Updating your Source"}}
	105	+You can combine the build and install steps by simply executing this Ant command:
58	58
59		-# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
60		-cd ~/Roots/
	107	+{{code value="none"}}
	108	+sudo ant frameworks frameworks.install
	109	+{{/code}}
61	61
62		-# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
63		-for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
	111	+== Upgrading ==
64	64
65		-# Navigate to the original Wonder source directory that you created above during initial source installation
	113	+This will clean out the existing versions of the frameworks. This isn't strictly necessary, you could just re-install over the top of the old frameworks, but deleting then manually copying over the new ones will clean up any old frameworks that are no longer included in the standard build.
	114	+
	115	+1. h5. Navigate to the original Wonder source directory that you created above during initial source installation
	116	+
	117	+{{code value="none"}}
66	66	cd /path/to/WonderSource
	119	+{{/code}}
67	67
68		-# Pull the changes you do not have and merge them with your local repository
	121	+1. h5. Pull the changes you do not have and merge them with your local repository
	122	+
	123	+{{code value="none"}}
69	69	git pull
	125	+{{/code}}
70	70
71		-# Clean, build and install the frameworks
72		-ant clean; ant frameworks; sudo ant frameworks.install
	127	+1. h5. Build the frameworks.
73	73
	129	+{{code value="none"}}
	130	+ant frameworks
74	74	{{/code}}
75	75
	133	+1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	134	+
	135	+{{code value="none"}}
	136	+cd ~/Roots/
	137	+{{/code}}
	138	+
	139	+1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
	140	+
	141	+{{code value="none"}}
	142	+for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
	143	+{{/code}}
	144	+
76	76	{{info}}
77	77
78	78	If you have any trouble or errors due to your local repository getting hosed, then simply delete the entire local repository directory, the \~/Roots directory and just start over using the initial source clone and installation procedure outlined above.
...	...	@@ -85,15 +85,15 @@
85	85
86	86	For example:
87	87
	157	+{code:none}
	158	+cd my/special/purpose/clone/of/Wonder
	159	+ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
88	88	{code}
89		-$ cd my/special/purpose/clone/of/Wonder
90		-$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
91		-{code}
92	92
93	93	An example of where this approach might be used would be when you have different projects (perhaps in a specially designated workspace) that use a specific version of WebObjects and a specific version or branch of Wonder.
94	94
95	95	*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
96		-{code}
	165	+{code:none}
97	97	wo.external.root=/Users/mike/Developer/special/directory/Roots
98	98	{code}
99	99