[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]
[or-cvs] r12975: Merge docs/build-instructions.txt and build-scripts/INSTALL; (in torbrowser/trunk: build-scripts docs)

To: or-cvs@xxxxxxxxxxxxx
Subject: [or-cvs] r12975: Merge docs/build-instructions.txt and build-scripts/INSTALL; (in torbrowser/trunk: build-scripts docs)
From: sjm217@xxxxxxxx
Date: Tue, 25 Dec 2007 09:55:11 -0500 (EST)
Delivered-to: archiver@xxxxxxxx
Delivered-to: or-cvs-outgoing@xxxxxxxx
Delivered-to: or-cvs@xxxxxxxx
Delivery-date: Tue, 25 Dec 2007 09:55:18 -0500
Reply-to: or-dev@xxxxxxxxxxxxx
Sender: owner-or-cvs@xxxxxxxxxxxxx
Author: sjm217
Date: 2007-12-25 09:55:11 -0500 (Tue, 25 Dec 2007)
New Revision: 12975

Added:
   torbrowser/trunk/build-scripts/INSTALL
   torbrowser/trunk/docs/rationale.txt
Removed:
   torbrowser/trunk/build-scripts/README
   torbrowser/trunk/docs/build-instructions.txt
Log:
Merge docs/build-instructions.txt and build-scripts/INSTALL; start off docs/rationale.txt

Copied: torbrowser/trunk/build-scripts/INSTALL (from rev 12974, torbrowser/trunk/build-scripts/README)
===================================================================
--- torbrowser/trunk/build-scripts/INSTALL	                        (rev 0)
+++ torbrowser/trunk/build-scripts/INSTALL	2007-12-25 14:55:11 UTC (rev 12975)
@@ -0,0 +1,173 @@
+###
+### Instructions for building Tor Browser Bundle components
+###
+### Copyright 2007 Steven J. Murdoch <http://www.cl.cam.ac.uk/users/sjm217/>
+### See LICENSE for licensing information
+###
+### $Id$
+###
+
+Contents
+========
+
+- Building Tor Browser Bundle
+- Building Vidalia
+- Building OpenSSL, zlib, libevent and Tor
+- Building Firefox
+
+
+Building Tor Browser Bundle
+===========================
+
+To build Tor Browser Bundle, you need to have built:
+ Vidalia (in /c/build/vidalia by default)
+ Tor (in /c/build/tor-<version> by default)
+and have uncompressed Firefox Portable
+ FirefoxPortable (in ./FirefoxPortable/ by default)
+
+Instructions for building Vidalia and Tor are included below.
+
+To compress the bundle and build the self-extracting executable you
+need to have installed 7zip.
+
+Vidalia needs to have the BrowserExecutable functionality. Currently
+this is only available in the Vidalia trunk.
+
+FirefoxPortable can be downloaded from:
+ http://portableapps.com/apps/internet/firefox_portable
+
+7zip is needed to compress the bundle can be downloaded from:
+ http://www.7-zip.org/download.html
+
+Customization
+-------------
+
+The locations of Qt, MinGW32, the Vidalia/Tor build directory, 7zip,
+FirefoxPortable can be altered in Makefile.
+
+Building the bundle
+-------------------
+
+Firefox must not be running while you are building the bundle.
+
+Run "make bundle"
+
+To specify a different language configuration, set $LANGCODE,
+e.g. "LANGCODE=fa make bundle" or "LANGCODE=zh-cn make bundle"
+
+To compress it, run "make compress-bundle"
+
+
+Building Vidalia
+================
+
+Full instructions are in the Vidalia INSTALL file.
+
+Building under MSYS
+-------------------
+
+Add the following to /etc/profile:
+ export QTDIR="C:\Qt\4.3.2"
+ export PATH=$PATH:/c/Qt/4.3.2/bin
+ export QMAKESPEC=win32-g++
+
+Then run:
+ $ cmake -G "MSYS Makefiles" .
+ $ make
+
+Building under MinGW32
+----------------------
+
+Qt and CMake must be in the %PATH%. An easy way to do this is to
+copy qtvars.bat and add the path to CMake. Then, copy the shortcut
+from the Start menu, and edit the path to point to the altered
+qtvars.bat
+
+Then run:
+ > cmake -G "MinGW Makefiles" .
+ > mingw32-make
+
+Patches
+-------
+
+The patch to add the BrowserExecutable option is in:
+ ../src/archived-patches/vidalia-startbrowser.patch
+As of Vidalia revision 2207, this patch is now integrated and so no
+longer needs to be applied manually:
+ http://trac.vidalia-project.net/changeset/2207
+
+A patch to close the Browser when Vidalia exits is in:
+ ../src/vidalia-killbrowser.patch
+This is not yet useful, since killing FirefoxPortable does not cause
+Firefox to exit. This patch has not yet been applied to Vidalia.
+
+
+Building OpenSSL, zlib, libevent and Tor
+========================================
+
+Full instructions in:
+ https://tor-svn.freehaven.net/svn/tor/trunk/doc/tor-win32-mingw-creation.txt
+
+Uncompressing OpenSSL shows a number of errors concerning symlinks.
+These do not appear to have caused a problem.
+
+For zlib, use the first option (zlib.a)
+
+For libevent, use 1.3e, as suggested by the document above.
+libevent 1.4.0 is newer but untested.
+
+It is tor-resolve, not tor_resolve.exe
+
+Autoconf 2.56 appears to work fine (2.59 is mentioned in the instructions)
+
+
+Building Firefox
+================
+
+Currently the Tor Browser Bundle uses FirefoxPortable binaries.
+Eventually it should use a custom build of Firefox. 
+
+Tested compilers
+----------------
+
+MinGW32 cross compile under Linux:
+ Failed to work (unsupported by Mozilla)
+MSVC 8 (Visual Studio .NET 2005):
+ Failed to work (unsupported by Mozilla for Firefox 2, but should work
+ for Firefox >=3)
+ With some patches it may be possible to build Firefox 2:
+  http://georgedexter.wordpress.com/2007/03/03/building-firefox-2002-on-windows/
+MSVC 7.1 (Visual Studio .NET 2003):
+ Works, provided  msvcp71.dll and msvcr71.dll are copied
+
+For more information see:
+ http://developer.mozilla.org/en/docs/Windows_Build_Prerequisites
+ http://developer.mozilla.org/en/docs/Build_and_Install
+
+Instructions for MSVC 7.1
+-------------------------
+
+- Install MSVC 7.1 (Visual Studio .NET 2003) and upgrade using Microsoft Update
+
+- Download Platform SDK from
+  http://www.microsoft.com/downloads/details.aspx?familyid=0baf2b35-c656-4969-ace8-e4c0c0716adb
+
+- Install MozillaBuild from
+  http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/MozillaBuildSetup-1.1.exe
+
+- Run e:\mozilla-build\start-msvc8.bat
+
+  $ cd "e:\mozilla\build"
+  $ tar -xjvf ../firefox-2.0.0.9-source.tar.bz2
+  $ cd mozilla
+  [ dot_mozconfg is in config/ ]
+  $ cp ../dot_mozconfig .mozconfig
+  $ make -f client.mk build
+
+- Copy msvcp71.dll and msvcr71.dll from "Microsot Visual Studio .NET 2003\Visual
+  Studio .NET Professional 2003 - English" to obj-i686-pc-mingw32\dist\bin
+
+- Add "msvcp71.dll" and "msvcr71.dll" to browser/installer/windows/packages-static
+
+$ make -C obj-i686-pc-mingw32/browser/installer
+


