Difference between revisions of "Channel and Version Requirements"

Latest revision as of 07:02, 9 August 2013

Setting a Viewer Identifier for an Open Source Viewer

A Viewer Identifier is unique to a particular release of a viewer. It is composed of two parts: the Viewer Channel Name and the Version Number.

Viewer Channel Name

The Viewer Channel Name should be a unique base name for your viewer, optionally combined with a variant name (typically used to distinguish the type of build). Linden Lab viewer builds use:

Second Life

as the base name, followed by either

Release: for release builds
Beta project-name: for early release user test builds
Project project-name: for integration builds (which may or may not be publicly available)
Test: for developer builds

The default Version Name is Second Life Test

NOTE: Any Channel Name containing "Second Life" is reserved for use by Linden Lab (if you are building a test version for submission to Linden Lab, there is no need to change this)

The Channel Name can be any ASCII string. It should not violate Linden Lab's trademark policy. We recommend that the Channel Name be the name of the Open Source Viewer.

To set the channel name, set the cmake variable on the autobuild command line:

autobuild configure -- -DVIEWER_CHANNEL='"channel"'

or

autobuild configure -- -DVIEWER_CHANNEL="\"channel\""

Version Number

The Version Number is in the form major.minor.patch.build: any four numbers, separated by periods.

We recommend using the Major and Minor numbers from the most recently merged Linden Lab source code.

The 4 numbers together should uniquely identify a version of the sources from which the viewer was built; Linden Lab uses an internal number from our build farm system for the Build number to ensure uniqueness.

To change the first three elements of the version number, edit the file indra/newview/VIEWER_VERSION.txt

To set the revision, set the revision environment variable. If that variable is not set, the indra/cmake/BuildVersion.cmake file will attempt to get the local revision number from your Mercurial working copy (which will not change for any changes that have not yet been committed), or if that is not found then it will use 0.

Updating an Open Source Viewer

Anyone distributing an Open Source version of the Viewer is responsible for messaging updates to residents using that client.
We recommend using your login url for directing residents to updates.
Clients not based on the Linden viewer code base should ensure that the XMLRPC login connection sends:
- channel = the channel name, e.g. "My Viewer"
- version = a four-part version, e.g. "1.2.3.4"

Linden Lab Updates

Linden Lab updates will not affect non Linden Lab channels. This includes optional and mandatory updates. It is the responsibility of other distributors to ensure that security patches are provided to residents using their client.
NOTE: If Linden Lab determines that a particular client distribution contains security vulnerabilities or exploits, Linden Lab may block that particular version of the client from logging in.
NOTE: If Linden Lab introduces a server update that requires a particular capability in order to connect to the server, Viewers that do not include the required capability will be unable to connect to regions running that version of the server. It is the intention of Linden Lab to make these required updates infrequent, and to make the Viewer code available well in advance of the server update.

@@ Line 1: / Line 1: @@
 == Setting a Viewer Identifier for an Open Source Viewer ==
