Difference between revisions of "Get source and compile"
Lynda Devin (talk | contribs) |
Rand Linden (talk | contribs) |
||
Line 2: | Line 2: | ||
{{OSWikiContribBox}} | {{OSWikiContribBox}} | ||
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 [https://bitbucket.org/lindenlab bitbucket], an Open Source repository web site. There are many versions there; the ones you are most likely interested in being | |||
* [ | * [https://bitbucket.org/lindenlab/viewer-release Viewer Release] | ||
* [ | * [https://bitbucket.org/lindenlab/viewer-beta Viewer Beta] | ||
* [ | * [https://bitbucket.org/lindenlab/viewer-development The latest developer test builds] | ||
You can browse the source code using an ordinary web browser, download it to your machine, or use Mercurial to manage the process for you. | |||
One of the interesting features of the Viewer-Development branch is that you can literally watch Lindens merging bug fixes and new features into the code before your very eyes. | |||
Another good way to browse the source code, including UML diagrams, is using [http://dimentox.com/snowstorm/ Doxygen]. | |||
Be sure to read [[Creating a version control repository]]. | |||
=== | === Version Control === | ||
hg clone | Viewer development uses the Mercurial (hg) distributed version control system. To clone the current primary development repository, use: | ||
<nowiki>hg clone http://hg.secondlife.com/viewer-development</nowiki> | |||
You are strongly encouraged to install the [[Mercurial Tools|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 [[Develop Viewer Code#Steps To Submit a Change|Steps To Submit a Change]]. | |||
== Compiling == | |||
Per platform instructions are available in these topics: | |||
* [[Viewer 2 Microsoft Windows Builds|Windows]] | * [[Viewer 2 Microsoft Windows Builds|Windows]] | ||
* [[Compiling the viewer (Mac OS X)|Mac OS X]] | * [[Compiling the viewer (Mac OS X)|Mac OS X]] | ||
* [[Compiling the viewer (Linux)|Linux]] | * [[Compiling the viewer (Linux)|Linux]] | ||
=== | === Notes === | ||
* [[Common compilation problems]] | * [[Common compilation problems]] if you run into errors while building. | ||
* [[Improving compilation time]] | * [[Improving compilation time]] for information on how to compile faster | ||
* [[LLMozLib2]] | * [[LLMozLib2]] for building LLMozLib2. | ||
=== | === Autobuild === | ||
[[Autobuild]] | [[Autobuild]] is the new Linden Lab framework to maintain and build everything, from viewer to 3rd party libraries. | ||
Instructions: | |||
* [[Build Viewer With Autobuild]] | * [[Build Viewer With Autobuild]] | ||
* [[Build_3rd_Party_lib_with_Autobuild]] | * [[Build_3rd_Party_lib_with_Autobuild]] | ||
== | == Hints on running == | ||
=== | === 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. | |||
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. | |||
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), | |||
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. | |||
See [[Channel and Version Requirements]] for a detailed explanation and official policy on how Linden Lab deals with channels and versions in Second Life. | |||
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. | |||
[[ | [[Category:Compiling viewer]] |
Revision as of 09:11, 22 November 2011
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 ones you are most likely interested in being
You can browse the source code using an ordinary web browser, download it to your machine, or use Mercurial to manage the process for you.
One of the interesting features of the Viewer-Development branch is that you can literally watch Lindens merging bug fixes and new features into the code before your very eyes.
Another good way to browse the source code, including UML diagrams, is using Doxygen.
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 primary development repository, use:
hg clone http://hg.secondlife.com/viewer-development
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:
Hints on running
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.
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.
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), 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 Setting a Channel and Version for an Open Source Viewer for an explanation of how to do it in the source code.
See Channel and Version Requirements for a detailed explanation and official policy on how Linden Lab deals with channels and versions in Second Life.
The Third Party Viewer Policy requires that all viewers use a unique channel name. Please see here for more information.