New Build Documentation - Revision history

FosterBrereton: added blurb about bjam v1 vs. bjam v2

2007-03-01T18:50:18Z

added blurb about bjam v1 vs. bjam v2

JacobFoshee: /* Issues Surrounding MSVC 8.0's "Safe" Libraries */

2007-02-23T17:33:12Z

‎Issues Surrounding MSVC 8.0's "Safe" Libraries

FosterBrereton at 18:55, 9 January 2007

2007-01-09T18:55:21Z

FosterBrereton at 18:10, 9 January 2007

2007-01-09T18:10:24Z

FosterBrereton at 18:06, 9 January 2007

2007-01-09T18:06:15Z

Show changes

FosterBrereton at 17:11, 9 January 2007

2007-01-09T17:11:42Z

FosterBrereton at 17:02, 9 January 2007

2007-01-09T17:02:59Z

FosterBrereton at 00:23, 9 January 2007

2007-01-09T00:23:45Z

FosterBrereton at 00:22, 9 January 2007

2007-01-09T00:22:50Z

FosterBrereton at 00:21, 9 January 2007

2007-01-09T00:21:01Z

@@ Line 1: / Line 1: @@
-''This documentation is written with the ASL 1.0.23 distribution in mind.''
+''This documentation last updated during the ASL 1.0.25 distribution.''
 = Building ASL : Requirements =
@@ Line 82: / Line 82: @@
 == Build Option 1: Using Boost Build (bjam) ==
 === Building Under Win32 ===

@@ Line 337: / Line 337: @@
    ADOBE_TEST_MICROSOFT_NO_DEPRECATE=0
-The Jamfile as the top of the ASL distribution has this macro defined by
+The Jamfile at the top of the ASL distribution has this macro defined by
 default. Another option to disable the warnings in your code is by
 supressing the warnings with a pragma:

@@ Line 45: / Line 45: @@
 Decompress the Boost distribution and move the resulting directory to:
-   ~/adobe-source/third_party/boost_tp/
+   ~/adobe-source/third_party/boost_tp/ (*nix)
 The folder should be named boost resulting in the structure:
-   ~/adobe-source/third_party/boost_tp/boost/
+   ~/adobe-source/third_party/boost_tp/boost/ (*nix)
 Boost must be patched with a small number of minor changes. A patchfile
 with those changes can be found at:
-   ~/adobe-source/third_party/boost_tp/adobe/boost_1_33_1_patch_01.txt
+   ~/adobe-source/third_party/boost_tp/adobe/boost_1_33_1_patch_01.txt (*nix)
 === Patching under *nix ===
@@ Line 69: / Line 72: @@
 Win32 users can use the patchfile provided, but there are some caveats. First, the patchfile is distributed with Unix line endings, which must first be converted to DOS line endings. If you do not have a program to accomplish this, there is a small command line tool called <code>leconv</code> that will do this for you. It is in:
-   ~/adobe-source/adobe/tools/
+   C:\adobe-source\adobe\tools\
 The GNUWin32 project has made a version of patch for Win32. It