-A Viewer Identifier is unique to a particular release of a viewer. It is composed of three parts: the Version Name, the Version Variant, and the Version Number. The combination of the Version Name and the Version Variant form the Channel Name.
+A Viewer Identifier is unique to a particular release of a viewer. It is composed of two parts: the Viewer Channel Name and the Version Number.
-. Choose a Version Name
+=== Viewer Channel Name===
-* The default Version Name is "Second Life"
+The Viewer Channel Name should be a unique base name for your viewer, optionally combined with a variant name (typically used to distinguish the type of build).  Linden Lab viewer builds use:
-. Choose a Version Variant. The default variant is "Developer"
+;Second Life
-* The combination of the Name and Variant should be combined to make the Channel Name.
+:as the base name, followed by either
-* The default Channel Name is "Second Life Developer"
+:;Release
-* Other standard Linden Lab Channel Names are "Second Life Release" and "Second Life Beta Viewer". Please note that any Channel Name containing "Second Life" is reserved for use by Linden Lab (but if you are building a test version for submission to Linden Lab, there is no need to change this).
+::for release builds
-* The Channel Name can be any ASCII string. It should not violate [http://secondlife.com/corporate/brand/trademark/ Linden Lab's trademark policy]. We recommend that the Channel Name be the name of the Open Source Viewer.
+:;Beta ''project-name''
-. Choose a Version Number
+::for early release user test builds
-* The Version Number is in the form Major.Minor.Patch.Build
+:;Project ''project-name''
-* The Version Number can be any four numbers, separated by periods.
+::for integration builds (which may or may not be publicly available)
+:;Test
+::for developer builds
+:The default Version Name is '''Second Life Test'''
+{{Note|Any Channel Name containing "Second Life" is reserved for use by Linden Lab (if you are building a test version for submission to Linden Lab, there is no need to change this)}}
+The Channel Name can be any ASCII string. It should not violate [http://secondlife.com/corporate/brand/trademark/ Linden Lab's trademark policy]. We recommend that the Channel Name be the name of the Open Source Viewer.
+To set the channel name, set the cmake variable on the autobuild command line:
+ autobuild configure -- -DVIEWER_CHANNEL='"''channel''"'
+or
+ autobuild configure -- -DVIEWER_CHANNEL="\"''channel''\""
+===Version Number===
+The Version Number is in the form ''major''.''minor''.''patch''.''build'': any four numbers, separated by periods.
 * We recommend using the Major and Minor numbers from the most recently merged Linden Lab source code.
-** Linden Lab uses an internal number from our source control system for the Build number.
-* The 4 numbers together should uniquely identify a version of the sources from which the viewer was built, and should lexically sort into the order in which they were built (for example, you should use leading zeros for any level that might be more than one number)
-. Set the Channel and Version in the code
-* Edit indra/llcommon/llversionviewer.h
-** Modify LL_CHANNEL with the Channel Name
-** Modify LL_VERSION_BUILD with the appropriate build number
-* Update the Version Number in the following files:
-** indra/newview/res/newViewRes.rc - ''"FileVersion" and "ProductVersion" in the Version section''
-** indra/newview/Info-SecondLife.plist - ''CFBundleVersion''
-** indra/newview/English.lproj/InfoPlist.strings - ''CFBundleShortVersionString''
-* Build the code
-== Packaging for Distribution ==
+The 4 numbers together should uniquely identify a version of the sources from which the viewer was built; Linden Lab uses an internal number from our build farm system for the Build number to ensure uniqueness.
-* From the indra/newview directory run viewer_manifest.py with the following arguments:
-** viewer_manifest.py --login_url=http://your.login.url.com
+'''To change the first three elements of the version number, edit the file <tt>indra/newview/VIEWER_VERSION.txt</tt>'''
-* See http://wiki.secondlife.com/wiki/Viewer_Manifest for more information on packaging the Viewer
+To set the revision, set the <tt>revision</tt> environment variable.  If that variable is not set, the <tt>indra/cmake/BuildVersion.cmake</tt> file will attempt to get the local revision number from your Mercurial working copy (which will not change for any changes that have not yet been committed), or if that is not found then it will use 0.
 == Updating an Open Source Viewer ==
@@ Line 35: / Line 39: @@
 * Clients not based on the Linden viewer code base should ensure that the XMLRPC login connection sends:
 ** channel = the channel name, e.g. "My Viewer"
-** version = the channel name and a four-part version, e.g. "My Viewer 1.2.3.4"
+** version = a four-part version, e.g. "1.2.3.4"
 == Linden Lab Updates ==
@@ Line 41: / Line 45: @@
 * '''NOTE: If Linden Lab determines that a particular client distribution contains security vulnerabilities or exploits, Linden Lab may block that particular version of the client from logging in.'''
 * '''NOTE: If Linden Lab introduces a server update that requires a particular capability in order to connect to the server, Viewers that do not include the required capability will be unable to connect to ''regions running that version of the server.''''' It is the intention of Linden Lab to make these required updates infrequent, and to make the Viewer code available well in advance of the server update.
+[[Category:Open Source Portal]]