Difference between revisions of "Viewer 2 Microsoft Windows Builds"

From Second Life Wiki
Jump to: navigation, search
Line 2: Line 2:
 
{{CompileNav}}
 
{{CompileNav}}
  
{{KBwarning|custom=Work in progress|'''These instructions are not yet complete or  debugged''' as of 18 April 2010.}}
+
{{KBwarning|custom=Work in progress|'''These instructions are not yet complete or  debugged''' as of March 22, 2011.}}
  
 
When finished, we hope this page will constitute a complete recipe for compiling viewer 2 from source on a Windows machine.   
 
When finished, we hope this page will constitute a complete recipe for compiling viewer 2 from source on a Windows machine.   
Line 12: Line 12:
 
== Establish your programming environment ==
 
== Establish your programming environment ==
 
This is needed for compiling any viewer based on the LL open source code, but only needs to be done once.
 
This is needed for compiling any viewer based on the LL open source code, but only needs to be done once.
 +
#Obtain Visual Studio 2010 (Express is OK)
 +
#:[http://www.microsoft.com/express/download/ Click here to download Visual C++ Express - current version is VS2010]
 +
#Install Microsoft Platform & DirectX SDKs
 +
#:Download and install [http://www.microsoft.com/downloads/en/details.aspx?FamilyID=35aeda01-421d-4ba5-b44b-543dc8c33a20 Windows SDK for Windows 7 and .NET Framework 4 (ISO)] or [http://www.microsoft.com/downloads/en/details.aspx?FamilyID=6B6C21D2-2006-4AFA-9702-529FA782D63B Windows SDK for Windows 7 and .NET Framework 4 (Web Install)] and
 +
#:[http://www.microsoft.com/downloads/en/details.aspx?displaylang=en&FamilyID=3021d52b-514e-41d3-ad02-438a3ba730ba Download and install DirectX SDK (June 2010)]
 +
#Run Microsoft update and keep running it until no updates are needed. This may take 6~8 iterations on older versions of windows.
 +
#Install other development tools
 +
#*[http://code.google.com/p/unsis/downloads/list UniCode NSIS(download Unicode NSIS)]
 +
#*:This is the package installer used to build Setup.exe.  Note: As of this writing the file is downloaded with an *.exec extension that needs renamed *.exe.
 +
#*CMake ([http://www.cmake.org/files/v2.8/ download CMake])
 +
#*:should be version 2.8.1  Kitware corrected a bug related to VS2010 at 2.8.1 and it came back in the current versions but, is due to be fixed in version 2.8.4. (and ensure any other versions aren't in your PATH environment variables)
 +
#*Cygwin ([http://www.cygwin.com/ download Cygwin])
 +
#*:When you run the cygwin setup utility make sure you have selected to install patchutils, flex, and bison (all located under "devel") which are not part of the default install. Do not install Cygwin Python.
 +
#*Python ([http://www.python.org/download/ download either Python.org Standard Python] or [http://www.activestate.com/activepython/downloads ActivePython]) Note: build scripts support Python 2.6, not 2.7 yet.
 +
#*TortoiseHg ([http://tortoisehg.bitbucket.org/ download TortoiseHg]) or ([http://mercurial.selenic.com/release/windows/Mercurial-1.7.5.exe Mercurial Hg])
 +
#*:You need to use an editor that conforms to the [[Coding Standard]]. In particular, you must not check in files with DOS line endings except in very limited circumstances; see [[How to avoid DOS line endings in Windows tools]].
 +
#*Notepad++ ([http://notepadplusplus.org/ download Notepad++]) (Optional)
  
* Obtain Visual Studio (2005, 2008, 2010) (Express is OK)
 
