[edit] WARNING: This is the _old_ Lustre wiki, and it is in the process of being retired. The information found here is all likely to be out of date. Please search the new wiki for more up to date information.

Accessing Lustre Code

From Obsolete Lustre Wiki
(Difference between revisions)
Jump to: navigation, search
(Remove description of non-existent external CVS repository)
(Naming conventions)
 
(42 intermediate revisions by 3 users not shown)
Line 1: Line 1:
We welcome and encourage contributions to the development and testing of a more robust, feature-rich Lustre. Three options are available for accessing Lustre code:
+
<small>''(Updated: Jan 2010)''</small>
* ''Anonymous access''. You can obtain Lustre source code by [[#Accessing the Open CVS repository|Accessing the Open CVS repository]]. When using this option, you will have read-only access to the code. See [[Contribution Landing Page]] for how to submit code.
+
  
* ''Authorized access''. Obtaining Lustre source code by [[#Accessing the Internal Lustre CVS repository|Accessing the Internal Lustre CVS repository]] requires a password-protected account and authorization from Sun Microsystems.
+
'''''NOTICE:'''''  The transition from CVS to Git took place on Monday, December 14. For more information about the transition, see the [[Git Transition Notice]]. For details about how to migrate to Git, see [[Migrating to Git]].
  
For all these options, the Concurrent Versions System (CVS) must be installed on your local system. For more information about CVS, see [http://www.nongnu.org/cvs CVS - Concurrent Versions System].
+
----
  
'''''Note:''''' If you have questions or experience problems with using any of these options, send email to the [mailto:lustre-wiki-feedback@sun.com CVS Administrator].
+
We welcome and encourage contributions to the development and testing of a more robust, feature-rich Lustre™. You can obtain the latest bleeding-edge Lustre source code by anonymous Git access.
  
=== Naming conventions ===
+
git clone git://git.lustre.org/prime/lustre.git
  
Stable development branches are named b''{major}''_''{minor}'' (for example, b1_6 and b1_8). Even-numbered minor releases are considered stable releases. Odd-numbered minor releases correspond to alpha and beta releases and will sometimes be given v''{major}''_''{minor}''_''{patch}'' tags to provide a point of reference for internal and external testing.
+
'''''Note:''''' For more information about using Git, including tutorials and guides to help you get started, see the [http://git-scm.com/documentation Git documentation] page. ''For descriptions of the commands you are most likely to need, see the Commands section  at the bottom of this page.''
  
A release branch is created an official release to isolate it from further development and named b_release_''{major}''_''{minor}''_''{patch}'' (for example, b_release_1_8_0).  A final release gets a tag in the form v''{major}''_''{minor}''_''{patch}'' (for example, v1_8_0 or v1_6_7_1).
+
See [[Contribute]] for more information about developing, testing, and submitting a patch to the Lustre code.
  
Long-range development is done on the HEAD branch.
+
'''''Note:''''' If you have questions or experience problems, send email to the [mailto:lustre-wiki-feedback@sun.com Admins].
  
=== Lustre Modules ===
+
For more information about Git, see the [http://git-scm.com/ Git home]
  
These Lustre modules are needed to build Lustre. They are automatically checked out when the ''lustrecvs'' script is run for specified a Lustre branch or tag, such as HEAD, b1_8, or v1_8_1:
+
=== Naming conventions ===
*lustre (top-level directory)
+
*ldiskfs (at lustre/ldiskfs)
+
*libsysio (at lustre/libsysio)
+
*lnet (at lustre/lnet)
+
*libcfs (at lustre/libcfs)
+
*lustre-build (at lustre/build)
+
*lustre-core (at lustre/lustre)
+
*lustre-snmp (at lustre/snmp)
+
  
See the following sections for details.
+
Stable development branches are named b''{major}''_''{minor}'' (for example, b1_6 and b1_8). Even-numbered minor releases are considered stable releases.  Odd-numbered minor releases correspond to alpha and beta releases and will sometimes be given v''{major}''_''{minor}''_''{patch}'' tags to provide a point of reference for internal and external testing. 
  
== Accessing the Open CVS repository ==
+
A release branch is created an official release to isolate it from further development and named b_release_''{major}''_''{minor}''_''{patch}'' (for example, b_release_1_8_0).  A final release gets a tag in the form v''{major}''_''{minor}''_''{patch}'' (for example, v1_8_0 or v1_6_7_1).
The Open CVS repository allows anonymous, read-only access to the Lustre code. See [[Contribution Landing Page]] for more information about submitting a patch to the Lustre code.
+
 
+
=== Checking out code from Open CVS ===
+
To check out Lustre source code from the Open CVS repository, complete these steps.  The Open CVS repository is used for public access to Lustre, and is synced from the internal CVS repository several times a day.
+
 
+
#.  Set CVSROOT in your environment by entering one of these commands:
+
export CVSROOT=":pserver:anonymous@cvs.lustre.org:/lustre"
+
:or
+
cvs -d :pserver:anonymous@cvs.lustre.org:/lustre login
+
 
+
No password is needed.
+
 
+
#.  Check out the lustre source.
+
cvs co lustre
+
 
+
#.  Check out lustre modules.
+
cd lustre
+
./lustrecvs b1_8
+
:In this example, modules for Release 1.8 are checked out.
+
 
+
=== Example ===
+
In this example, Lustre sources are checked out into ''~/src/lustre-1_8''.  This directory can be called anything, and will default to "lustre" if nothing is specified.
+
 
+
<code>
+
user@host:~$ '''cd src'''
+
user@host:~src$ '''cvs -d :pserver:anonymous@cvs.lustre.org:/lustre login'''
+
Logging in to :pserver:anonymous@cvs.lustre.org:2401/lustre
+
CVS password:      <font color="red">''(Leave blank, hit <Enter>)''</font>
+
</code>
+
<code>
+
user@host:~/src$ '''cvs -d :pserver:anonymous@cvs.lustre.org:/lustre co -d lustre-1_8 lustre'''
+
  cvs checkout: Updating lustre
+
U lustre/.cvsignore
+
U lustre/COPYING
+
U lustre/ChangeLog
+
U lustre/Makefile.in
+
U lustre/README
+
U lustre/README.lustrecvs
+
U lustre/autoMakefile.am
+
U lustre/autogen.sh
+
U lustre/configure.ac
+
U lustre/lustre.spec.in
+
U lustre/lustrecvs
+
</code>
+
<code>
+
user@host:~/src$ '''cd lustre-1_8'''
+
user@host:~/src/lustre-1_8$ '''./lustrecvs b1_8'''
+
 
+
lustrecvs: updating lustrecvs
+
cvs update: Updating .
+
lustrecvs: Checking out build from b1_8
+
cvs checkout: Updating build
+
U build/.cvsignore
+
U build/Makefile
+
U build/README.kernel-source
+
U build/Rules.in
+
U build/autoMakefile.am
+
U build/autoMakefile.am.toplevel
+
:
+
:
+
</code>
+
To check out the most recent code for the release currently in development, replace b1_8 with HEAD.
+
 
+
=== Checking out code from Internal Lustre CVS ===
+
 
+
To check out Lustre source code from the Lustre CVS repository, complete these steps.
+
 
+
1. Test that your account is working by logging into [https://bugzilla.lustre.org/userprefs.cgi bugzilla]. CVS and bugzilla share the same account information. 
+
 
+
2. To upload a public ssh key to use in place of typing in a password, go to bugzilla's [http://bugzilla.lustre.org/userprefs.cgi user preferences].  If there is no "Change Public SSH key" field,send email to [mailto:cvs-admin@cvs.lustre.org cvs-admin@cvs.lustre.org]. (''Note:'' Currently, only SSH2 keys are supported.)
+
 
+
3. Set the ''CVS_RSH'' environment variable.
+
 
+
: For bash users, enter: <pre>export CVS_RSH=ssh</pre> 
+
: For csh users, enter: <pre>setenv CVS_RSH ssh</pre>
+
 
+
: Consider setting ''CVS_RSH'' in your .bashrc or .cshrc.
+
 
+
4. Check out lustre by running the following (change ''youraccountname'' to your cvs account name specified on the [https://bugzilla.lustre.org/userprefs.cgi user preferences page]):
+
 
+
<pre>
+
$ cvs -d :ext:youraccountname@cvs.lustre.org:/cvsroot/cfs co lustre
+
$ cd lustre
+
$ ./lustrecvs b1_8
+
</pre>
+
 
+
 
+
 
+
== Accessing the Internal Lustre CVS repository ==
+
 
+
The Internal Lustre CVS repository gives access by authorized users to the internal Lustre repository.
+
 
+
==== Legal Notice ====
+
 
+
: All software obtained from this CVS repository is considered pre-release proprietary software and is therefore confidential information.  You may not redistribute any software obtained from this CVS repository and must destroy all copies upon request.
+
 
+
: Unless otherwise authorized, you have a limited license to read, modify, compile, and use software obtained from this CVS repository in a non-production test environment.
+
 
+
: If you do not agree with these restrictions, ''do not use this CVS repository''. Please email us to have your account disabled.
+
 
+
=== Checking out code from Internal Lustre CVS ===
+
To check out Lustre source code from the Lustre External CVS repository, complete these steps.
+
 
+
1. Check out the top-level lustre directory, where {username} is your Bugzilla account id. When prompted for a password, enter your Bugzilla password.
+
 
+
: <pre>
+
: $ cvs -e ssh -d {username}@cvs.lustre.org:/cvsroot/lcfs co lustre
+
</pre>
+
 
+
 
+
2. Get the desired CVS tag.
+
 
+
: Download the Lustre source tree associated with the desired CVS tag using the lustrecvs script, where ''&lt;tag or branch&gt;'' is a valid Lustre branch or tag name (e.g. b1_8, HEAD, v1_9_250)
+
 
+
: <pre>
+
: $ cd lustre
+
: $ ./lustrecvs ''&lt;tag or branch&gt;''
+
</pre>
+
  
 +
Work for the next upcoming version is done on the ''master'' branch.
  
'''''Note''''': To update the tree or to change branches, run the "lustrecvs &lt;tag&gt;" command again. Using "cvs update" is not always reliable if there have been layout changes in the repository.
+
The Lustre [[Subsystem Map]] describes each of the subsystems in the Lustre code.

Latest revision as of 19:10, 20 January 2011

(Updated: Jan 2010)

NOTICE: The transition from CVS to Git took place on Monday, December 14. For more information about the transition, see the Git Transition Notice. For details about how to migrate to Git, see Migrating to Git.


We welcome and encourage contributions to the development and testing of a more robust, feature-rich Lustre™. You can obtain the latest bleeding-edge Lustre source code by anonymous Git access.

git clone git://git.lustre.org/prime/lustre.git 

Note: For more information about using Git, including tutorials and guides to help you get started, see the Git documentation page. For descriptions of the commands you are most likely to need, see the Commands section at the bottom of this page.

See Contribute for more information about developing, testing, and submitting a patch to the Lustre code.

Note: If you have questions or experience problems, send email to the Admins.

For more information about Git, see the Git home

Naming conventions

Stable development branches are named b{major}_{minor} (for example, b1_6 and b1_8). Even-numbered minor releases are considered stable releases. Odd-numbered minor releases correspond to alpha and beta releases and will sometimes be given v{major}_{minor}_{patch} tags to provide a point of reference for internal and external testing.

A release branch is created an official release to isolate it from further development and named b_release_{major}_{minor}_{patch} (for example, b_release_1_8_0). A final release gets a tag in the form v{major}_{minor}_{patch} (for example, v1_8_0 or v1_6_7_1).

Work for the next upcoming version is done on the master branch.

The Lustre Subsystem Map describes each of the subsystems in the Lustre code.

Personal tools
Navigation