Difference between revisions of "Get source and compile"

Revision as of 10:12, 1 May 2015

This information is for people who want to work with the source code for the viewer.

Project Snowstorm

This is the latest Viewer code. Viewer code is stored in a Mercurial (hg) repository on bitbucket, an Open Source repository web site. There are many versions there; the one you are most likely interested in being

Viewer Release

Other repositories where development for future features can be seen are listed on the Viewer Source Repositories page.

Another good way to browse the source code, including UML diagrams, is using the Doxygen pages.

Be sure to read Creating a version control repository.

Version Control

Viewer development uses the Mercurial (hg) distributed version control system. To clone the current release repository, use:

hg clone http://bitbucket.org/lindenlab/viewer-release

You are strongly encouraged to install the Linden Lab Mercurial Tools as well.

For a step-by-step outline of the source control workflow from the initial clone (above) to integration of your change, see Steps To Submit a Change.

Compiling

Per platform instructions are available in these topics:

Notes

Common compilation problems if you run into errors while building.
Improving compilation time for information on how to compile faster
LLMozLib2 for building LLMozLib2.

Autobuild

Autobuild is the new Linden Lab framework to maintain and build everything, from viewer to 3rd party libraries.

Instructions:

Channels and Versions

Channels are just groupings of versions. Linden Lab uses channels to track and supply updates for Project, Beta, and Release Viewers separately.

On login, the combination of channel plus version is checked against a set of rules in the Viewer Version Management service. Within each channel, some versions are allowed and some are blocked. Viewers are blocked if they are too old, are unsafe (security issues), incompatible (the protocol has been changed in some fundamental way), or are a test version and Linden Lab only wants data from the most recent. See Viewer Integration and Release Processes for an explanation of how different versions are managed by Linden Lab.

If you are building a viewer, the Policy on Third Party Viewers requires that you set your own channel name.

See:

Channel and Version Requirements: a detailed explanation and official policy on channels and versions in Second Life, and an explanation of how to set your channel name when building.

@@ Line 1: / Line 1: @@
-{{multi-lang}}
+{{multi-lang|Get source and compile|pt}}
 {{OSWikiContribBox}}
-Even if you don't plan to develop, just the act of downloading and compiling can uncover problems. If the version you download doesn't build on your platform, file a bug.
+This information is for people who want to work with the source code for the viewer.
-== Getting the source ==
+==Project Snowstorm==
-=== Download Source Archives (Zipfile/Tarball) ===
+This is the latest Viewer code.
+Viewer code is stored in a Mercurial (hg) repository on [https://bitbucket.org/lindenlab bitbucket], an  Open Source repository web site.  There are many versions there; the one you are most likely interested in being
-Linden Lab provides current and past downloads in an archived format, see the [[source downloads]] page.  Be sure to get all three: source, artwork, and libraries.
+* [https://bitbucket.org/lindenlab/viewer-release Viewer Release]
+Other repositories where development for future features can be seen are listed on the [[Linden Lab Official:Viewer Source Repositories|Viewer Source Repositories]] page.
+Another good way to browse the source code, including UML diagrams,  is using the [http://lecs.opensource.secondlife.com/doxygen/index.html Doxygen pages].
+Be sure to read [[Creating a version control repository]].
 === Version Control ===
-Linden Lab maintains a version control repository containing various (experimental) branches.
+Viewer development uses the Mercurial (hg) distributed version control system.  To clone the current release repository, use:
-See the [[version control repository]] page for the correct repository url.
-Subsequently, if you are using a command line, you could check out the source code with
+  <nowiki>hg clone http://bitbucket.org/lindenlab/viewer-release</nowiki>
-  svn checkout '''repository-url''' '''target-directory'''
-For example to checkout snowglobe 1.4:
+You are strongly encouraged to install the [[Mercurial Tools|Linden Lab Mercurial Tools]] as well.
- svn checkout <nowiki>https://svn.secondlife.com/svn/linden/projects/2009/snowglobe/trunk</nowiki> snowglobe-1.x-svn
+For a step-by-step outline of the source control workflow from the initial clone (above) to integration of your change, see [[Develop Viewer Code#Steps To Submit a Change|Steps To Submit a Change]].
 == Compiling ==
 Per platform instructions are available in these topics:
-* [[Microsoft Windows Builds|Microsoft Windows]]
+* [[Visual Studio 2013 Viewer Builds|Windows]]
-* [[Compiling the viewer (Mac OS X)|Mac OS X]]
+* [[Compiling the viewer (Mac OS X XCode 6.1)|Mac OS X]]
 * [[Compiling the viewer (Linux)|Linux]]
-* [[Viewer 2 Microsoft Windows Builds|Viewer 2 Microsoft Windows Builds - under construction]]
 === Notes ===
@@ Line 35: / Line 40: @@
 *  [[LLMozLib2]] for building LLMozLib2.
-== Hints on running ==
+=== Autobuild ===
+[[Autobuild]] is the new Linden Lab framework to maintain and build everything, from viewer to 3rd party libraries.
-=== Channels and Versions ===
-Channels are just groupings of versions. Linden Lab uses channels to track and supply updates for First Look viewers separately from Release and Release Candidate viewers.
+Instructions:
+* [[Build Viewer With Autobuild]]
+* [[Build_3rd_Party_lib_with_Autobuild]]
-If you get a message while trying to start your compiled viewer that there is a required update, don't panic.  All of your work is not lost.  You (usually) don't have to apply your changes to a new source release to test your code.  That's where channels come in.
+== Channels and Versions ==
-On login, the combination of channel plus version is checked against a list. Within each channel, some versions are allowed and some are blocked. Viewers are blocked that are unsafe (security issues),
+Channels are just groupings of versions. Linden Lab uses channels to track and supply updates for Project, Beta, and Release Viewers separately.
-incompatible (the protocol has been changed in some fundamental way), not
-supported (so old Linden Lab can't afford to provide support resources), or
-(most relevant here) are in a test channel (Release Candidate, First
-Look) and Linden Lab only wants test data from the most recent.
-See [[Channel_and_Version_Requirements#Setting_a_Channel_and_Version_for_an_Open_Source_Viewer | Setting a Channel and Version for an Open Source Viewer]] for an explanation of how to do it in the source code.
+On login, the combination of channel plus version is checked against a set of rules in the Viewer Version Management service. Within each channel, some versions are allowed and some are blocked. Viewers are blocked if they are too old, are unsafe (security issues),
+incompatible (the protocol has been changed in some fundamental way), or
+are a test version and Linden Lab only wants data from the most recent.  See [[Viewer Integration and Release Processes]] for an explanation of how different versions are managed by Linden Lab.
-See [[Channel and Version Requirements]] for a detailed explanation and official policy on how Linden Lab deals with channels and versions in Second Life.
+'''If you are building a viewer, the [http://secondlife.com/corporate/tpv.php Policy on Third Party Viewers] requires that you set your own channel name.'''
-The Third Party Viewer Policy requires that all viewers use a unique channel name.  Please see [http://secondlife.com/corporate/tpv.php here] for more information.
+See:
+:;[[Channel and Version Requirements]]
+::a detailed explanation and official policy on channels and versions in Second Life, and an explanation of how to set your channel name when building.
 [[Category:Compiling viewer]]