~ubuntu-branches/ubuntu/quantal/ceph/quantal

« back to all changes in this revision

Viewing changes to doc/source/clone-source.rst

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2012-07-16 09:56:24 UTC
  • mfrom: (0.3.11)
  • mto: This revision was merged to the branch mainline in revision 17.
  • Revision ID: package-import@ubuntu.com-20120716095624-azr2w4hbhei1rxmx
Tags: upstream-0.48
ImportĀ upstreamĀ versionĀ 0.48

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
=========================================
 
2
 Cloning the Ceph Source Code Repository
 
3
=========================================
 
4
To clone the source, you must install Git. See `Set Up Git`_ for details.
 
5
 
 
6
.. _Set Up Git: ../git
 
7
 
 
8
Clone the Source
 
9
----------------
 
10
To clone the Ceph source code repository, execute::
 
11
 
 
12
        git clone git@github.com:ceph/ceph.git
 
13
 
 
14
Once ``git clone`` executes, you should have a full copy of the Ceph 
 
15
repository.
 
16
 
 
17
Clone the Submodules
 
18
--------------------
 
19
Before you can build Ceph, you must navigate to your new repository and get 
 
20
the ``init`` submodule and the ``update`` submodule::
 
21
 
 
22
        cd ceph
 
23
        git submodule init
 
24
        git submodule update
 
25
 
 
26
.. tip:: Make sure you maintain the latest copies of these submodules. 
 
27
   Running ``git status`` will tell you if the submodules are out of date::
 
28
 
 
29
        git status
 
30
 
 
31
Choose a Branch
 
32
---------------
 
33
Once you clone the source code and submodules, your Ceph repository 
 
34
will be on the ``master`` branch by default, which is the unstable 
 
35
development branch. You may choose other branches too.
 
36
 
 
37
- ``master``: The unstable development branch.
 
38
- ``stable``: The bugfix branch.
 
39
- ``next``: The release candidate branch.
 
40
 
 
41
::
 
42
 
 
43
        git checkout master