Second Life Wiki - User contributions [en]

Compiling the viewer (MSVS2005)

2007-09-15T21:12:30Z

Mayera Nagy: /* OpenGL */

{{CompileNav}}

This page explains how you can compile the viewer on Microsoft Windows using Visual Studio 2005 or Visual C++ Express 2005. Note that Lindens are using VS2003 and the whole setup is a bit easier there, so if you have Visual Studio 2003 available, you should read [[Compiling the viewer (MSVS2003)|compiling with VS2003]] and you will get less trouble with it than with VS2005.

The following explanation is adjusted for Viewer releases 1.16.0.5 or later. See an [http://wiki.secondlife.com/w/index.php?title=Compiling_the_viewer_%28MSVS2005%29&oldid=22294 older version of this page] for the Viewer releases 1.15 or before.

= Preparing the Development Environment =

== Installing/Configuring VS2005 ==

You need to setup the compiler and Microsoft Development tools as follows:
* Visual Studio 2005 '''''-or-''''' [http://msdn.microsoft.com/vstudio/express/visualc/download/ Visual C++ 2005 Express](Free) (Also, although not strictly necessary, eventually pick up and install SP1 for VS2005.)
* [http://www.microsoft.com/downloads/details.aspx?familyid=0BAF2B35-C656-4969-ACE8-E4C0C0716ADB&displaylang=en Microsoft Platform SDK]
* A DirectX 9.0 SDK released on or after Summer of 2003 [http://download.microsoft.com/download/5/1/f/51ff8357-0af3-418b-9d0b-e9a5cdc39759/dxsdk_dec2006.EXE DirectX 9.0 SDK (December 2006)] [http://www.microsoft.com/downloads/details.aspx?FamilyID=9216652f-51e0-402e-b7b5-feb68d00f298&displaylang=en DirectX 9.0 SDK Update (Summer 2003)]
: '''Note''': If you have previously installed an older version of the DirectX 9.0 SDK, remove it first (from Control Panel -> Add or Remove Programs) before installing this version. Installing the new SDK "on top" of an older version may cause problems.
* Set up the project globals:
** Start Microsoft Visual Studio 2005
** Go to Tools > Options > Projects > VC++ Directories
** Make sure that the '''includes''' ([[:Image:MSVS2005 Global Project Options Include Files.JPG|'''screen shot''']]) and '''libraries''' ([[:Image:MSVS2005 Global Project Options Library Files.JPG|'''screen shot''']]) paths have the Platform SDK paths first, then the DirectX SDK paths, and then the Visual C++ paths. You may need to check "Show All Settings" at the bottom for VC++ Directories to show.
** If the DirectX SDK paths aren't present, add them to both '''includes''' and '''libraries'''.
*: Note: The newest DirectX SDK ("December 2006") lib folder has two sub-folders, x64 and x86. Make sure your path goes to one of them (select '''lib/x86''', not just '''lib'''), or you will get a Link error.
 

== Getting other Development Tools ==
You will also need some open source development tools.
* [http://www.cygwin.com/ 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. The project files use several hardcoded references that expect Cygwin to be installed at '''C:\cygwin''', if it's not you'll need to edit those references.
* [http://www.activestate.com/Products/ActivePython/?mp=1 ActivePython 2.3x or later] - Latest Version is 2.5.1.1
** It is required but can be avoided if you are compiling 1.18 or later viewers. Either download and install or hack the prebuild.bat files as described in [http://jira.secondlife.com/browse/VWR-1267 VWR-1267].
* ActivePerl was recommended for previous versions on this Wiki, but it currently appears, that it is not strictly necessary unless you are planning to build your own version of all libraries (which most likely you don't want to do). So for a start it may be safe to skip it.
*: [http://www.activestate.com/Products/ActivePerl/?mp=1 ActivePerl]

 
 
 

= Downloading Source Code =

You can download the Viewer source codes on the [[source downloads]] page. You can also use a [[version control repository]].

At a minimum, grab the source package and the artwork package, but for a start, also grab the library archive. Many of the libraries can either be compiled from source or downloaded from other sites (see below), but this will take hours and thus it is easiest to also get the package with libraries compiled by the Lindens.

'''WARNING:'''
* If the directory path you keep the SL source in has a space in it, the batch file that copies message_template.msg will fail. So, if you unzip or checkout the source tree into, e.g., "C:\Projects\Dir with space in name\Etc\linden", it won't work!
* You should also avoid using non-ASCII (national) characters in the paths, although some localized versions of the tool puts some as a default...
* Unzip or checkout your source tree into a directory that has as short full pathname as possible, since long paths cause some unexpected trouble during the build.

In other words, the easiest way to get this working is to get ''source'', ''artwork'' and ''libraries'' from the [[source downloads]] page and unpack them all into the same directory/folder, which ideally would be a folder in (or near) the root directory with a short name like ''sl_1_16_0_5''.
 
 
 
 

= Installing Libraries =

SL Viewer depends on some third party libraries. Some of them are open source, some others are not.

== Open Source Libraries ==

You can download the pre-build open source libraries from LL. They are available on [[source downloads]] page. Unzip them into your SL viewer source code directory, maintaining the same directory structure.

'''Note: The VS2003 libraries provided in the [[source downloads]] do not fully work with VS2005 compiled binaries. They will compile with the viewer under VS2005, but the VS2003 libraries are not fully STL compliant. The differences of [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclang/html/vclrfnonstandardbehavior.asp non-standard behavior in MSVS] are the known cause.'''

Alternatively, it may be possible to get the source files for the libraries and build by yourself. See [[Compiling the viewer libraries (MSVS 2003)|the instruction for VS2003 users]] if you try it. Please note, however, it is not known that VS2005 can successfully compile the libraries. '''You have been warned.''' (If you can make it, please write the info on this wiki...)
 
 

== Proprietary Libraries ==

Lindens does not inlcude the following proprietary libraries. You will need to follow the instructions to acquire below and copy them to the source path.

However, it probably is 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 (like ''XCOPY OLIB SL_1_16_0_5 /S''). The reason is, that these steps are cumbersome and will have to be repeated for each new release (at least if you keep the source for each release in it's own folder). If you do not want to do this, of course you can just copy the files directly into the linden source paths.

rem OLIBS.CMD to build a folder tree for 3rd party libraries and includes
md olibs
md olibs\linden\
md olibs\linden\libraries
md olibs\linden\libraries\include
md olibs\linden\libraries\i686-win32
md olibs\linden\libraries\i686-win32\lib_release
md olibs\linden\libraries\i686-win32\lib_debug
md olibs\linden\libraries\i686-win32\include
md olibs\linden\libraries\i686-win32\include\GL
md olibs\linden\libraries\i686-win32\include\quicktime
md olibs\linden\indra
md olibs\linden\indra\newview
 
=== Fmod ===
* Download & extract [http://www.fmod.org/index.php/download fmod 3.75 api for win32] (later versions, like FMOD Ex, are incompatible).
* Copy "fmodapi375win\api\inc\fmod.h" to "linden\libraries\include"
* Copy "fmodapi375win\api\inc\fmod_errors.h" to "linden\libraries\include"
* Copy "fmodapi375win\api\lib\fmodvc.lib" to "linden\libraries\i686-win32\lib_release" and to "linden\libraries\i686-win32\lib_debug"
* Copy "fmodapi375win\api\fmod.dll" to "linden\indra\newview"
 

=== OpenGL ===
* Download [http://oss.sgi.com/projects/ogl-sample/sdk.html glext.h, glxext.h, and wglext.h]
* Copy them to "linden\libraries\i686-win32\include\GL"
* You don't need any additional *.lib or *.dll for OpenGL.
 

=== Quicktime ''(optional)'' ===
'''Note:''' This download requires a registration at the Apple Quicktime website and take a bit of time. You can avoid using QuickTime if you want, bee [[#QuickTime removal|below]] for details. Remember that your viewer '''can't play in-world movies''' if you do so.
* Download & install the [http://connect.apple.com/cgi-bin/WebObjects/MemberSite.woa/203/wa/getSoftware?fileID=20525&code=y&source=x&wosid=4h16WcyMtVfd2P1EffGafkoxFcr Quicktime SDK for Windows]
* Copy "QuicktimeSDK\Libraries\QTMLClient.lib" to "linden\libraries\i686-win32\lib_release" and to "linden\libraries\i686-win32\lib_debug".
* Copy the contents of "QuicktimeSDK\CIncludes" into "linden\libraries\i686-win32\include\quicktime".
 
 
 

= Configuring for VS2005 =

Lindens use VS2003 to develop the viewer.

You either need to convert ''solution file'' and ''project files'' from VS2003 format to VS2005 format or obtain files compatible with VS2005. You may also need to modify source files to work around the incompatibility between VS2003 and VS2005.

'''Note''': linden\indra\indra_complete_vs8.sln is a solution file already included in the source archive and intended for the Visual Studio 2005, but it '''does not work''' (at least between 1.14.0 and 1.17.0.9 distribution). This may change in a future release, if Lindens include an updated versions of the '''_vc8''' files.

 
 
== Using pre-built solution/project files ==

Currently there is a ZIP file with solution/project files available on the [https://jira.secondlife.com/browse/VWR-1151 JIRA bug tracker issue VWR-1151].

If you are building 1.16 or later, the easiest way towards compiling SL on MS2005 will be to use the zip file mentioned above. The details is as follows:
* Download the appropriate ZIP archive from JIRA.
* Unpack it and copy it onto your linden source tree (allow to overwrite files that have '''_vc8''' in the name).
* Start Visual Studio 2005 (or VC++ Express).
* Use "File > Open > Project/Solution" to open the linden\indra\indra_complete\indra_complete'''_vc8'''.sln (Note: If you plan to work with multiple versions over time, you will find it useful to rename '''indra_complete_vc8.sln''' to something which contains the version number, e.g. '''indra_1_17_0_11_vc8.sln''' before opening.)
* Right click '''newview''' in the frame Solution Explorer and click "Set as StartUp Project".
* Proceed with applying the '''Workarounds''' below (skip '''Manual conversion''').

'''Note:''' The solution/project files depends on the viewer release version. If you are compiling some specific version of the viewer, and the {{JIRA|VWR-1151}} doesn't list the zip file for you version, you can try using the most close one. If, while compiling, you later encounter errors or problems regarding the projects, you may have to do the manual conversion instead.

 

== Manual conversion of the solution/projects ==

If you can not find a set of project files (see above), there are instructions available how to manually do it: [[Converting_project_files_for_MSVS2005]] (this step will take about 5-15 minutes, depending on how proficient you are using VS2005).

 
 
 

== Workarounds ==

There are more compatibility problems between VS2003 and VS2005. You need the following code edits.
 
=== test project/crash_logger/updater ===

For whatever reason, the '''test''' project doesn't work under VS2005. Workaround is to disable it as follows: Right click on the '''test''' and choose '''Unload Project'''.

If you do not plan to create a full download build, you can exclude the '''win_crash_logger''' and '''win_updater''' from newview's project dependencies and unload them also. But be careful with unloading these projects without removing them from the dependencies, because I have seen VS2005 act highly erratic while linking then project when I tried this.
 
=== QuickTime removal ===

If you don't want to get Apple QuickTime SDK, you can disable it as follows:
*linden\indra\llcommon\llpreprocessor.h - near line 58 (the line below '''#elif LL_WINDOWS''')
--50: #define LL_QUICKTIME_ENABLED 1
++50: #define LL_QUICKTIME_ENABLED '''''0'''''

* Pick '''ReleaseNoOpt''' in the Solution Configurations drop-down box beside the green arrow under the tool bar, and do the followings on the Solution Explorer frame:
*Click '''newview''' to select it alone.
**Choose Properties.
**Under Configuration Properties > Linker > Input, click '''Additional Dependencies''' on the right to show a button labeled "'''...'''" on it at the very right on the line, then click the '''...''' button.
**Scroll down the list to find '''qtmlclient.lib'''. Delete this single line.
**Click '''OK''' to close the "Additional Dependencies" dialog, then click OK again to close the "newview Property Pages" dialog box.
* Pick '''ReleaseForDownload''' in the Solution Configurations drop-down box. Click '''newview''' to select it alone and do the same thing again.
 
 
 
= Ready, Set, Build! =

== Building ==
* Build either '''ReleaseNoOpt''' (for debugging) or '''ReleaseForDownload''' (for production code).
* To do this, pick either in the Solution Configurations drop-down box beside the green arrow under the tool bar.
* Make sure '''newview''' is set as the active project (otherwise set from newview's right-click menu).
* Select Build-Menu > Build Solution or press F7.
* newview_noopt.exe will be built in linden\indra\newview\ReleaseNoOpt or SecondLife.exe will be linden\indra\newview\ReleaseForDownload.
 
== Common compile errors ==
* See [[Common compilation problems]] if you run into other errors while building.
 
== Running ==
* You can run the viewer by '''Debug > Start Debugging''' or '''Debug > Start "Without Debugging''' in Visual Studio.
* To run it outside VS, create a shortcut to SecondLife.exe, and change the start location to linden\indra\newview\ (all the .dll will be found there.)
* Alternately copy the exe (possibly rename it) to your "c:\program files\second life" folder.
 
== Debugging Info/Configurations ==
* Usually you will either use '''ReleaseNoOpt''' or the '''ReleaseForDownload''' configuration.
* '''ReleaseNoOpt''' (not optimized) compiles faster and has more debugging information, but this comes at a runtime penalty of about 50% of your FPS in busy areas, compared to ReleaseForDownload build.
* '''ReleaseForDownload''' also has debugging information and runs fine in the debugger (although at times you may miss access to some local variables).
* '''ReleaseNoOpt''' comes with a seperate debugging console window opens and stays open for the duration of your session, but you can access the same information also by pressing Shift+Ctrl+4 in the viewer (all builds).
* The debug console log can also be redirected to a file if you add "2>secondlife.log" to the command line (Newview, Properties, Debugging, Command line arguments).
* If you want to build a '''Debug''' configuration, see the specific section with compile instructions on [[Finding_leaks]]
 

== Problems Running? ==
* '''Inventory errors''': If you're getting errors while trying to load your inventory, try [[Help:Stuck logging in|clearing your cache and deleting other temporary files]].
* '''Missing smime3 DLL''': Those are parts of the integrated web browser. Copy 'smime3.dll', 'nss3.dll', 'softokn3.dll', and 'ssl3.dll' files from your official client's main folder to "linden\indra\newview".
* '''Can't connect''': In the debug builds there is a selection box on the login screen to select the server to connect to. '''Agni''' is the production grid, '''aditi''' is the beta grid. (There seems to be a bug in this part of the code, you may have to make your selection, close the viewer and repoen it, before you can connect to the selected grid).
 
 
= Submit Patches =
This is probably faaar down the road, but if you make changes to the source and want to submit them, see the page about [[Submitting patches|submitting patches]].

Compiling the viewer (MSVS2005)

2007-09-15T21:11:12Z

Mayera Nagy: /* Installing Libraries */

{{CompileNav}}

This page explains how you can compile the viewer on Microsoft Windows using Visual Studio 2005 or Visual C++ Express 2005. Note that Lindens are using VS2003 and the whole setup is a bit easier there, so if you have Visual Studio 2003 available, you should read [[Compiling the viewer (MSVS2003)|compiling with VS2003]] and you will get less trouble with it than with VS2005.

The following explanation is adjusted for Viewer releases 1.16.0.5 or later. See an [http://wiki.secondlife.com/w/index.php?title=Compiling_the_viewer_%28MSVS2005%29&oldid=22294 older version of this page] for the Viewer releases 1.15 or before.

= Preparing the Development Environment =

== Installing/Configuring VS2005 ==

You need to setup the compiler and Microsoft Development tools as follows:
* Visual Studio 2005 '''''-or-''''' [http://msdn.microsoft.com/vstudio/express/visualc/download/ Visual C++ 2005 Express](Free) (Also, although not strictly necessary, eventually pick up and install SP1 for VS2005.)
* [http://www.microsoft.com/downloads/details.aspx?familyid=0BAF2B35-C656-4969-ACE8-E4C0C0716ADB&displaylang=en Microsoft Platform SDK]
* A DirectX 9.0 SDK released on or after Summer of 2003 [http://download.microsoft.com/download/5/1/f/51ff8357-0af3-418b-9d0b-e9a5cdc39759/dxsdk_dec2006.EXE DirectX 9.0 SDK (December 2006)] [http://www.microsoft.com/downloads/details.aspx?FamilyID=9216652f-51e0-402e-b7b5-feb68d00f298&displaylang=en DirectX 9.0 SDK Update (Summer 2003)]
: '''Note''': If you have previously installed an older version of the DirectX 9.0 SDK, remove it first (from Control Panel -> Add or Remove Programs) before installing this version. Installing the new SDK "on top" of an older version may cause problems.
* Set up the project globals:
** Start Microsoft Visual Studio 2005
** Go to Tools > Options > Projects > VC++ Directories
** Make sure that the '''includes''' ([[:Image:MSVS2005 Global Project Options Include Files.JPG|'''screen shot''']]) and '''libraries''' ([[:Image:MSVS2005 Global Project Options Library Files.JPG|'''screen shot''']]) paths have the Platform SDK paths first, then the DirectX SDK paths, and then the Visual C++ paths. You may need to check "Show All Settings" at the bottom for VC++ Directories to show.
** If the DirectX SDK paths aren't present, add them to both '''includes''' and '''libraries'''.
*: Note: The newest DirectX SDK ("December 2006") lib folder has two sub-folders, x64 and x86. Make sure your path goes to one of them (select '''lib/x86''', not just '''lib'''), or you will get a Link error.
 

== Getting other Development Tools ==
You will also need some open source development tools.
* [http://www.cygwin.com/ 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. The project files use several hardcoded references that expect Cygwin to be installed at '''C:\cygwin''', if it's not you'll need to edit those references.
* [http://www.activestate.com/Products/ActivePython/?mp=1 ActivePython 2.3x or later] - Latest Version is 2.5.1.1
** It is required but can be avoided if you are compiling 1.18 or later viewers. Either download and install or hack the prebuild.bat files as described in [http://jira.secondlife.com/browse/VWR-1267 VWR-1267].
* ActivePerl was recommended for previous versions on this Wiki, but it currently appears, that it is not strictly necessary unless you are planning to build your own version of all libraries (which most likely you don't want to do). So for a start it may be safe to skip it.
*: [http://www.activestate.com/Products/ActivePerl/?mp=1 ActivePerl]

 
 
 

= Downloading Source Code =

You can download the Viewer source codes on the [[source downloads]] page. You can also use a [[version control repository]].

At a minimum, grab the source package and the artwork package, but for a start, also grab the library archive. Many of the libraries can either be compiled from source or downloaded from other sites (see below), but this will take hours and thus it is easiest to also get the package with libraries compiled by the Lindens.

'''WARNING:'''
* If the directory path you keep the SL source in has a space in it, the batch file that copies message_template.msg will fail. So, if you unzip or checkout the source tree into, e.g., "C:\Projects\Dir with space in name\Etc\linden", it won't work!
* You should also avoid using non-ASCII (national) characters in the paths, although some localized versions of the tool puts some as a default...
* Unzip or checkout your source tree into a directory that has as short full pathname as possible, since long paths cause some unexpected trouble during the build.

In other words, the easiest way to get this working is to get ''source'', ''artwork'' and ''libraries'' from the [[source downloads]] page and unpack them all into the same directory/folder, which ideally would be a folder in (or near) the root directory with a short name like ''sl_1_16_0_5''.
 
 
 
 

= Installing Libraries =

SL Viewer depends on some third party libraries. Some of them are open source, some others are not.

== Open Source Libraries ==

You can download the pre-build open source libraries from LL. They are available on [[source downloads]] page. Unzip them into your SL viewer source code directory, maintaining the same directory structure.

'''Note: The VS2003 libraries provided in the [[source downloads]] do not fully work with VS2005 compiled binaries. They will compile with the viewer under VS2005, but the VS2003 libraries are not fully STL compliant. The differences of [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclang/html/vclrfnonstandardbehavior.asp non-standard behavior in MSVS] are the known cause.'''

Alternatively, it may be possible to get the source files for the libraries and build by yourself. See [[Compiling the viewer libraries (MSVS 2003)|the instruction for VS2003 users]] if you try it. Please note, however, it is not known that VS2005 can successfully compile the libraries. '''You have been warned.''' (If you can make it, please write the info on this wiki...)
 
 

== Proprietary Libraries ==

Lindens does not inlcude the following proprietary libraries. You will need to follow the instructions to acquire below and copy them to the source path.

However, it probably is 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 (like ''XCOPY OLIB SL_1_16_0_5 /S''). The reason is, that these steps are cumbersome and will have to be repeated for each new release (at least if you keep the source for each release in it's own folder). If you do not want to do this, of course you can just copy the files directly into the linden source paths.

rem OLIBS.CMD to build a folder tree for 3rd party libraries and includes
md olibs
md olibs\linden\
md olibs\linden\libraries
md olibs\linden\libraries\include
md olibs\linden\libraries\i686-win32
md olibs\linden\libraries\i686-win32\lib_release
md olibs\linden\libraries\i686-win32\lib_debug
md olibs\linden\libraries\i686-win32\include
md olibs\linden\libraries\i686-win32\include\GL
md olibs\linden\libraries\i686-win32\include\quicktime
md olibs\linden\indra
md olibs\linden\indra\newview
 
=== Fmod ===
* Download & extract [http://www.fmod.org/index.php/download fmod 3.75 api for win32] (later versions, like FMOD Ex, are incompatible).
* Copy "fmodapi375win\api\inc\fmod.h" to "linden\libraries\include"
* Copy "fmodapi375win\api\inc\fmod_errors.h" to "linden\libraries\include"
* Copy "fmodapi375win\api\lib\fmodvc.lib" to "linden\libraries\i686-win32\lib_release" and to "linden\libraries\i686-win32\lib_debug"
* Copy "fmodapi375win\api\fmod.dll" to "linden\indra\newview"
 

=== OpenGL ===
* Download [http://oss.sgi.com/projects/ogl-sample/sdk.html glext.h, glxext.h, and wglext.h]
* Copy them to "linden\libraries\i686-win32\include\GL"
* You don't need any additional *.lib or *.dll for OpenGL.
 
=== Quicktime ''(optional)'' ===
'''Note:''' This download requires a registration at the Apple Quicktime website and take a bit of time. You can avoid using QuickTime if you want, bee [[#QuickTime removal|below]] for details. Remember that your viewer '''can't play in-world movies''' if you do so.
* Download & install the [http://connect.apple.com/cgi-bin/WebObjects/MemberSite.woa/203/wa/getSoftware?fileID=20525&code=y&source=x&wosid=4h16WcyMtVfd2P1EffGafkoxFcr Quicktime SDK for Windows]
* Copy "QuicktimeSDK\Libraries\QTMLClient.lib" to "linden\libraries\i686-win32\lib_release" and to "linden\libraries\i686-win32\lib_debug".
* Copy the contents of "QuicktimeSDK\CIncludes" into "linden\libraries\i686-win32\include\quicktime".
 
 
 

= Configuring for VS2005 =

Lindens use VS2003 to develop the viewer.

You either need to convert ''solution file'' and ''project files'' from VS2003 format to VS2005 format or obtain files compatible with VS2005. You may also need to modify source files to work around the incompatibility between VS2003 and VS2005.

'''Note''': linden\indra\indra_complete_vs8.sln is a solution file already included in the source archive and intended for the Visual Studio 2005, but it '''does not work''' (at least between 1.14.0 and 1.17.0.9 distribution). This may change in a future release, if Lindens include an updated versions of the '''_vc8''' files.

 
 
== Using pre-built solution/project files ==

Currently there is a ZIP file with solution/project files available on the [https://jira.secondlife.com/browse/VWR-1151 JIRA bug tracker issue VWR-1151].

If you are building 1.16 or later, the easiest way towards compiling SL on MS2005 will be to use the zip file mentioned above. The details is as follows:
* Download the appropriate ZIP archive from JIRA.
* Unpack it and copy it onto your linden source tree (allow to overwrite files that have '''_vc8''' in the name).
* Start Visual Studio 2005 (or VC++ Express).
* Use "File > Open > Project/Solution" to open the linden\indra\indra_complete\indra_complete'''_vc8'''.sln (Note: If you plan to work with multiple versions over time, you will find it useful to rename '''indra_complete_vc8.sln''' to something which contains the version number, e.g. '''indra_1_17_0_11_vc8.sln''' before opening.)
* Right click '''newview''' in the frame Solution Explorer and click "Set as StartUp Project".
* Proceed with applying the '''Workarounds''' below (skip '''Manual conversion''').

'''Note:''' The solution/project files depends on the viewer release version. If you are compiling some specific version of the viewer, and the {{JIRA|VWR-1151}} doesn't list the zip file for you version, you can try using the most close one. If, while compiling, you later encounter errors or problems regarding the projects, you may have to do the manual conversion instead.

 

== Manual conversion of the solution/projects ==

If you can not find a set of project files (see above), there are instructions available how to manually do it: [[Converting_project_files_for_MSVS2005]] (this step will take about 5-15 minutes, depending on how proficient you are using VS2005).

 
 
 

== Workarounds ==

There are more compatibility problems between VS2003 and VS2005. You need the following code edits.
 
=== test project/crash_logger/updater ===

For whatever reason, the '''test''' project doesn't work under VS2005. Workaround is to disable it as follows: Right click on the '''test''' and choose '''Unload Project'''.

If you do not plan to create a full download build, you can exclude the '''win_crash_logger''' and '''win_updater''' from newview's project dependencies and unload them also. But be careful with unloading these projects without removing them from the dependencies, because I have seen VS2005 act highly erratic while linking then project when I tried this.
 
=== QuickTime removal ===

If you don't want to get Apple QuickTime SDK, you can disable it as follows:
*linden\indra\llcommon\llpreprocessor.h - near line 58 (the line below '''#elif LL_WINDOWS''')
--50: #define LL_QUICKTIME_ENABLED 1
++50: #define LL_QUICKTIME_ENABLED '''''0'''''

* Pick '''ReleaseNoOpt''' in the Solution Configurations drop-down box beside the green arrow under the tool bar, and do the followings on the Solution Explorer frame:
*Click '''newview''' to select it alone.
**Choose Properties.
**Under Configuration Properties > Linker > Input, click '''Additional Dependencies''' on the right to show a button labeled "'''...'''" on it at the very right on the line, then click the '''...''' button.
**Scroll down the list to find '''qtmlclient.lib'''. Delete this single line.
**Click '''OK''' to close the "Additional Dependencies" dialog, then click OK again to close the "newview Property Pages" dialog box.
* Pick '''ReleaseForDownload''' in the Solution Configurations drop-down box. Click '''newview''' to select it alone and do the same thing again.
 
 
 
= Ready, Set, Build! =

== Building ==
* Build either '''ReleaseNoOpt''' (for debugging) or '''ReleaseForDownload''' (for production code).
* To do this, pick either in the Solution Configurations drop-down box beside the green arrow under the tool bar.
* Make sure '''newview''' is set as the active project (otherwise set from newview's right-click menu).
* Select Build-Menu > Build Solution or press F7.
* newview_noopt.exe will be built in linden\indra\newview\ReleaseNoOpt or SecondLife.exe will be linden\indra\newview\ReleaseForDownload.
 
== Common compile errors ==
* See [[Common compilation problems]] if you run into other errors while building.
 
== Running ==
* You can run the viewer by '''Debug > Start Debugging''' or '''Debug > Start "Without Debugging''' in Visual Studio.
* To run it outside VS, create a shortcut to SecondLife.exe, and change the start location to linden\indra\newview\ (all the .dll will be found there.)
* Alternately copy the exe (possibly rename it) to your "c:\program files\second life" folder.
 
== Debugging Info/Configurations ==
* Usually you will either use '''ReleaseNoOpt''' or the '''ReleaseForDownload''' configuration.
* '''ReleaseNoOpt''' (not optimized) compiles faster and has more debugging information, but this comes at a runtime penalty of about 50% of your FPS in busy areas, compared to ReleaseForDownload build.
* '''ReleaseForDownload''' also has debugging information and runs fine in the debugger (although at times you may miss access to some local variables).
* '''ReleaseNoOpt''' comes with a seperate debugging console window opens and stays open for the duration of your session, but you can access the same information also by pressing Shift+Ctrl+4 in the viewer (all builds).
* The debug console log can also be redirected to a file if you add "2>secondlife.log" to the command line (Newview, Properties, Debugging, Command line arguments).
* If you want to build a '''Debug''' configuration, see the specific section with compile instructions on [[Finding_leaks]]
 

== Problems Running? ==
* '''Inventory errors''': If you're getting errors while trying to load your inventory, try [[Help:Stuck logging in|clearing your cache and deleting other temporary files]].
* '''Missing smime3 DLL''': Those are parts of the integrated web browser. Copy 'smime3.dll', 'nss3.dll', 'softokn3.dll', and 'ssl3.dll' files from your official client's main folder to "linden\indra\newview".
* '''Can't connect''': In the debug builds there is a selection box on the login screen to select the server to connect to. '''Agni''' is the production grid, '''aditi''' is the beta grid. (There seems to be a bug in this part of the code, you may have to make your selection, close the viewer and repoen it, before you can connect to the selected grid).
 
 
= Submit Patches =
This is probably faaar down the road, but if you make changes to the source and want to submit them, see the page about [[Submitting patches|submitting patches]].

Compiling the viewer (MSVS2005)

2007-09-15T20:32:14Z

Mayera Nagy: /* Preparing the Development Environment */

{{CompileNav}}

This page explains how you can compile the viewer on Microsoft Windows using Visual Studio 2005 or Visual C++ Express 2005. Note that Lindens are using VS2003 and the whole setup is a bit easier there, so if you have Visual Studio 2003 available, you should read [[Compiling the viewer (MSVS2003)|compiling with VS2003]] and you will get less trouble with it than with VS2005.

The following explanation is adjusted for Viewer releases 1.16.0.5 or later. See an [http://wiki.secondlife.com/w/index.php?title=Compiling_the_viewer_%28MSVS2005%29&oldid=22294 older version of this page] for the Viewer releases 1.15 or before.

= Preparing the Development Environment =

== Installing/Configuring VS2005 ==

You need to setup the compiler and Microsoft Development tools as follows:
* Visual Studio 2005 '''''-or-''''' [http://msdn.microsoft.com/vstudio/express/visualc/download/ Visual C++ 2005 Express](Free) (Also, although not strictly necessary, eventually pick up and install SP1 for VS2005.)
* [http://www.microsoft.com/downloads/details.aspx?familyid=0BAF2B35-C656-4969-ACE8-E4C0C0716ADB&displaylang=en Microsoft Platform SDK]
* A DirectX 9.0 SDK released on or after Summer of 2003 [http://download.microsoft.com/download/5/1/f/51ff8357-0af3-418b-9d0b-e9a5cdc39759/dxsdk_dec2006.EXE DirectX 9.0 SDK (December 2006)] [http://www.microsoft.com/downloads/details.aspx?FamilyID=9216652f-51e0-402e-b7b5-feb68d00f298&displaylang=en DirectX 9.0 SDK Update (Summer 2003)]
: '''Note''': If you have previously installed an older version of the DirectX 9.0 SDK, remove it first (from Control Panel -> Add or Remove Programs) before installing this version. Installing the new SDK "on top" of an older version may cause problems.
* Set up the project globals:
** Start Microsoft Visual Studio 2005
** Go to Tools > Options > Projects > VC++ Directories
** Make sure that the '''includes''' ([[:Image:MSVS2005 Global Project Options Include Files.JPG|'''screen shot''']]) and '''libraries''' ([[:Image:MSVS2005 Global Project Options Library Files.JPG|'''screen shot''']]) paths have the Platform SDK paths first, then the DirectX SDK paths, and then the Visual C++ paths. You may need to check "Show All Settings" at the bottom for VC++ Directories to show.
** If the DirectX SDK paths aren't present, add them to both '''includes''' and '''libraries'''.
*: Note: The newest DirectX SDK ("December 2006") lib folder has two sub-folders, x64 and x86. Make sure your path goes to one of them (select '''lib/x86''', not just '''lib'''), or you will get a Link error.
 

== Getting other Development Tools ==
You will also need some open source development tools.
* [http://www.cygwin.com/ 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. The project files use several hardcoded references that expect Cygwin to be installed at '''C:\cygwin''', if it's not you'll need to edit those references.
* [http://www.activestate.com/Products/ActivePython/?mp=1 ActivePython 2.3x or later] - Latest Version is 2.5.1.1
** It is required but can be avoided if you are compiling 1.18 or later viewers. Either download and install or hack the prebuild.bat files as described in [http://jira.secondlife.com/browse/VWR-1267 VWR-1267].
* ActivePerl was recommended for previous versions on this Wiki, but it currently appears, that it is not strictly necessary unless you are planning to build your own version of all libraries (which most likely you don't want to do). So for a start it may be safe to skip it.
*: [http://www.activestate.com/Products/ActivePerl/?mp=1 ActivePerl]

 
 
 

= Downloading Source Code =

You can download the Viewer source codes on the [[source downloads]] page. You can also use a [[version control repository]].

At a minimum, grab the source package and the artwork package, but for a start, also grab the library archive. Many of the libraries can either be compiled from source or downloaded from other sites (see below), but this will take hours and thus it is easiest to also get the package with libraries compiled by the Lindens.

'''WARNING:'''
* If the directory path you keep the SL source in has a space in it, the batch file that copies message_template.msg will fail. So, if you unzip or checkout the source tree into, e.g., "C:\Projects\Dir with space in name\Etc\linden", it won't work!
* You should also avoid using non-ASCII (national) characters in the paths, although some localized versions of the tool puts some as a default...
* Unzip or checkout your source tree into a directory that has as short full pathname as possible, since long paths cause some unexpected trouble during the build.

In other words, the easiest way to get this working is to get ''source'', ''artwork'' and ''libraries'' from the [[source downloads]] page and unpack them all into the same directory/folder, which ideally would be a folder in (or near) the root directory with a short name like ''sl_1_16_0_5''.
 
 
 
 

= Installing Libraries =

SL Viewer depends on some third party libraries. Some of them are open source, some others are not.

== Open Source Libraries ==

You can download the pre-build open source libraries from LL. They are available on [[source downloads]] page. Unzip them into your SL viewer source code directory, maintaining the same directory structure.

'''Note: The VS2003 libraries provided in the [[source downloads]] do not fully work with VS2005 compiled binaries. They will compile with the viewer under VS2005, but the VS2003 libraries are not fully STL compliant. The differences of [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vclang/html/vclrfnonstandardbehavior.asp non-standard behavior in MSVS] are the known cause.'''

Alternatively, it may be possible to get the source files for the libraries and build by yourself. See [[Compiling the viewer libraries (MSVS 2003)|the instruction for VS2003 users]] if you try it. Please note, however, it is not known that VS2005 can successfully compile the libraries. '''You have been warned.''' (If you can make it, please write the info on this wiki...)
 
 

== Proprietary Libraries ==

Lindens does not inlcude the following proprietary libraries. You will need to follow the instructions to acquire below and copy them to the source path.

However, it probably is 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 (like ''XCOPY OLIB SL_1_16_0_5 /S''). The reason is, that these steps are cumbersome and will have to be repeated for each new release (at least if you keep the source for each release in it's own folder). If you do not want to do this, of course you can just copy the files directly into the linden source paths.

rem OLIBS.CMD to build a folder tree for 3rd party libraries and includes
md olibs
md olibs\linden\
md olibs\linden\libraries
md olibs\linden\libraries\include
md olibs\linden\libraries\i686-win32
md olibs\linden\libraries\i686-win32\lib_release
md olibs\linden\libraries\i686-win32\lib_debug
md olibs\linden\libraries\i686-win32\include
md olibs\linden\libraries\i686-win32\include\GL
md olibs\linden\libraries\i686-win32\include\quicktime
md olibs\linden\indra
md olibs\linden\indra\newview
 
=== Fmod ===
* Download & extract [http://www.fmod.org/index.php/download fmod 3.75 api for win32] (later versions, like FMOD Ex, are incompatible).
* Copy "fmodapi375win\api\inc\fmod.h" to "linden\libraries\include"
* Copy "fmodapi375win\api\inc\fmod_errors.h" to "linden\libraries\include"
* Copy "fmodapi375win\api\lib\fmodvc.lib" to "linden\libraries\i686-win32\lib_release" and to "linden\libraries\i686-win32\lib_debug"
* Copy "fmodapi375win\api\fmod.dll" to "linden\indra\newview"
 

=== OpenGL ===
* Download [http://oss.sgi.com/projects/ogl-sample/sdk.html glext.h, glxext.h, and wglext.h]
* Copy them to "linden\libraries\i686-win32\include\GL"
* You don't need any additional *.lib or *.dll for OpenGL.
 
=== Quicktime ''(optional)'' ===
'''Note:''' This download requires a registration at the Apple Quicktime website and take a bit of time. You can avoid using QuickTime if you want, bee [[#QuickTime removal|below]] for details. Remember that your viewer '''can't play in-world movies''' if you do so.
* Download & install the [http://connect.apple.com/cgi-bin/WebObjects/MemberSite.woa/203/wa/getSoftware?fileID=20525&code=y&source=x&wosid=4h16WcyMtVfd2P1EffGafkoxFcr Quicktime SDK for Windows]
* Copy "QuicktimeSDK\Libraries\QTMLClient.lib" to "linden\libraries\i686-win32\lib_release" and to "linden\libraries\i686-win32\lib_debug".
* Copy the contents of "QuicktimeSDK\CIncludes" into "linden\libraries\i686-win32\include\quicktime".
 
 
 
= Configuring for VS2005 =

Lindens use VS2003 to develop the viewer.

You either need to convert ''solution file'' and ''project files'' from VS2003 format to VS2005 format or obtain files compatible with VS2005. You may also need to modify source files to work around the incompatibility between VS2003 and VS2005.

'''Note''': linden\indra\indra_complete_vs8.sln is a solution file already included in the source archive and intended for the Visual Studio 2005, but it '''does not work''' (at least between 1.14.0 and 1.17.0.9 distribution). This may change in a future release, if Lindens include an updated versions of the '''_vc8''' files.

 
 
== Using pre-built solution/project files ==

Currently there is a ZIP file with solution/project files available on the [https://jira.secondlife.com/browse/VWR-1151 JIRA bug tracker issue VWR-1151].

If you are building 1.16 or later, the easiest way towards compiling SL on MS2005 will be to use the zip file mentioned above. The details is as follows:
* Download the appropriate ZIP archive from JIRA.
* Unpack it and copy it onto your linden source tree (allow to overwrite files that have '''_vc8''' in the name).
* Start Visual Studio 2005 (or VC++ Express).
* Use "File > Open > Project/Solution" to open the linden\indra\indra_complete\indra_complete'''_vc8'''.sln (Note: If you plan to work with multiple versions over time, you will find it useful to rename '''indra_complete_vc8.sln''' to something which contains the version number, e.g. '''indra_1_17_0_11_vc8.sln''' before opening.)
* Right click '''newview''' in the frame Solution Explorer and click "Set as StartUp Project".
* Proceed with applying the '''Workarounds''' below (skip '''Manual conversion''').

'''Note:''' The solution/project files depends on the viewer release version. If you are compiling some specific version of the viewer, and the {{JIRA|VWR-1151}} doesn't list the zip file for you version, you can try using the most close one. If, while compiling, you later encounter errors or problems regarding the projects, you may have to do the manual conversion instead.

 

== Manual conversion of the solution/projects ==

If you can not find a set of project files (see above), there are instructions available how to manually do it: [[Converting_project_files_for_MSVS2005]] (this step will take about 5-15 minutes, depending on how proficient you are using VS2005).

 
 
 

== Workarounds ==

There are more compatibility problems between VS2003 and VS2005. You need the following code edits.
 
=== test project/crash_logger/updater ===

For whatever reason, the '''test''' project doesn't work under VS2005. Workaround is to disable it as follows: Right click on the '''test''' and choose '''Unload Project'''.

If you do not plan to create a full download build, you can exclude the '''win_crash_logger''' and '''win_updater''' from newview's project dependencies and unload them also. But be careful with unloading these projects without removing them from the dependencies, because I have seen VS2005 act highly erratic while linking then project when I tried this.
 
=== QuickTime removal ===

If you don't want to get Apple QuickTime SDK, you can disable it as follows:
*linden\indra\llcommon\llpreprocessor.h - near line 58 (the line below '''#elif LL_WINDOWS''')
--50: #define LL_QUICKTIME_ENABLED 1
++50: #define LL_QUICKTIME_ENABLED '''''0'''''

* Pick '''ReleaseNoOpt''' in the Solution Configurations drop-down box beside the green arrow under the tool bar, and do the followings on the Solution Explorer frame:
*Click '''newview''' to select it alone.
**Choose Properties.
**Under Configuration Properties > Linker > Input, click '''Additional Dependencies''' on the right to show a button labeled "'''...'''" on it at the very right on the line, then click the '''...''' button.
**Scroll down the list to find '''qtmlclient.lib'''. Delete this single line.
**Click '''OK''' to close the "Additional Dependencies" dialog, then click OK again to close the "newview Property Pages" dialog box.
* Pick '''ReleaseForDownload''' in the Solution Configurations drop-down box. Click '''newview''' to select it alone and do the same thing again.
 
 
 
= Ready, Set, Build! =

== Building ==
* Build either '''ReleaseNoOpt''' (for debugging) or '''ReleaseForDownload''' (for production code).
* To do this, pick either in the Solution Configurations drop-down box beside the green arrow under the tool bar.
* Make sure '''newview''' is set as the active project (otherwise set from newview's right-click menu).
* Select Build-Menu > Build Solution or press F7.
* newview_noopt.exe will be built in linden\indra\newview\ReleaseNoOpt or SecondLife.exe will be linden\indra\newview\ReleaseForDownload.
 
== Common compile errors ==
* See [[Common compilation problems]] if you run into other errors while building.
 
== Running ==
* You can run the viewer by '''Debug > Start Debugging''' or '''Debug > Start "Without Debugging''' in Visual Studio.
* To run it outside VS, create a shortcut to SecondLife.exe, and change the start location to linden\indra\newview\ (all the .dll will be found there.)
* Alternately copy the exe (possibly rename it) to your "c:\program files\second life" folder.
 
== Debugging Info/Configurations ==
* Usually you will either use '''ReleaseNoOpt''' or the '''ReleaseForDownload''' configuration.
* '''ReleaseNoOpt''' (not optimized) compiles faster and has more debugging information, but this comes at a runtime penalty of about 50% of your FPS in busy areas, compared to ReleaseForDownload build.
* '''ReleaseForDownload''' also has debugging information and runs fine in the debugger (although at times you may miss access to some local variables).
* '''ReleaseNoOpt''' comes with a seperate debugging console window opens and stays open for the duration of your session, but you can access the same information also by pressing Shift+Ctrl+4 in the viewer (all builds).
* The debug console log can also be redirected to a file if you add "2>secondlife.log" to the command line (Newview, Properties, Debugging, Command line arguments).
* If you want to build a '''Debug''' configuration, see the specific section with compile instructions on [[Finding_leaks]]
 

== Problems Running? ==
* '''Inventory errors''': If you're getting errors while trying to load your inventory, try [[Help:Stuck logging in|clearing your cache and deleting other temporary files]].
* '''Missing smime3 DLL''': Those are parts of the integrated web browser. Copy 'smime3.dll', 'nss3.dll', 'softokn3.dll', and 'ssl3.dll' files from your official client's main folder to "linden\indra\newview".
* '''Can't connect''': In the debug builds there is a selection box on the login screen to select the server to connect to. '''Agni''' is the production grid, '''aditi''' is the beta grid. (There seems to be a bug in this part of the code, you may have to make your selection, close the viewer and repoen it, before you can connect to the selected grid).
 
 
= Submit Patches =
This is probably faaar down the road, but if you make changes to the source and want to submit them, see the page about [[Submitting patches|submitting patches]].

Preparing Code

2007-09-15T20:27:19Z

Mayera Nagy: /* Unified diff of all changed files in a folder tree */

{{OSWikiContribBox}}

If you have a piece of source code (be it a fix, new feature, or optimization of existing code) submit the patches in a way that makes it easy for the Lindens to incorporate them into the source code.

== Good Patch Practise ==

=== General ===

The best way to think about patches is that the people who are reviewing and applying your patches are the bottleneck in the system. If you can make it easier for us to understand and apply patches without lots of cleanup, we can spend more time reviewing and incorporating your work.

===Before You Start===

Check [https://jira.secondlife.com/secure/Dashboard.jspa| JIRA Bug Tracker] to see if the issue has been submitted and its status.

If you're going to write a patch, don't forget to sign and send in the [http://secondlifegrid.net/programs/open_source/submission contribution agreement]. The sooner you do that, the sooner we can accept your patch.

=== Coding Standard ===

Please read and follow the coding standard: [[Coding_standard|Second Life coding standard]]

=== Comments ===

Please do not add issue numbers or your name to patches. We have to remove these by hand. Also, please be careful in how you add comments. Bracketing a patch with comments like "// PATCH START" and "// PATCH END" does not add any information, and adds to the manual cleanup we have to do.

If you want to make sure you get credited, then
add yourself to doc/contributions.txt as part of the patch. That makes
it easier for people to see the exact nature of the changes you've added.

In short, just add to the patch what is expected to appear in the final source.

=== One Patch for one Issue ===

Each patch should do exactly one thing. If you have three different bugs to fix, please submit three different patches. When you fold unrelated hunks into a single patch, we have to try to figure out which part of the patch applies to which bug, and split it out by hand, sometimes into several patches. Combo patches are particularly time consuming, and the manual splitting up makes it very easy to lose pieces of patches altogether.

=== Less is more ===

Smaller patches are easier to review and therefore more likely to be integrated quickly. The longer it takes for a patch to be incorporated, the higher the likelihood that the underlying code will change enough for the patch to fail. Please do not include formatting or other clean-up changes as that makes it harder to review and more likely to fail.

=== Path structure ===

It is not a must, but if your path structure permits, start the patch on the directory level where the linden folder resides, so that the path/file names in your patch will start with '''linden/'''.

=== Give Yourself Credit! ===

Please don't be shy about adding the issue label to doc/contributions.txt and adding your name. We use this file for a number of purposes, including the generation of the [[Source contributions]] page.

== Creating a Patch ==

Patches should be submitted in unified diff format. This format is similar to simple diffs, but with more detailed information, and it can be automatically integrated into the source. You can generate a unified diff by calling ''diff -u <original file> <new file>'' (under Windows you will find the diff command as part of the CygWin project in C:\CYGWIN\BIN).

Please submit a single plain text uncompressed patch file that affects all of the files you need to modify. This is far easier to review than a collection of tiny one-file patches.

Also bad for reviewability are a compressed patch, or a tarball or zip containing one or more patches.
 
=== Unified diff of all changed files in a folder tree ===
The easiest way to generate a clean patch is to keep two copies of the source tree. Leave one completely unmodified, and make all of your changes in the second. Then use "diff -urN" to generate the patch. You can use the --exclude option to omit unwanted files. For example:

diff -urN --exclude="*.o" my_untouched_tree my_modified_tree
 

=== Unified diff of multiple files ===
If for any reason you can not use a whole tree diff as above, you can still merge patches from different files into one, by appending the output of patch commands to the previous output (via '''>>''' redirection for the 2nd and later commands).

diff -u linden-untouched/indra/newview/viewer.h linden/indra/newview/viewer.h >mychanges.patch.txt
diff -u linden-untouched/indra/newview/viewer.cpp linden/indra/newview/viewer.cpp '''>>'''mychanges.patch.txt
diff -u linden-untouched/indra/newview/llviewerwindow.cpp linden/indra/newview/llviewerwindow.cpp '''>>'''mychanges.patch.txt

 

=== CR/LF vs LF and Whitespace===
In some situations, you will find that the patch contains the whole file, rather than just the lines changed. The reason is that sometimes, files in Linux format find their way into the source distribution. With these diff.exe will treat all lines as different from those in your modified file.

There are various options that will help here. You can add ''--strip-trailing-cr'' to the command line to fix this.

diff -u --strip-trailing-cr linden-untouched/indra/newview/viewer.h linden/indra/newview/viewer.h >mychanges.patch.txt

In some situations try the '''w''' (ignore whitespace) and/or '''B''' (ignore empty lines) options are also helpful (e.g. with tabs vs. space or spurious space characters while editing). Type '''diff --help''' for more details.

 
=== Sample output ===
For reference, here's what a unified diff looks like.

--- linden-untouched/indra/newview/viewer.cpp 2007-05-14 16:47:26.000000000 +0200
+++ linden/indra/newview/viewer.cpp 2007-05-22 08:49:50.484375000 +0200
@@ -6302,7 +6326,7 @@

llinfos << "Cleaning Up" << llendflush;

- LLKeyframeMotion::flushKeyframeCache();
+ LLKeyframeMotion::flushKeyframeCache(TRUE);

// Must clean up texture references before viewer window is destroyed.
LLHUDObject::cleanupHUDObjects();
@@ -6562,6 +6586,8 @@
delete gVFS;
gVFS = NULL;

+ LLCurl::cleanup();
+
// This will eventually be done in LLApp
LLCommon::cleanupClass();
}

== Submitting the Patch on JIRA ==

When you are ready for the world to view your patch, submit the patch on the [https://jira.secondlife.com/secure/Dashboard.jspa| JIRA Bug Tracker]. Create a new issue or attach the patch to an existing entry as appropriate. Attach the ''.patch.txt'' file itself as a file attachment and make sure that the check mark for ''Patch attached'' is set (you can do that when creating the issue or by choosing Edit for an existing one). Take a look at existing patches through the ''Issues with patches attached'' filter on the JIRA main page to get a general idea how it is done.

With larger or sensitive patches it is a good idea to submit the patch for peer review on the [[Developer_communication_tools|mailing list]]. This way fellow developers can review the patch, uncover possible bugs, comment on undesired interactions or generally share ideas with you.

Just subscribe to the mailing list, then write an email to the list with a link to the description of what it does in the text.

Also, offer a description of the patch (the why and what) as a separate file and/or as a description or comment with the issue.

Good luck!

== Applying patches to your source ==

In case you are interested, the application of other patches to your source is easy. Assuming that you are at the directory level from where the patch references the files (usually in the folder where you see the '''linden''' folder), applying a patch can be done via:

c:\cygwin\bin\patch -p 0 -i changes.patch

or

c:\cygwin\bin\patch -p 0 < changes.patch

On your first attempts, you might also be interested in the '''--verbose''', '''--backup''' or '''--dry-run''' (simulate patch) options. See '''patch --help''' for details.

c:\cygwin\bin\patch -p 0 --verbose --backup --dry-run -i changes.patch

Also, if a patch fails, look for files ending with '''.rej''' in the target folder.

Preparing Code

2007-09-15T20:27:12Z

Mayera Nagy: /* Creating a Patch */

{{OSWikiContribBox}}

If you have a piece of source code (be it a fix, new feature, or optimization of existing code) submit the patches in a way that makes it easy for the Lindens to incorporate them into the source code.

== Good Patch Practise ==

=== General ===

The best way to think about patches is that the people who are reviewing and applying your patches are the bottleneck in the system. If you can make it easier for us to understand and apply patches without lots of cleanup, we can spend more time reviewing and incorporating your work.

===Before You Start===

Check [https://jira.secondlife.com/secure/Dashboard.jspa| JIRA Bug Tracker] to see if the issue has been submitted and its status.

If you're going to write a patch, don't forget to sign and send in the [http://secondlifegrid.net/programs/open_source/submission contribution agreement]. The sooner you do that, the sooner we can accept your patch.

=== Coding Standard ===

Please read and follow the coding standard: [[Coding_standard|Second Life coding standard]]

=== Comments ===

Please do not add issue numbers or your name to patches. We have to remove these by hand. Also, please be careful in how you add comments. Bracketing a patch with comments like "// PATCH START" and "// PATCH END" does not add any information, and adds to the manual cleanup we have to do.

If you want to make sure you get credited, then
add yourself to doc/contributions.txt as part of the patch. That makes
it easier for people to see the exact nature of the changes you've added.

In short, just add to the patch what is expected to appear in the final source.

=== One Patch for one Issue ===

Each patch should do exactly one thing. If you have three different bugs to fix, please submit three different patches. When you fold unrelated hunks into a single patch, we have to try to figure out which part of the patch applies to which bug, and split it out by hand, sometimes into several patches. Combo patches are particularly time consuming, and the manual splitting up makes it very easy to lose pieces of patches altogether.

=== Less is more ===

Smaller patches are easier to review and therefore more likely to be integrated quickly. The longer it takes for a patch to be incorporated, the higher the likelihood that the underlying code will change enough for the patch to fail. Please do not include formatting or other clean-up changes as that makes it harder to review and more likely to fail.

=== Path structure ===

It is not a must, but if your path structure permits, start the patch on the directory level where the linden folder resides, so that the path/file names in your patch will start with '''linden/'''.

=== Give Yourself Credit! ===

Please don't be shy about adding the issue label to doc/contributions.txt and adding your name. We use this file for a number of purposes, including the generation of the [[Source contributions]] page.

== Creating a Patch ==

Patches should be submitted in unified diff format. This format is similar to simple diffs, but with more detailed information, and it can be automatically integrated into the source. You can generate a unified diff by calling ''diff -u <original file> <new file>'' (under Windows you will find the diff command as part of the CygWin project in C:\CYGWIN\BIN).

Please submit a single plain text uncompressed patch file that affects all of the files you need to modify. This is far easier to review than a collection of tiny one-file patches.

Also bad for reviewability are a compressed patch, or a tarball or zip containing one or more patches.
 
=== Unified diff of all changed files in a folder tree ===
The easiest way to generate a clean patch is to keep two copies of the source tree. Leave one completely unmodified, and make all of your changes in the second. Then use "diff -urN" to generate the patch. You can use the --exclude option to omit unwanted files. For example:

diff -urN --exclude="*.o" my_untouched_tree my_modified_tree
 
=== Unified diff of multiple files ===
If for any reason you can not use a whole tree diff as above, you can still merge patches from different files into one, by appending the output of patch commands to the previous output (via '''>>''' redirection for the 2nd and later commands).

diff -u linden-untouched/indra/newview/viewer.h linden/indra/newview/viewer.h >mychanges.patch.txt
diff -u linden-untouched/indra/newview/viewer.cpp linden/indra/newview/viewer.cpp '''>>'''mychanges.patch.txt
diff -u linden-untouched/indra/newview/llviewerwindow.cpp linden/indra/newview/llviewerwindow.cpp '''>>'''mychanges.patch.txt

 

=== CR/LF vs LF and Whitespace===
In some situations, you will find that the patch contains the whole file, rather than just the lines changed. The reason is that sometimes, files in Linux format find their way into the source distribution. With these diff.exe will treat all lines as different from those in your modified file.

There are various options that will help here. You can add ''--strip-trailing-cr'' to the command line to fix this.

diff -u --strip-trailing-cr linden-untouched/indra/newview/viewer.h linden/indra/newview/viewer.h >mychanges.patch.txt

In some situations try the '''w''' (ignore whitespace) and/or '''B''' (ignore empty lines) options are also helpful (e.g. with tabs vs. space or spurious space characters while editing). Type '''diff --help''' for more details.

 
=== Sample output ===
For reference, here's what a unified diff looks like.

--- linden-untouched/indra/newview/viewer.cpp 2007-05-14 16:47:26.000000000 +0200
+++ linden/indra/newview/viewer.cpp 2007-05-22 08:49:50.484375000 +0200
@@ -6302,7 +6326,7 @@

llinfos << "Cleaning Up" << llendflush;

- LLKeyframeMotion::flushKeyframeCache();
+ LLKeyframeMotion::flushKeyframeCache(TRUE);

// Must clean up texture references before viewer window is destroyed.
LLHUDObject::cleanupHUDObjects();
@@ -6562,6 +6586,8 @@
delete gVFS;
gVFS = NULL;

+ LLCurl::cleanup();
+
// This will eventually be done in LLApp
LLCommon::cleanupClass();
}

== Submitting the Patch on JIRA ==

When you are ready for the world to view your patch, submit the patch on the [https://jira.secondlife.com/secure/Dashboard.jspa| JIRA Bug Tracker]. Create a new issue or attach the patch to an existing entry as appropriate. Attach the ''.patch.txt'' file itself as a file attachment and make sure that the check mark for ''Patch attached'' is set (you can do that when creating the issue or by choosing Edit for an existing one). Take a look at existing patches through the ''Issues with patches attached'' filter on the JIRA main page to get a general idea how it is done.

With larger or sensitive patches it is a good idea to submit the patch for peer review on the [[Developer_communication_tools|mailing list]]. This way fellow developers can review the patch, uncover possible bugs, comment on undesired interactions or generally share ideas with you.

Just subscribe to the mailing list, then write an email to the list with a link to the description of what it does in the text.

Also, offer a description of the patch (the why and what) as a separate file and/or as a description or comment with the issue.

Good luck!

== Applying patches to your source ==

In case you are interested, the application of other patches to your source is easy. Assuming that you are at the directory level from where the patch references the files (usually in the folder where you see the '''linden''' folder), applying a patch can be done via:

c:\cygwin\bin\patch -p 0 -i changes.patch

or

c:\cygwin\bin\patch -p 0 < changes.patch

On your first attempts, you might also be interested in the '''--verbose''', '''--backup''' or '''--dry-run''' (simulate patch) options. See '''patch --help''' for details.

c:\cygwin\bin\patch -p 0 --verbose --backup --dry-run -i changes.patch

Also, if a patch fails, look for files ending with '''.rej''' in the target folder.

Preparing Code

2007-09-15T20:24:42Z

Mayera Nagy: /* Submitting the Patch on JIRA */

{{OSWikiContribBox}}

If you have a piece of source code (be it a fix, new feature, or optimization of existing code) submit the patches in a way that makes it easy for the Lindens to incorporate them into the source code.

== Good Patch Practise ==

=== General ===

The best way to think about patches is that the people who are reviewing and applying your patches are the bottleneck in the system. If you can make it easier for us to understand and apply patches without lots of cleanup, we can spend more time reviewing and incorporating your work.

===Before You Start===

Check [https://jira.secondlife.com/secure/Dashboard.jspa| JIRA Bug Tracker] to see if the issue has been submitted and its status.

If you're going to write a patch, don't forget to sign and send in the [http://secondlifegrid.net/programs/open_source/submission contribution agreement]. The sooner you do that, the sooner we can accept your patch.

=== Coding Standard ===

Please read and follow the coding standard: [[Coding_standard|Second Life coding standard]]

=== Comments ===

Please do not add issue numbers or your name to patches. We have to remove these by hand. Also, please be careful in how you add comments. Bracketing a patch with comments like "// PATCH START" and "// PATCH END" does not add any information, and adds to the manual cleanup we have to do.

If you want to make sure you get credited, then
add yourself to doc/contributions.txt as part of the patch. That makes
it easier for people to see the exact nature of the changes you've added.

In short, just add to the patch what is expected to appear in the final source.

=== One Patch for one Issue ===

Each patch should do exactly one thing. If you have three different bugs to fix, please submit three different patches. When you fold unrelated hunks into a single patch, we have to try to figure out which part of the patch applies to which bug, and split it out by hand, sometimes into several patches. Combo patches are particularly time consuming, and the manual splitting up makes it very easy to lose pieces of patches altogether.

=== Less is more ===

Smaller patches are easier to review and therefore more likely to be integrated quickly. The longer it takes for a patch to be incorporated, the higher the likelihood that the underlying code will change enough for the patch to fail. Please do not include formatting or other clean-up changes as that makes it harder to review and more likely to fail.

=== Path structure ===

It is not a must, but if your path structure permits, start the patch on the directory level where the linden folder resides, so that the path/file names in your patch will start with '''linden/'''.

=== Give Yourself Credit! ===

Please don't be shy about adding the issue label to doc/contributions.txt and adding your name. We use this file for a number of purposes, including the generation of the [[Source contributions]] page.

== Creating a Patch ==

Patches should be submitted in unified diff format. This format is similar to simple diffs, but with more detailed information, and it can be automatically integrated into the source. You can generate a unified diff by calling ''diff -u <original file> <new file>'' (under Windows you will find the diff command as part of the CygWin project in C:\CYGWIN\BIN).

Please submit a single plain text uncompressed patch file that affects all of the files you need to modify. This is far easier to review than a collection of tiny one-file patches.

Also bad for reviewability are a compressed patch, or a tarball or zip containing one or more patches.
 
=== Unified diff of all changed files in a folder tree ===
The easiest way to generate a clean patch is to keep two copies of the source tree. Leave one completely unmodified, and make all of your changes in the second. Then use "diff -urN" to generate the patch. You can use the --exclude option to omit unwanted files. For example:

diff -urN --exclude="*.o" my_untouched_tree my_modified_tree
 

=== Unified diff of multiple files ===
If for any reason you can not use a whole tree diff as above, you can still merge patches from different files into one, by appending the output of patch commands to the previous output (via '''>>''' redirection for the 2nd and later commands).

diff -u linden-untouched/indra/newview/viewer.h linden/indra/newview/viewer.h >mychanges.patch.txt
diff -u linden-untouched/indra/newview/viewer.cpp linden/indra/newview/viewer.cpp '''>>'''mychanges.patch.txt
diff -u linden-untouched/indra/newview/llviewerwindow.cpp linden/indra/newview/llviewerwindow.cpp '''>>'''mychanges.patch.txt

 

=== CR/LF vs LF and Whitespace===
In some situations, you will find that the patch contains the whole file, rather than just the lines changed. The reason is that sometimes, files in Linux format find their way into the source distribution. With these diff.exe will treat all lines as different from those in your modified file.

There are various options that will help here. You can add ''--strip-trailing-cr'' to the command line to fix this.

diff -u --strip-trailing-cr linden-untouched/indra/newview/viewer.h linden/indra/newview/viewer.h >mychanges.patch.txt

In some situations try the '''w''' (ignore whitespace) and/or '''B''' (ignore empty lines) options are also helpful (e.g. with tabs vs. space or spurious space characters while editing). Type '''diff --help''' for more details.

 

=== Sample output ===
For reference, here's what a unified diff looks like.

--- linden-untouched/indra/newview/viewer.cpp 2007-05-14 16:47:26.000000000 +0200
+++ linden/indra/newview/viewer.cpp 2007-05-22 08:49:50.484375000 +0200
@@ -6302,7 +6326,7 @@

llinfos << "Cleaning Up" << llendflush;

- LLKeyframeMotion::flushKeyframeCache();
+ LLKeyframeMotion::flushKeyframeCache(TRUE);

// Must clean up texture references before viewer window is destroyed.
LLHUDObject::cleanupHUDObjects();
@@ -6562,6 +6586,8 @@
delete gVFS;
gVFS = NULL;

+ LLCurl::cleanup();
+
// This will eventually be done in LLApp
LLCommon::cleanupClass();
}

== Submitting the Patch on JIRA ==

When you are ready for the world to view your patch, submit the patch on the [https://jira.secondlife.com/secure/Dashboard.jspa| JIRA Bug Tracker]. Create a new issue or attach the patch to an existing entry as appropriate. Attach the ''.patch.txt'' file itself as a file attachment and make sure that the check mark for ''Patch attached'' is set (you can do that when creating the issue or by choosing Edit for an existing one). Take a look at existing patches through the ''Issues with patches attached'' filter on the JIRA main page to get a general idea how it is done.

With larger or sensitive patches it is a good idea to submit the patch for peer review on the [[Developer_communication_tools|mailing list]]. This way fellow developers can review the patch, uncover possible bugs, comment on undesired interactions or generally share ideas with you.

Just subscribe to the mailing list, then write an email to the list with a link to the description of what it does in the text.

Also, offer a description of the patch (the why and what) as a separate file and/or as a description or comment with the issue.

Good luck!

== Applying patches to your source ==

In case you are interested, the application of other patches to your source is easy. Assuming that you are at the directory level from where the patch references the files (usually in the folder where you see the '''linden''' folder), applying a patch can be done via:

c:\cygwin\bin\patch -p 0 -i changes.patch

or

c:\cygwin\bin\patch -p 0 < changes.patch

On your first attempts, you might also be interested in the '''--verbose''', '''--backup''' or '''--dry-run''' (simulate patch) options. See '''patch --help''' for details.

c:\cygwin\bin\patch -p 0 --verbose --backup --dry-run -i changes.patch

Also, if a patch fails, look for files ending with '''.rej''' in the target folder.

Preparing Code

2007-09-15T20:24:31Z

Mayera Nagy: /* CR/LF vs LF and Whitespace */

{{OSWikiContribBox}}

If you have a piece of source code (be it a fix, new feature, or optimization of existing code) submit the patches in a way that makes it easy for the Lindens to incorporate them into the source code.

== Good Patch Practise ==

=== General ===

The best way to think about patches is that the people who are reviewing and applying your patches are the bottleneck in the system. If you can make it easier for us to understand and apply patches without lots of cleanup, we can spend more time reviewing and incorporating your work.

===Before You Start===

Check [https://jira.secondlife.com/secure/Dashboard.jspa| JIRA Bug Tracker] to see if the issue has been submitted and its status.

If you're going to write a patch, don't forget to sign and send in the [http://secondlifegrid.net/programs/open_source/submission contribution agreement]. The sooner you do that, the sooner we can accept your patch.

=== Coding Standard ===

Please read and follow the coding standard: [[Coding_standard|Second Life coding standard]]

=== Comments ===

Please do not add issue numbers or your name to patches. We have to remove these by hand. Also, please be careful in how you add comments. Bracketing a patch with comments like "// PATCH START" and "// PATCH END" does not add any information, and adds to the manual cleanup we have to do.

If you want to make sure you get credited, then
add yourself to doc/contributions.txt as part of the patch. That makes
it easier for people to see the exact nature of the changes you've added.

In short, just add to the patch what is expected to appear in the final source.

=== One Patch for one Issue ===

Each patch should do exactly one thing. If you have three different bugs to fix, please submit three different patches. When you fold unrelated hunks into a single patch, we have to try to figure out which part of the patch applies to which bug, and split it out by hand, sometimes into several patches. Combo patches are particularly time consuming, and the manual splitting up makes it very easy to lose pieces of patches altogether.

=== Less is more ===

Smaller patches are easier to review and therefore more likely to be integrated quickly. The longer it takes for a patch to be incorporated, the higher the likelihood that the underlying code will change enough for the patch to fail. Please do not include formatting or other clean-up changes as that makes it harder to review and more likely to fail.

=== Path structure ===

It is not a must, but if your path structure permits, start the patch on the directory level where the linden folder resides, so that the path/file names in your patch will start with '''linden/'''.

=== Give Yourself Credit! ===

Please don't be shy about adding the issue label to doc/contributions.txt and adding your name. We use this file for a number of purposes, including the generation of the [[Source contributions]] page.

== Creating a Patch ==

Patches should be submitted in unified diff format. This format is similar to simple diffs, but with more detailed information, and it can be automatically integrated into the source. You can generate a unified diff by calling ''diff -u <original file> <new file>'' (under Windows you will find the diff command as part of the CygWin project in C:\CYGWIN\BIN).

Please submit a single plain text uncompressed patch file that affects all of the files you need to modify. This is far easier to review than a collection of tiny one-file patches.

Also bad for reviewability are a compressed patch, or a tarball or zip containing one or more patches.
 
=== Unified diff of all changed files in a folder tree ===
The easiest way to generate a clean patch is to keep two copies of the source tree. Leave one completely unmodified, and make all of your changes in the second. Then use "diff -urN" to generate the patch. You can use the --exclude option to omit unwanted files. For example:

diff -urN --exclude="*.o" my_untouched_tree my_modified_tree
 

=== Unified diff of multiple files ===
If for any reason you can not use a whole tree diff as above, you can still merge patches from different files into one, by appending the output of patch commands to the previous output (via '''>>''' redirection for the 2nd and later commands).

diff -u linden-untouched/indra/newview/viewer.h linden/indra/newview/viewer.h >mychanges.patch.txt
diff -u linden-untouched/indra/newview/viewer.cpp linden/indra/newview/viewer.cpp '''>>'''mychanges.patch.txt
diff -u linden-untouched/indra/newview/llviewerwindow.cpp linden/indra/newview/llviewerwindow.cpp '''>>'''mychanges.patch.txt

 

=== CR/LF vs LF and Whitespace===
In some situations, you will find that the patch contains the whole file, rather than just the lines changed. The reason is that sometimes, files in Linux format find their way into the source distribution. With these diff.exe will treat all lines as different from those in your modified file.

There are various options that will help here. You can add ''--strip-trailing-cr'' to the command line to fix this.

diff -u --strip-trailing-cr linden-untouched/indra/newview/viewer.h linden/indra/newview/viewer.h >mychanges.patch.txt

In some situations try the '''w''' (ignore whitespace) and/or '''B''' (ignore empty lines) options are also helpful (e.g. with tabs vs. space or spurious space characters while editing). Type '''diff --help''' for more details.

 

=== Sample output ===
For reference, here's what a unified diff looks like.

--- linden-untouched/indra/newview/viewer.cpp 2007-05-14 16:47:26.000000000 +0200
+++ linden/indra/newview/viewer.cpp 2007-05-22 08:49:50.484375000 +0200
@@ -6302,7 +6326,7 @@

llinfos << "Cleaning Up" << llendflush;

- LLKeyframeMotion::flushKeyframeCache();
+ LLKeyframeMotion::flushKeyframeCache(TRUE);

// Must clean up texture references before viewer window is destroyed.
LLHUDObject::cleanupHUDObjects();
@@ -6562,6 +6586,8 @@
delete gVFS;
gVFS = NULL;

+ LLCurl::cleanup();
+
// This will eventually be done in LLApp
LLCommon::cleanupClass();
}

== Submitting the Patch on JIRA ==

When you are ready for the world to view your patch, submit the patch on the [https://jira.secondlife.com/secure/Dashboard.jspa| JIRA Bug Tracker]. Create a new issue or attach the patch to an existing entry as appropriate. Attach the ''.patch.txt'' file itself as a file attachment and make sure that the check mark for ''Patch attached'' is set (you can do that when creating the issue or by choosing Edit for an existing one). Take a look at existing patches through the ''Issues with patches attached'' filter on the JIRA main page to get a general idea how it is done.

With larger or sensitive patches it is a good idea to submit the patch for peer review on the [[Developer_communication_tools|mailing list]]. This way fellow developers can review the patch, uncover possible bugs, comment on undesired interactions or generally share ideas with you.

Just subscribe to the mailing list, then write an email to the list with a link to the description of what it does in the text.

Also, offer a description of the patch (the why and what) as a separate file and/or as a description or comment with the issue.

Good luck!

== Applying patches to your source ==

In case you are interested, the application of other patches to your source is easy. Assuming that you are at the directory level from where the patch references the files (usually in the folder where you see the '''linden''' folder), applying a patch can be done via:

c:\cygwin\bin\patch -p 0 -i changes.patch

or

c:\cygwin\bin\patch -p 0 < changes.patch

On your first attempts, you might also be interested in the '''--verbose''', '''--backup''' or '''--dry-run''' (simulate patch) options. See '''patch --help''' for details.

c:\cygwin\bin\patch -p 0 --verbose --backup --dry-run -i changes.patch

Also, if a patch fails, look for files ending with '''.rej''' in the target folder.

Help talk:Contents

2007-09-09T22:22:48Z

Mayera Nagy: Help talk:Contents moved to Help talk:Mayera nagy: Cause i don,t know what i have to do for can be talking thanks

== Copy from MediaWiki ==

Rather than just copy and paste the MediaWiki help files (in the public domain) we should also modify them to be more descriptive to users who have not used the syntax extensively. --[[User:TxMasterG Ping|TxMasterG Ping]] 15:10, 16 April 2007 (PDT)

== Listing the Templates ==

There are many more templates than just those noted at the bottom of the page. Should we included All(Special:Prefixindex&from=&namespace=10) of them? Should we include only those that are used? What should we do? --[[User:TxMasterG Ping|TxMasterG Ping]] 15:15, 16 April 2007 (PDT)

== LSL Template ==

We really need a way to highlight LSL syntax. Currently scripts are formatted in a small, dark hard to read format. We need a template or format to enable coloring as in the wiki posted at http://rpgstats.com/