summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Wilkins <john.wilkins@inktank.com>2013-10-22 13:25:13 -0700
committerJohn Wilkins <john.wilkins@inktank.com>2013-10-22 13:25:13 -0700
commit4e6a9a5b9ed0b6f20d79bed73c10228e33ae5e9a (patch)
tree45ed95daad7b1c1704ea2ef6f13084e7a44c3bbf
parent314fd2c80c25722e94e3d76d86b64802947c5a0b (diff)
downloadceph-4e6a9a5b9ed0b6f20d79bed73c10228e33ae5e9a.tar.gz
doc: Modified cloning source to include git steps. Consolidation.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
-rw-r--r--doc/install/clone-source.rst54
1 files changed, 51 insertions, 3 deletions
diff --git a/doc/install/clone-source.rst b/doc/install/clone-source.rst
index ad7dce4e5b4..56ce52f04e5 100644
--- a/doc/install/clone-source.rst
+++ b/doc/install/clone-source.rst
@@ -2,9 +2,58 @@
Cloning the Ceph Source Code Repository
=========================================
-To clone the source, you must install Git. See `Set Up Git`_ for details.
+You may clone a Ceph branch of the Ceph source code by going to `github Ceph
+Repository`_, selecting a branch (``master`` by default), and clicking the
+**Download ZIP** button.
-.. _Set Up Git: ../git
+.. _github Ceph Repository: https://github.com/ceph/ceph
+
+
+To clone the entire git repository, install and configure ``git``.
+
+
+Install Git
+===========
+
+To install ``git``, execute::
+
+ sudo apt-get install git
+
+You must also have a ``github`` account. If you do not have a
+``github`` account, go to `github.com`_ and register.
+Follow the directions for setting up git at
+`Set Up Git`_.
+
+.. _github.com: http://github.com
+.. _Set Up Git: http://help.github.com/linux-set-up-git
+
+
+Add SSH Keys (Optional)
+=======================
+
+If you intend to commit code to Ceph or to clone using SSH
+(``git@github.com:ceph/ceph.git``), you must generate SSH keys for github.
+
+.. tip:: If you only intend to clone the repository, you may
+ use ``git clone --recursive https://github.com/ceph/ceph.git``
+ without generating SSH keys.
+
+To generate SSH keys for ``github``, execute::
+
+ ssh-keygen
+
+Get the key to add to your ``github`` account (the following example
+assumes you used the default file path)::
+
+ cat .ssh/id_rsa.pub
+
+Copy the public key.
+
+Go to your your ``github`` account, click on "Account Settings" (i.e., the
+'tools' icon); then, click "SSH Keys" on the left side navbar.
+
+Click "Add SSH key" in the "SSH Keys" list, enter a name for the key, paste the
+key you generated, and press the "Add key" button.
Clone the Source
@@ -43,5 +92,4 @@ development branch. You may choose other branches too.
::
-
git checkout master