← Older revision		Revision as of 18:10, 9 January 2007
Line 299:		Line 299:
	In XCode, this is managed with the top-level xcconfig file for the		In XCode, this is managed with the top-level xcconfig file for the
	binary artifact.		binary artifact.
		+
		+	= Known Issues =
		+
		+	== General Issues ==
		+
		+	We are aware the release is generally quite cumbersome, and are still
		+	figuring out how to package releases more efficiently.
		+
		+	BBv2 intentionally builds the debug variant of ASL with "warnings as
		+	errors" turned on. The release variant is not built with this setting on
		+	because of warnings within some library headers in the GCC STL.
		+
		+	== Issues Surrounding MSVC 8.0's "Safe" Libraries ==
		+
		+	ASL does not support the non-standard "Safe" C and C++ libraries
		+	shipping with Visual C++ 8.0. This may result in many spurious warnings
		+	from ASL, Boost, and other standards-conforming C and C++ libraries. To
		+	suppress these warnings, define the macros
		+
		+	_CRT_SECURE_NO_DEPRECATE
		+
		+	and
		+
		+	_SCL_SECURE_NO_DEPRECATE
		+
		+	The MSVC command-line settings to define these macros is:
		+
		+	\D_CRT_SECURE_NO_DEPRECATE \D_SCL_SECURE_NO_DEPRECATE
		+
		+	The ASL header file <code>adobe/config.hpp</code> includes checks when compiling
		+	with MSVC 8.0 to make sure these macros are defined. To disable this
		+	check, define the following macro before including <code>adobe/config.hpp</code>:
		+
		+	ADOBE_TEST_MICROSOFT_NO_DEPRECATE=0
		+
		+	The Jamfile as the top of the ASL distribution has this macro defined by
		+	default. Another option to disable the warnings in your code is by
		+	supressing the warnings with a pragma:
		+
		+	#pragma warning ( disable : 4996 )
		+
		+	== Executing Adobe Begin on Windows XP on a Non-Development Machine ==
		+
		+	When an app is built using a version of MSVC, that version of
		+	Microsoft's Runtimes Libraries must be 'findable' by the OS in order to
		+	launch the application. Part of Microsoft's solution to this problem
		+	includes the embedding of an application manifest file into the
		+	application. On development machines, these files are automatically
		+	installed in C:\WINDOWS\system32\. The manifest file describes the
		+	binary's dependencies to external DLLs, and the OS reads the file and
		+	hunts down the dependencies to load them. In a clean-install XP system,
		+	the Runtime Libraries for MSVC 7.0, 7.1, and 8 do not exist, which will
		+	lead ultimately to the failure to launch applications built with these
		+	compilers on non-development machines.
		+
		+	Our current workaround to this problem is to not embed the manifest
		+	file in the binary directly, but leave it as a sibling to the app. Then
		+	the necessary runtime libraries must also be placed as siblings to the
		+	app, along with a manifest file describing them to the OS. For some
		+	reason both of these steps are required, and then the app will run in a
		+	clean XP installation. Note that this bug was not caught for a while
		+	because these runtime libraries were automatically found when smoke
		+	testing the apps. (A big thanks goes to Ken Silver for being the first
		+	one report Adobe Begin failing to load on his machine, which was not set
		+	up for development.)
		+
		+	= Feedback =
		+
		+	The Adobe Source Libraries have been used with success within Adobe
		+	applications to increase robustness and correctness of code. As
		+	developers of an open source project, we are confident that there are
		+	other success stories outside of Adobe as well. We encourage you to
		+	contribute a success story of your own:
		+
		+	* What is the name of your project?
		+	* What is the purpose of the project?
		+	* What led you to choose ASL?
		+	* Was ASL used from the start of the project? If not, how did its inclusion impact your project? How does using ASL affect your project development as a whole?
		+	* How large is your project?
		+	* How would you rate the success of your project?
		+	* Is there any other interesting information worth sharing?
		+
		+	Submissions will be included in a success stories web page on the
		+	opensource.adobe.com site. You can submit a success story by emailing
		+	Foster Brereton at his adobe.com email address (fbrereto).
		+
		+	Of course, feedback of any kind is highly requested at all times. Please contact one of the project leads.

← Older revision		Revision as of 17:11, 9 January 2007
Line 40:		Line 40:

	The Boost 1.33.1 distribution can be downloaded from http://sourceforge.net/project/showfiles.php?group_id=7586		The Boost 1.33.1 distribution can be downloaded from http://sourceforge.net/project/showfiles.php?group_id=7586
		+
		+	== Patching Boost ==
		+
		+	Decompress the Boost distribution and move the resulting directory to:
		+
		+	~/adobe-source/third_party/boost_tp/
		+
		+	The folder should be named boost resulting in the structure:
		+
		+	~/adobe-source/third_party/boost_tp/boost/
		+
		+	Boost must be patched with a small number of minor changes. A patchfile
		+	with those changes can be found at:
		+
		+	~/adobe-source/third_party/boost_tp/adobe/boost_1_33_1_patch_01.txt
		+
		+	=== Patching under *nix ===
		+
		+	You can use the Unix patch command to make the necessary changes, but
		+	first make sure all the line endings in the affected files are Unix line
		+	endings. To use the supplied patch under Unix issue the following
		+	command:
		+
		+	~/adobe-source/third_party/boost_tp/adobe/patch_boost.sh
		+
		+	=== Patching under Win32 ===
		+
		+	Win32 users can use the patchfile provided, but there are some caveats. First, the patchfile is distributed with Unix line endings, which must first be converted to DOS line endings. If you do not have a program to accomplish this, there is a small command line tool called <code>leconv</code> that will do this for you. It is in:
		+
		+	~/adobe-source/adobe/tools/
		+
		+	The GNUWin32 project has made a version of patch for Win32. It
		+	can be obtained at http://sourceforge.net/projects/gnuwin32
		+
		+	If you already use boost build, please make sure that the adobe
		+	version of bjam will be the one found in your path, since ASL relies
		+	on patched support files found relative to the bjam executable.

@@ Line 13: / Line 13: @@
 # A dose of patience
-= If you are Inside Adobe =
+= The Easy Way =
 Within Adobe the Software Technology Lab maintains Perforce servers for distributions of both Boost and the Adobe Source Libraries. This is the preferred method of downloading ASL within Adobe, as the Boost sources are already patched and placed correctly. Please see the STLab website for more information on getting ASL this way.
-The rest of this document is not for you.
+''The rest of this document is not for you.''
-= Building the Libraries Automatically =
+== Building the Libraries Automatically ==
 Two automated net install scripts have been written to ease in the downloading and building of the Adobe Source Libraries. Given a development environment, these scripts will do all the downloading, patching and building necessary to get a working build of ASL and Adobe Begin on your computer.