** [http://www.microsoft.com/express/download/ Click here to download Visual C++ Express - current version is VS2010]
 
** Note: LL still uses VS2005 internally, which uses the VC80 libraries.  Until LL upgrades their internal build systems to use VS2010 you will have the least amount of trouble if you search out a copy of VS2005 (This needs to be upgraded to VS2005 SP1, or compiler errors result, also if you have Vista or above, the Vista compatibility pack is required for proper compilation. To download VS2005, SP1, and the compatability pack, Go here [http://msdn.microsoft.com/hi-in/express/aa975050 Microsoft Visual Studio 2005 Express]).  VS2008 uses the VC90 libraries. VS2010 TBD (test with the VC90 libraries new ones for VC100 may need to be made).
 
* Install Microsoft Platform & DirectX SDKs
 
** Download and install [http://www.microsoft.com/downloads/details.aspx?FamilyID=F26B1AA4-741A-433A-9BE5-FA919850BDBF&displaylang=en Windows SDK for Windows Server 2008 and .NET Framework 3.5] and [http://www.microsoft.com/downloads/en/details.aspx?FamilyID=c17ba869-9671-4330-a63e-1fd44e0e2505&displaylang=en Microsoft Windows SDK for Windows 7 and .NET Framework 3.5 SP1]
 
** Download and install [http://www.microsoft.com/downloads/en/details.aspx?displaylang=en&FamilyID=3021d52b-514e-41d3-ad02-438a3ba730ba DirectX SDK (June 2010)]
 
 
* Install other development tools
 
** '''UniCode NSIS'''([http://code.google.com/p/unsis/downloads/list download Unicode NSIS])
 
***  This is the package installer used to build Setup.exe.
 
** '''CMake''' ([http://www.cmake.org/HTML/Download.html download CMake])
 
*** must be version 2.6.2 or higher (and ensure any older versions aren't in your PATH environment variables)
 
** '''Cygwin''' ([http://www.cygwin.com/ download Cygwin])
 
*** When you run the cygwin setup utility make sure you have selected to install '''patchutils''', '''flex''', and '''bison''' (all located under "devel") which are not part of the default install.
 
** '''Python''' (download either [http://www.python.org/download/ Python.org Standard Python] or  [http://www.activestate.com/activepython/downloads ActivePython]) Note: build scripts support Python 2.6, not 2.7 yet.
 
** '''TortoiseHg''' ([http://tortoisehg.bitbucket.org/ download TortoiseHg])
 
 
* You need to use an editor that conforms to the [[Coding Standard]].  In particular, you must not check in files with DOS line endings except in very limited circumstances; see [[How to avoid DOS line endings in Windows tools]].
 
** '''Notepad++''' ([http://notepadplusplus.org/ download Notepad++]) (Optional)
 
 
{{KBnote|If the installer for a particular package does not update your PATH environment setting you will have to do this manually.}}
 
{{KBnote|If the installer for a particular package does not update your PATH environment setting you will have to do this manually.}}
  
== Download and compile libraries that must be manually added to each LL source release ==
+
Additionally it is recommended that you make the following changes to your Cygwin installation:
 
+
*Override cygwin's python:
It is probably a good idea to build an empty directory tree for the files below and first copy the files there and once completed, copy the whole tree to the actual source folder. Then, if you obtain a new batch of source code, you can save some steps.
+
  if [ -f /usr/bin/python.exe ]; then
 
+
    mv /usr/bin/python.exe /usr/bin/cygwin-python.exe
rem OLIBS.CMD to build a folder tree for 3rd party libraries and includes
+
  fi
  md olibs\linden\libraries\i686-win32\lib\release
+
  cp /cygdrive/c/Python26/python.exe /usr/bin/python.exe
  md olibs\linden\libraries\i686-win32\lib\debug
+
*Override cygwin's mercurial:
  md olibs\linden\libraries\i686-win32\include\GL
+
  if [ -f /usr/bin/hg.exe ]; then
  md olibs\linden\libraries\i686-win32\include\quicktime
+
    mv /usr/bin/hg.exe /usr/bin/cygwin-hg.exe
  md olibs\linden\indra\newview
+
  fi
 
+
  cp /cygdrive/c/Program\ Files/Mercurial/hg.exe /usr/bin/hg.exe
 
+
The native Cygwin python and hg do not work very well and should be avoided.
VCS folder tree - for simplicity of copying files to your build folder
+
  trunk\indra\newview
+
  trunk\libraries\i686-win32\include\GL
+
  trunk\libraries\i686-win32\include\quicktime
+
  trunk\libraries\i686-win32\lib\debug
+
  trunk\libraries\i686-win32\lib\release
+
           
+
 
+
=== Quicktime ===
+
 
+
* Download & install the [http://developer.apple.com/quicktime/download/ Quicktime SDK for Windows] (login may be necessary).
+
* copy <code>QuicktimeSDK\Libraries\QTMLClient.lib</code> to <code>olibs\linden\libraries\i686-win32\lib\release</code> and to <code>olibs\linden\libraries\i686-win32\lib\debug</code>
+
* Copy the contents of <code>QuicktimeSDK\CIncludes</code> into <code>olibs\linden\libraries\i686-win32\include\quicktime</code>.
+
 
+
=== Fmod ===
+
* Download & extract [http://www.fmod.org/files/fmod3/fmodapi375win.zip FMOD3.75 API for Windows]. (later versions, like FMOD Ex, are incompatible).
+
* Copy <code>fmodapi375win\api\inc\fmod.h</code> to <code>olibs\linden\libraries\include</code>
+
* Copy <code>fmodapi375win\api\inc\fmod_errors.h</code> to <code>olibs\linden\libraries\include</code>
+
* Copy <code>fmodapi375win\api\inc\fmoddyn.h</code> to <code>olibs\linden\libraries\include</code>
+
* Copy <code>fmodapi375win\api\lib\fmodvc.lib</code> to <code>olibs\linden\libraries\i686-win32\lib\release</code> and to <code>olibs\linden\libraries\i686-win32\lib\debug</code>
+
* Copy <code>fmodapi375win\api\fmod.dll</code> to <code>olibs\linden\indra\newview</code>, <code>olibs\linden\libraries\i686-win32\lib\release</code> and to <code>olibs\linden\libraries\i686-win32\lib\debug</code>
+
 
+
Note to Snowstorm users: if you are building using the Mercurial repository [https://bitbucket.org/lindenlab/viewer-development lindenlab/viewer-development], these steps have been simplified and cleaned up. In particular, there's no need to drop anything under linden\indra anymore, all the files are under linden\libraries like for other 3rd party libraries. The fmodvc.lib however needs to be renamed fmod.lib. The new instructions are:
+
* Download & extract [http://www.fmod.org/files/fmod3/fmodapi375win.zip FMOD3.75 API for Windows]
+
* From <code>fmodapi375win\api\inc\</code>, copy <code>fmod.h</code> and <code>fmod_errors.h</code> to <code>linden\libraries\include</code>
+
* From <code>fmodapi375win\api\lib</code>, choose the relevant .lib that correspond to your environment (e.g. <code>fmodvc.lib</code> for Visual Studio), rename it <code>fmod.lib</code> and copy it to <code>linden\libraries\i686-win32\lib\release</code> and <code>linden\libraries\i686-win32\lib\debug</code>
+
* From <code>fmodapi375win\api</code> copy <code>fmod.dll</code> to <code>linden\libraries\i686-win32\lib\release</code> and <code>linden\libraries\i686-win32\lib\debug</code>
+
 
+
=== Boost ===
+
 
+
Only needed if not using VS2005.
+
 
+
* Grab the files that Robin Cornelius has precompiled at
+
http://www.byteme.org.uk/downloads/boost_1_39_VC90_no_scl_shared_crt_static_link.zip
+
* If you get the zip file from Robin Cornelius copy the libraries folder into the the tree you made above for  fmod and QuickTime files that way you have a ready back up of those files for if you update your build directory from the SVN server.
+
* or alternatively follow the instructions from the 25/Feb/10 and 15/Apr/10 entries of http://jira.secondlife.com/browse/VWR-9541
+
 
+
((TBD: verify, simplify, fix))
+
 
+
=== cares ===
+
TBD
+
  
 
== Set up your source code tree ==
 
== Set up your source code tree ==
Line 109: Line 66:
 
* Copy your <code>olibs</code> from above into this new source tree.
 
* Copy your <code>olibs</code> from above into this new source tree.
  
== Fix known problems with the source code tree ==
+
== Build the viewer with autobuild ==
 +
=== Install autobuild ===
 +
If you haven't done so already, install ''autoubuild''.  Full instructions can be found on the [[Autobuild]] page, but most users may simply use
 +
  [http://pypi.python.org/pypi/setuptools easy_install] autobuild
 +
or
 +
[http://pypi.python.org/pypi/pip pip] install autobuild
 +
to install.
  
TBD - edits to scripts that must be made for windows VC90 builds to succeed?
+
=== Build a desired configuration ===
 +
With a properly configured developer machine (see [[Get_source_and_compile#Compiling| compiling]]), building the viewer with ''autobuild'' is as simple as invoking
 +
  autobuild build -c [CONFIGURATION]
 +
where '''CONFIGURATION''' stands for the build configuration you would like to build.  The build configurations defined in the viewer's ''autobuild.xml'' file follow some simple conventions which we describe below.  As a developer you should choose the appropriate build configuration for your needs.  After a build has completed, the resulting product will be found in the build directory named ''build-*'' where the ''*'' is wildcard representing the platform dependent part of the name.
  
Known Problems:
+
Developers who wish to build a viewer with an IDE don't have to do a full command line build.  Using
* /indra/cmake/Boost.cmake file has to be edited as shown in [http://jira.secondlife.com/browse/VWR-9541?focusedCommentId=168967&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#action_168967 VWR-9541] in order to use the boost files in VS2008.
+
  autobuild configure -c [CONFIGURATION]
 +
Will install any dependencies (if the build configuration uses them) and construct an appropriate project or solution file (''.xcodeproj'' for mac and ''.sln'' for windows) inside the build directory.
 +
 +
==== Base build configurations ====
 +
There are three basic types of build configurations which are used to vary the debugability of the resulting build versus optimization. These configurations are:
 +
* '''Debug''' &mdash; unoptomized with debugging information.
 +
* '''RelWithDebInfo''' &mdash; optomized but with debugging information.
 +
* '''Release''' &mdash; optimized with no debug information.
 +
'''Debug''' will result in a slow client but is the easiest to use with a debugger.  '''RelWithDebInfo''' is significantly faster and is often easy to debug, but code optimizations may occasionally make tracking program flow in a debugger challenging.  '''Release''' is used for building a shipping version of the viewer.
  
== Initial build steps using develop.py and CMake ==
+
==== Build variations for open source developers ====
 
+
The unmodified build configuraitons defined in the previous section are configured for use by Linden developers and may require access to installables which are not publicly availableFor open source developers two variations are provided to support development by third parties using the following prefixes:
You may notice that there's no Visual Studio project file as part of the distributed source treeThat's because it is GENERATED in this step using command-line tools.  Only after this step can you begin using the IDE.
+
* '''OpenSource''' &mdash; build a viewer using only publicly distributed installables.
 
+
* '''OpenSourceStandAlone''' &mdash; build a viewer without using any installable packages provided by Linden.
* open a Command Prompt window
+
*: Developers will need to install any 3<sup>rd</sup> party dependencies manually.
 
+
To build an open source configuration choose a build configuration which is a concatonation of one of the two above prefixes with a base configuraiton nameFor example to build a stand alone viewer with release optimization including debug information run
* Run develop.py --
+
  autobuild build -c OpenSourceStandAloneRelWithDebInfo
** From the command line, '''cd into the indra subdirectory'''  
+
** Run <code>develop.py -G VC90</code> or <code>python develop.py -G VC90</code> NOTE: use <code> -G VC80 </code> if you are using VS2005
+
NOTE: Visual Studio 2010 support is not included by default. Reference [https://jira.secondlife.com/browse/VWR-24594 VWR-24594] for more details and fixes.
+
 
+
NOTE: Some resources may be downloaded automatically at this point if they do not yet exist.
+
 
+
** The <code>develop.py</code> script will create and populate a build directory for youIt should be in <code>'build-vc90'</code> or <code>'build-vc80'</code> if using VS2005
+
 
+
When it completes you will get your command prompt back and it should say something like:
+
 
+
  Trying to set active config to "RelWithDebInfo"
+
  Success!
+
Trying to set "secondlife-bin" to the startup project
+
  Success!
+
got ret 0 from tools\vstool\VSTool.exe --solution build-VC80\SecondLife.sln --config RelWithDebInfo --startup secondlife-bin
+
  
 
== Compile using the IDE ==
 
== Compile using the IDE ==
 
* Run Visual Studio.
 
* Configure Visual Studio.
 
**Use Tools>Options to get the Options window open.
 
**Goto Projects and Solutions>VC++ Directories and set the following:
 
Executable Files:
 
$(SystemRoot)
 
$(SystemRoot)\System32
 
$(SystemRoot)\System32\wbem
 
$(VCInstallDir)bin
 
$(VCInstallDir)PlatformSDK\bin
 
$(VCInstallDir)PlatformSDK\common\bin
 
$(VSInstallDir)Common7\Tools\bin
 
$(VSInstallDir)Common7\tools
 
$(VSInstallDir)Common7\ide
 
$(ProgramFiles)\HTML Help Workshop
 
$(FrameworkSDKDir)bin
 
$(FrameworkDir)$(FrameworkVersion)
 
$(VSInstallDir)
 
C:\Program Files\Microsoft SDKs\Windows\v7.0\Bin
 
C:\Program Files\Microsoft SDKs\Windows\v6.1\Bin
 
C:\Python26
 
C:\Program Files\NSIS
 
$(SystemRoot)\SysWow64  (needed in 64-bit windows versions, exclude for 32-bit)
 
$(FxCopDir)
 
$(PATH)
 
C:\cygwin\bin
 
 
Included Files:
 
$(VCInstallDir)include
 
$(VCInstallDir)atlmfc\include
 
$(VCInstallDir)PlatformSDK\include
 
$(VCInstallDir)PlatformSDK\common\include
 
$(FrameworkSDKDir)include
 
C:\Program Files\Microsoft SDKs\Windows\v7.0\Include
 
C:\Program Files\Microsoft SDKs\Windows\v7.0\Include\gl
 
C:\Program Files\Microsoft SDKs\Windows\v7.0\Samples\winui\TSF\tsfapp
 
C:\Program Files\Microsoft SDKs\Windows\v6.1\Include
 
C:\Program Files\Microsoft SDKs\Windows\v6.1\Include\gl
 
C:\Program Files\Microsoft SDKs\Windows\v6.1\Samples\winui\TSF\tsfapp
 
C:\Program Files\Microsoft DirectX SDK (June 2010)\Include
 
 
Library Files:
 
$(VCInstallDir)lib
 
$(VCInstallDir)atlmfc\lib
 
$(VCInstallDir)atlmfc\lib\i386
 
$(VCInstallDir)PlatformSDK\lib
 
$(VCInstallDir)PlatformSDK\common\lib
 
$(FrameworkSDKDir)lib
 
$(VSInstallDir)
 
$(VSInstallDir)lib
 
C:\Program Files\Microsoft SDKs\Windows\v7.0\Lib
 
C:\Program Files\Microsoft SDKs\Windows\v6.1\Lib
 
C:\Program Files\Microsoft DirectX SDK (June 2010)\Lib\x86
 
 
* Use '''File''' > '''Open''' > '''Project/Solution''', navigate to <code>linden/indra/build-VC90/Viewer.vcproj</code>, and open it.
 
** if you can't find this file, perhaps your previous run of <code>develop.py</code> failed.
 
* In the MSVS toolbar, just to the right of the triangular '''Start Debugging''' arrow, is a text box whose tooltip is "Solution Configurations". Select <code>RelWithDebugInfo</code>.
 
* If <code>ALL_BUILD</code> is not set as your StartUp Project (the StartUp Project is displayed in bold font), right-click on <code>ALL_BUILD</code> and choose '''Set as StartUp Project'''.
 
* Right-click on <code>ALL_BUILD</code> and choose '''Properties'''. In '''Configuration Properties''' > '''Debugging''', find <code>Working Directory</code> and navigate to <code>linden\indra\newview</code>.
 
* '''Build''' > '''Build Solution (F7)'''
 
  
 
== Iteratively fix things until the compile succeeds ==
 
== Iteratively fix things until the compile succeeds ==
Line 213: Line 111:
 
** Subscribe to [[OpenSource-Dev|OpenSource-Dev Mailing List]] ([https://lists.secondlife.com/cgi-bin/mailman/listinfo/opensource-dev subscribe]) and post your question there.
 
** Subscribe to [[OpenSource-Dev|OpenSource-Dev Mailing List]] ([https://lists.secondlife.com/cgi-bin/mailman/listinfo/opensource-dev subscribe]) and post your question there.
 
** For faster response, find a free IRC client program and join [irc://irc.freenode.org/opensl #opensl on freenode], the general open source viewer discussion and development channel.  Hopefully a helpful person is online when you ask your question.
 
** For faster response, find a free IRC client program and join [irc://irc.freenode.org/opensl #opensl on freenode], the general open source viewer discussion and development channel.  Hopefully a helpful person is online when you ask your question.
 
*Applies to Visual C++ 2005 Express:
 
 
The build scripts seem to be a state of flux on how to properly
 
handle picking up 3 Microsoft support files:
 
* <code>Microsoft.VC80.CRT.manifest</code>
 
* <code>msvcp80.dll</code>
 
* <code>msvcr80.dll</code>
 
 
If you get errors about these files you will need to manually place them in
 
* <code>../build-VC80/newview/release</code> (and/or <code>/debug</code> or <code>/relwithdebinfo</code>) and
 
* <code>../build-VC80/sharedlib/release</code>
 
 
{{KBnote|These directories will not exist until your compile session has run for a little while.}}
 
 
The source of these files should be in a folder named <code>vcredist_vc80_4053_x86</code>. If you cannot find these on your hard drive follow the instructions at [[User:Robin_Cornelius/viewer-development_VC2005_Express]] to get them.
 
 
---------------------
 
 
If you run into an issue when running <code>develop.py</code> similar to this:
 
 
1>Linking...
 
1>link: extra operand `/ERRORREPORT:QUEUE'
 
1>Try `link --help' for more information.
 
1>Project : error PRJ0002 : Error result 1 returned from 'C:\cygwin\bin\link.exe'.
 
 
You may have not configured Visual Studio properly. The articles in this wiki in regards to the setup of executable paths do not specify an order or priority, but you must make sure that the CYGWIN executable path is set lower in the list than the VC++ paths, otherwise <code>develop.py</code> winds up executing the CygWin <code>Link.exe</code> which won't work
 
 
This issue has also been seen when using the Windows Command Prompt instead of the command prompt within VC++ (Visual Studio 2010?).
 
  
 
== References ==
 
== References ==

Revision as of 09:46, 28 March 2011

KBwarning.png Work in progress These instructions are not yet complete or debugged as of March 22, 2011.

When finished, we hope this page will constitute a complete recipe for compiling viewer 2 from source on a Windows machine.

Philosophy: to keep it brief, this page should only include steps we KNOW ARE NEEDED, not random hints. Extra details or open issues can go on the talk page.

KBnote.png Note: Following this recipe will probably take 6 to 12 hours of wall-clock time, and 2 to 6 hours of your time, if you're starting from a fresh Windows XP/Vista/7 system.

Establish your programming environment

This is needed for compiling any viewer based on the LL open source code, but only needs to be done once.

  1. Obtain Visual Studio 2010 (Express is OK)
    Click here to download Visual C++ Express - current version is VS2010
  2. Install Microsoft Platform & DirectX SDKs
    Download and install Windows SDK for Windows 7 and .NET Framework 4 (ISO) or Windows SDK for Windows 7 and .NET Framework 4 (Web Install) and
    Download and install DirectX SDK (June 2010)
  3. Run Microsoft update and keep running it until no updates are needed. This may take 6~8 iterations on older versions of windows.
  4. Install other development tools
KBnote.png Note: If the installer for a particular package does not update your PATH environment setting you will have to do this manually.

Additionally it is recommended that you make the following changes to your Cygwin installation:

  • Override cygwin's python:
 if [ -f /usr/bin/python.exe ]; then
   mv /usr/bin/python.exe /usr/bin/cygwin-python.exe
 fi
 cp /cygdrive/c/Python26/python.exe /usr/bin/python.exe
  • Override cygwin's mercurial:
 if [ -f /usr/bin/hg.exe ]; then
   mv /usr/bin/hg.exe /usr/bin/cygwin-hg.exe
 fi
 cp /cygdrive/c/Program\ Files/Mercurial/hg.exe /usr/bin/hg.exe

The native Cygwin python and hg do not work very well and should be avoided.

Set up your source code tree

Plan your directory structure ahead of time. If you are going to be producing changes or patches you will be cloning a copy of an unaltered source code tree for every change or patch you make, so you might want to have all this work stored in it's own directory.

To get a copy of the source code tree:

  • Open up a DOS/Command window
  • Make a directory to contain it (it is strongly suggested to name it viewer-development)
  • Go into that directory
  • Do hg init
  • Do hg pull http://hg.secondlife.com/viewer-development
  • Example: ((specific snapshot example TBD))

Let's say some time has gone by since you have performed the previous steps and now you want to develop a change or work on a jira. You will

  • Go into viewer-development (or whatever you named the master source tree copy)
  • Do hg pull
  • Do hg update
  • Move up one level from viewer-development
  • Do hg clone viewer-development VWR-nnnnn (where nnnnn is the jira number, or clone to a name of your choosing if there is not jira number)
  • Copy your olibs from above into this new source tree.

Build the viewer with autobuild

Install autobuild

If you haven't done so already, install autoubuild. Full instructions can be found on the Autobuild page, but most users may simply use

 easy_install autobuild

or

pip install autobuild

to install.

Build a desired configuration

With a properly configured developer machine (see compiling), building the viewer with autobuild is as simple as invoking

 autobuild build -c [CONFIGURATION]

where CONFIGURATION stands for the build configuration you would like to build. The build configurations defined in the viewer's autobuild.xml file follow some simple conventions which we describe below. As a developer you should choose the appropriate build configuration for your needs. After a build has completed, the resulting product will be found in the build directory named build-* where the * is wildcard representing the platform dependent part of the name.

Developers who wish to build a viewer with an IDE don't have to do a full command line build. Using

 autobuild configure -c [CONFIGURATION]

Will install any dependencies (if the build configuration uses them) and construct an appropriate project or solution file (.xcodeproj for mac and .sln for windows) inside the build directory.

Base build configurations

There are three basic types of build configurations which are used to vary the debugability of the resulting build versus optimization. These configurations are:

  • Debug — unoptomized with debugging information.
  • RelWithDebInfo — optomized but with debugging information.
  • Release — optimized with no debug information.

Debug will result in a slow client but is the easiest to use with a debugger. RelWithDebInfo is significantly faster and is often easy to debug, but code optimizations may occasionally make tracking program flow in a debugger challenging. Release is used for building a shipping version of the viewer.

Build variations for open source developers

The unmodified build configuraitons defined in the previous section are configured for use by Linden developers and may require access to installables which are not publicly available. For open source developers two variations are provided to support development by third parties using the following prefixes:

  • OpenSource — build a viewer using only publicly distributed installables.
  • OpenSourceStandAlone — build a viewer without using any installable packages provided by Linden.
    Developers will need to install any 3rd party dependencies manually.

To build an open source configuration choose a build configuration which is a concatonation of one of the two above prefixes with a base configuraiton name. For example to build a stand alone viewer with release optimization including debug information run

autobuild build -c OpenSourceStandAloneRelWithDebInfo

Compile using the IDE

Iteratively fix things until the compile succeeds

((TBD - add any fixup steps here. e.g. does fmod375.dll need to be moved into RelWithDbgInfo at this step?))

Common Issues/Bugs/Glitches And Solutions

  • Getting help:
    • Subscribe to OpenSource-Dev Mailing List (subscribe) and post your question there.
    • For faster response, find a free IRC client program and join #opensl on freenode, the general open source viewer discussion and development channel. Hopefully a helpful person is online when you ask your question.

References

These instructions are condensed from about a dozen previous pages of info:

((add other references here))