Property changes on: torbrowser/trunk/build-scripts/INSTALL
___________________________________________________________________
Name: svn:keywords
   + id
Name: svn:eol-style
   + native

Deleted: torbrowser/trunk/build-scripts/README
===================================================================
--- torbrowser/trunk/build-scripts/README	2007-12-25 14:16:41 UTC (rev 12974)
+++ torbrowser/trunk/build-scripts/README	2007-12-25 14:55:11 UTC (rev 12975)
@@ -1,39 +0,0 @@
-Building Tor Browser.exe
-========================
-
-To build Tor Browser.exe, you need to have built:
- Vidalia and Tor (in /c/build/vidalia and /c/build/tor-<version> by default)
- FirefoxPortable (in ./FirefoxPortable/ by default)
-
-Vidalia needs to have the BrowserExecutable option enabled (currently in
-trunk).
-
-FirefoxPortable can be downloaded from:
- http://portableapps.com/apps/internet/firefox_portable
-
-7zip can be downloaded from:
- http://www.7-zip.org/download.html
-
-Customization
--------------
-
-The locations of Qt, MinGW32, the Vidalia/Tor build directory, 7zip,
-FirefoxPortable can be altered in Makefile.
-
-Building the bundle
--------------------
-
-Firefox must not be running while you are building the bundle
-
-Run "make bundle"
-
-To specify a different language configuration, set $LANGCODE,
-e.g. "LANGCODE=fa make bundle" or "LANGCODE=zh-cn make bundle"
-
-To compress it, run "make compress-bundle"
-
-Archived code
--------------
-
-The patch to Vidalia can be found in archive/. This has now been
-applied to the Vidalia trunk, so is no longer needed.