-The Windows version can be downloaded from:
+The Windows version can be downloaded from http://easynews.dl.sourceforge.net/sourceforge/adobe-source/asl_1.0.23_net_setup.bat
-    http://easynews.dl.sourceforge.net/sourceforge/adobe-source/asl_1.0.23_net_setup.bat
-The *NIX (including Mac OS X) version can be downloaded from:
+The *NIX (including Mac OS X) version can be downloaded from http://easynews.dl.sourceforge.net/sourceforge/adobe-source/asl_1.0.23_net_setup.sh
-    http://easynews.dl.sourceforge.net/sourceforge/adobe-source/asl_1.0.23_net_setup.sh
 You may only run these scripts from a directory having no spaces or unusual characters in the path. This is due to a bjam restriction that will cause some of the tests to fail during the build process.
-The rest of this document is not for you.
+Please also be aware that the script requires use of FTP and HTTP. If you are behind a firewall or cannot otherwise use FTP, the scripts will not work.
-= Building the Libraries Automatically =
+''The rest of this document is not for you.''
 == Obtaining and Patching Boost ==

@@ Line 4: / Line 4: @@
 In order to build ASL, the requirements are as follows:
-* A working IDE installation of:
+# A working IDE installation of:
-** GCC 3.4.4 or better (cygwin)
+## GCC 3.4.4 or better (cygwin)
-** GCC 4.0.1 or better (MacOS X)
+## GCC 4.0.1 or better (MacOS X)
-** MSVC 8.0 or better (Win32)
+## MSVC 8.0 or better (Win32)
-** MSVC 8 Express (additional instructions needed to get MSVC 8 Express ready to build ASL; Please see below.)
+## MSVC 8 Express (additional instructions needed to get MSVC 8 Express ready to build ASL; Please see below.)
-* A ''patched'' copy of Boost 1.33.1 distribution
+# A ''patched'' copy of Boost 1.33.1 distribution
-* A copy of the latest ASL distribution
+# A copy of the latest ASL distribution
-* A dose of patience
+# A dose of patience
 = If you are Inside Adobe =
@@ Line 24: / Line 24: @@
 The Windows version can be downloaded from:
-     http://easynews.dl.sourceforge.net/sourceforge/adobe-source/asl\_{VERSION}\_net_setup.bat
+     http://easynews.dl.sourceforge.net/sourceforge/adobe-source/asl_1.0.23_net_setup.bat
 The *NIX (including Mac OS X) version can be downloaded from:
-     http://easynews.dl.sourceforge.net/sourceforge/adobe-source/asl\_{VERSION}\_net_setup.sh
+     http://easynews.dl.sourceforge.net/sourceforge/adobe-source/asl_1.0.23_net_setup.sh
-−
-''Please note that {VERSION} in the download URL should be replaced with the version you see at the top of this file. (e.g., 1.0.23)''
 You may only run these scripts from a directory having no spaces or unusual characters in the path. This is due to a bjam restriction that will cause some of the tests to fail during the build process.

← Older revision		Revision as of 00:21, 9 January 2007
Line 1:		Line 1:
−	== ~~Obtaining~~ and Building ASL ==	+	= Building ASL : Requirements =
		+
		+	In order to build ASL, the requirements are as follows:
		+	* A working IDE installation of:
		+	** GCC 3.4.4 or better (cygwin)
		+	** GCC 4.0.1 or better (MacOS X)
		+	** MSVC 8.0 or better (Win32)
		+	** MSVC 8 Express (additional instructions needed to get MSVC 8 Express ready to build ASL; Please see below.)
		+	* A ''patched'' copy of Boost 1.33.1 distribution
		+	* A copy of the latest ASL distribution
		+	* A dose of patience
		+
		+	== i. If you are Inside Adobe ==
		+
		+	Within Adobe the Software Technology Lab maintains Perforce servers for distributions of both Boost and the Adobe Source Libraries. This is the preferred method of downloading ASL within Adobe, as the Boost sources are already patched and placed correctly. Please see the STLab website for more information on getting ASL this way.
		+
		+	The rest of this document is not for you.
		+
		+	== ii. Building the Libraries Automatically ==
		+
		+	Two automated net install scripts have been written to ease in the downloading and building of the Adobe Source Libraries. Given a development environment, these scripts will do all the downloading, patching and building necessary to get a working build of ASL and Adobe Begin on your computer.
		+
		+	The Windows version can be downloaded from:
		+	http://easynews.dl.sourceforge.net/sourceforge/adobe-source/asl\_{VERSION}\_net_setup.bat
		+
		+	The *NIX (including Mac OS X) version can be downloaded from:
		+	http://easynews.dl.sourceforge.net/sourceforge/adobe-source/asl\_{VERSION}\_net_setup.sh
		+
		+	''Please note that {VERSION} in the download URL should be replaced with the version you see at the top of this file. (e.g., 1.0.23)''
		+
		+	You may only run these scripts from a directory having no spaces or unusual characters in the path. This is due to a bjam restriction that will cause some of the tests to fail during the build process.
		+
		+	The rest of this document is not for you.
		+
		+	== 1. Obtaining and Patching Boost ==