Differential D3094 Diff 14018 ps/trunk/libraries/source/spidermonkey/README.txt

Changeset View

Standalone View

ps/trunk/libraries/source/spidermonkey/README.txt

	Important notice:			Important notice:
	-----------------			-----------------
	This version of SpiderMonkey comes from			This version of SpiderMonkey comes from
	https://ftp.mozilla.org/pub/spidermonkey/releases/45.0.2/mozjs-45.0.2.tar.bz2			https://ftp.mozilla.org/pub/spidermonkey/prereleases/52/pre1/mozjs-52.9.1pre1.tar.bz2

	The game must be compiled with precisely this version since SpiderMonkey			The game must be compiled with precisely this version since SpiderMonkey
	does not guarantee API stability and may have behavioural changes that			does not guarantee API stability and may have behavioural changes that
	cause subtle bugs or network out-of-sync errors.			cause subtle bugs or network out-of-sync errors.
	A standard system-provided version of the library may only be used if it's			A standard system-provided version of the library may only be used if it's
	exactly the same version or if it's another minor release that does not			exactly the same version or if it's another minor release that does not
	change the behaviour of the scripts executed by SpiderMonkey. Also it's			change the behaviour of the scripts executed by SpiderMonkey. Also it's
	crucial that "--enable-gcgenerational" was used for building the system			crucial that "--enable-gcgenerational" was used for building the system
	provided libraries and that exact stack rooting was not disabled.			provided libraries and that exact stack rooting was not disabled.
	Using different settings for compiling SpiderMonkey and 0 A.D.			Using different settings for compiling SpiderMonkey and 0 A.D.
	causes incompatibilities on the ABI (binary) level and can lead to			causes incompatibilities on the ABI (binary) level and can lead to
	crashes at runtime!			crashes at runtime!


	Building on Linux:			Building on Linux:
	------------------			------------------
	To build SpiderMonkey for use in 0 A.D. on Linux, just run build.sh.			To build SpiderMonkey for use in 0 A.D. on Linux, just run build.sh.


	Building on Mac OS X:			Building on Mac OS X:
	---------------------			---------------------
	Use the build-osx-libs.sh script in libraries/osx.			Use the build-osx-libs.sh script in libraries/osx.


	Building on Windows:			Building on Windows:
	--------------------			--------------------
	We provide precompiled binaries for Windows.			We provide precompiled binaries for Windows.
	If you still need to build on Windows, here's a short guide.			If you still need to build on Windows, here's a short guide.

	Setting up the build environment:			Setting up the build environment:
	1. Get https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Windows_Prerequisites#MozillaBuild			1. Get https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Windows_Prerequisites#MozillaBuild
				2. Download both an older version (2.x) which uses the old Mozilla build system, for NSPR; and the latest version to build
				SpiderMonkey. Install them to different locations.

	Building NSPR:			Building NSPR:
	1. Get nspr. We are using nspr-4.12 which was the newest version when SM45.0.2 was out.			1. Get nspr. We are using nspr-4.26 which was the newest version when this was written.
	Newer versions should probably work too.			Newer versions should probably work too.
	Download link: https://ftp.mozilla.org/pub/mozilla.org/nspr/releases/			Download link: https://ftp.mozilla.org/pub/mozilla.org/nspr/releases/
	2. Run mozillabuild (start-shell-msvc2015.bat) as administrator			2. Run MozillaBuild 2.x (start-shell-msvc2015.bat)
	3. Extract nspr to libraries/source/spidermonkey			3. Extract nspr to libraries/source/spidermonkey
	tar -xzvf nspr-4.12.tar.gz			tar -xzvf nspr-4.26.tar.gz
	cd nspr-4.12			cd nspr-4.26
	cd nspr			cd nspr
	4. Patch nspr with https://bugzilla.mozilla.org/show_bug.cgi?id=1238154#c7			4. Patch nspr with https://bugzilla.mozilla.org/show_bug.cgi?id=1238154#c15
	5. Call configure. I've used this command:			5. Call configure. I've used this command:
	./configure --disable-debug --enable-optimize --enable-win32-target=WIN95			./configure --disable-debug --enable-optimize --enable-win32-target=WIN95
	6. Call make			6. Call make

	Building SpiderMonkey:			Building SpiderMonkey:
	1. Adjust the absolute paths to nspr in the build.sh file to match your environment.			1. Adjust the absolute paths to nspr in the build.sh file to match your environment.
	2. Run mozillabuild (start-shell-msvc2015.bat) as administrator and run ./build.sh.			2. Run MozillaBuild 3.x (start-shell.bat) and run ./build.sh.