Deleted: torbrowser/trunk/docs/build-instructions.txt
===================================================================
--- torbrowser/trunk/docs/build-instructions.txt	2007-12-25 14:16:41 UTC (rev 12974)
+++ torbrowser/trunk/docs/build-instructions.txt	2007-12-25 14:55:11 UTC (rev 12975)
@@ -1,94 +0,0 @@
-MSYS configuration for QT
--------------------------
-
-Add the following to /etc/profile:
- export QTDIR="C:\Qt\4.3.2"
- export PATH=$PATH:/c/Qt/4.3.2/bin
- export QMAKESPEC=win32-g++
-
-This will allow the MSYS bash command line interface to be used,
-rather than the Qt provided cmd.exe environment.
-
-Building Vidalia
-----------------
-
-[from http://trac.vidalia-project.net/wiki/InstallSource]
-
-$ lrelease Vidalia.pro
-$ qmake
-$ mingw32-make 
-
-Cmake:
-- If using the MSYS shell, invoke 'cmake -G "MSYS Makefiles"'
-  Attempting -G "MinGW Makefiles" will fail because sh.exe is in the
-  %PATH%
-- If using Mingw32, invoke 'cmake -G "MinGW Makefiles"'
-  Qt and CMake must be in the %PATH%. An easy way to do this is to copy
-  qtvars.bat and add the path to CMake. Then, copy the shortcut from
-  the Start menu, and edit the path to point to the altered qtvars.bat 
-
-Altering FirefoxPortable
-------------------------
-
-The .ini file needs to have "WaitForFirefox=true" set, since otherwise
-the launcher will exit immediately after starting Firefox. Currently
-we rely on detecting Firefox closing for when to shut down Tor.
-
-Building Firefox
-----------------
-
-I am currently using MSVC 7.1 (Visual Studio .NET 2003) to build Firefox. Visual
-Studio 2005 (and 2008) cannot build Firefox 2. This should be fixed with the
-eventual release of Firefox 3. MinGW32 is reported to work, but is not supported
-and has limitations. I was not able to get cross compiling working. There is
-discussion of building Firefox 2 with MSVC 8 at:
- http://georgedexter.wordpress.com/2007/03/03/building-firefox-2002-on-windows/
-
-For more information see:
- http://developer.mozilla.org/en/docs/Windows_Build_Prerequisites
- http://developer.mozilla.org/en/docs/Build_and_Install
-
-Instructions:
-
-- Install MSVC 7 (Visual Studio .NET 2003) and upgrade using Microsoft Update
-
-- Download Platform SDK from
-  http://www.microsoft.com/downloads/details.aspx?familyid=0baf2b35-c656-4969-ace8-e4c0c0716adb
-
-- Install MozillaBuild from
-  http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/MozillaBuildSetup-1.1.exe
-
-- Run e:\mozilla-build\start-msvc8.bat
-
-$ cd "e:\mozilla\build"
-$ tar -xjvf ../firefox-2.0.0.9-source.tar.bz2
-$ cd mozilla
-  [ dot_mozconfg is in docs/ ]
-$ cp ../dot_mozconfig .mozconfig
-$ make -f client.mk build
-
-- Copy msvcp71.dll and msvcr71.dll from "Microsot Visual Studio .NET 2003\Visual
-  Studio .NET Professional 2003 - English" to obj-i686-pc-mingw32\dist\bin
-
-- Add "msvcp71.dll" and "msvcr71.dll" to browser/installer/windows/packages-static
-
-$ make -C obj-i686-pc-mingw32/browser/installer
-
-
-OpenSSL, zlib, libevent and Tor
--------------------------------
-
-Instructions in:
- https://tor-svn.freehaven.net/svn/tor/trunk/doc/tor-win32-mingw-creation.txt
-
-Uncompressing OpenSSL shows a number of errors concerning symlinks.
-These do not appear to have caused a problem.
-
-For zlib, I used the first option (zlib.a)
-
-For libevent, I used 1.3e, as suggested by the document above.
-libevent 1.4.0 is newer but untested.
-
-It is tor-resolve, not tor_resolve.exe
-
-Autoconf 2.56 appears to work fine (2.59 is mentioned in the instructions)

Added: torbrowser/trunk/docs/rationale.txt
===================================================================
--- torbrowser/trunk/docs/rationale.txt	                        (rev 0)
+++ torbrowser/trunk/docs/rationale.txt	2007-12-25 14:55:11 UTC (rev 12975)
@@ -0,0 +1,15 @@
+###
+### Rationale for Tor Browser Bundle configuration choices
+###
+### Copyright 2007 Steven J. Murdoch <http://www.cl.cam.ac.uk/users/sjm217/>
+### See LICENSE for licensing information
+###
+### $Id$
+###
+
+Altering FirefoxPortable
+------------------------
+
+The .ini file needs to have "WaitForFirefox=true" set, since otherwise
+the launcher will exit immediately after starting Firefox. Currently
+we rely on detecting Firefox closing for when to shut down Tor.


Property changes on: torbrowser/trunk/docs/rationale.txt
___________________________________________________________________
Name: svn:keywords
   + Id
Name: svn:eol-style
   + native
Prev by Author: [or-cvs] r12974: Add license to patch-language, fix SVN properties (torbrowser/trunk/build-scripts)
Next by Author: [or-cvs] r12976: Last [top priority] TODO item done. Yay! (in torbrowser/trunk: . docs)
Previous by thread: [or-cvs] r12974: Add license to patch-language, fix SVN properties (torbrowser/trunk/build-scripts)
Next by thread: [or-cvs] r12976: Last [top priority] TODO item done. Yay! (in torbrowser/trunk: . docs)
Index(es):
- Author
- Thread