--- /dev/null
+=====================
+ Build Ceph Packages
+=====================
+
+To build packages, you must clone the `Ceph`_ repository. You can create
+installation packages from the latest code using ``dpkg-buildpackage`` for
+Debian/Ubuntu or ``rpmbuild`` for the RPM Package Manager.
+
+.. tip:: When building on a multi-core CPU, use the ``-j`` and the number of
+ cores * 2. For example, use ``-j4`` for a dual-core processor to accelerate
+ the build.
+
+Advanced Package Tool (APT)
+===========================
+
+To create ``.deb`` packages for Debian/Ubuntu, ensure that you have cloned the
+`Ceph`_ repository, installed the `build prerequisites`_ and installed
+``debhelper``::
+
+ sudo apt-get install debhelper
+
+Once you have installed debhelper, you can build the packages:
+
+ sudo dpkg-buildpackage
+
+For multi-processor CPUs use the ``-j`` option to accelerate the build.
+
+RPM Package Manager
+===================
+
+To create ``.rpm`` packages, ensure that you have cloned the `Ceph`_ repository,
+installed the `build prerequisites`_ and installed ``rpm-build`` and
+``rpmdevtools``::
+
+ yum install rpm-build rpmdevtools
+
+Once you have installed the tools, setup an RPM compilation environment::
+
+ rpmdev-setuptree
+
+Fetch the source tarball for the RPM compilation environment::
+
+ wget -P ~/rpmbuild/SOURCES/ http://ceph.com/download/ceph-<version>.tar.gz
+
+Or from the EU mirror::
+
+ wget -P ~/rpmbuild/SOURCES/ http://eu.ceph.com/download/ceph-<version>.tar.gz
+
+Build the RPM packages::
+
+ rpmbuild -tb ~/rpmbuild/SOURCES/ceph-<version>.tar.gz
+
+For multi-processor CPUs use the ``-j`` option to accelerate the build.
+
+.. _build prerequisites: ../build-prerequisites
+.. _Ceph: ../cloning-the-ceph-source-code-repository
--- /dev/null
+=====================
+ Build Prerequisites
+=====================
+
+.. tip:: Check this section to see if there are specific prerequisites for your
+ Linux/Unix distribution.
+
+Before you can build Ceph source code, you need to install several libraries
+and tools. Ceph provides ``autoconf`` and ``automake`` scripts to get you
+started quickly. Ceph build scripts depend on the following:
+
+- ``autotools-dev``
+- ``autoconf``
+- ``automake``
+- ``cdbs``
+- ``gcc``
+- ``g++``
+- ``git``
+- ``libboost-dev``
+- ``libedit-dev``
+- ``libssl-dev``
+- ``libtool``
+- ``libfcgi``
+- ``libfcgi-dev``
+- ``libfuse-dev``
+- ``linux-kernel-headers``
+- ``libcrypto++-dev``
+- ``libcrypto++``
+- ``libexpat1-dev``
+- ``pkg-config``
+- ``libcurl4-gnutls-dev``
+
+On Ubuntu, execute ``sudo apt-get install`` for each dependency that isn't
+installed on your host. ::
+
+ sudo apt-get install autotools-dev autoconf automake cdbs gcc g++ git libboost-dev libedit-dev libssl-dev libtool libfcgi libfcgi-dev libfuse-dev linux-kernel-headers libcrypto++-dev libcrypto++ libexpat1-dev
+
+On Debian/Squeeze, execute ``aptitude install`` for each dependency that isn't
+installed on your host. ::
+
+ aptitude install autotools-dev autoconf automake cdbs gcc g++ git libboost-dev libedit-dev libssl-dev libtool libfcgi libfcgi-dev libfuse-dev linux-kernel-headers libcrypto++-dev libcrypto++ libexpat1-dev
+
+
+Ubuntu
+======
+
+- ``uuid-dev``
+- ``libkeyutils-dev``
+- ``libgoogle-perftools-dev``
+- ``libatomic-ops-dev``
+- ``libaio-dev``
+- ``libgdata-common``
+- ``libgdata13``
+
+Execute ``sudo apt-get install`` for each dependency that isn't installed on
+your host. ::
+
+ sudo apt-get install uuid-dev libkeyutils-dev libgoogle-perftools-dev libatomic-ops-dev libaio-dev libgdata-common libgdata13
+
+Debian
+======
+
+Alternatively, you may also install::
+
+ aptitude install fakeroot dpkg-dev
+ aptitude install debhelper cdbs libexpat1-dev libatomic-ops-dev
+
+openSUSE 11.2 (and later)
+=========================
+
+- ``boost-devel``
+- ``gcc-c++``
+- ``libedit-devel``
+- ``libopenssl-devel``
+- ``fuse-devel`` (optional)
+
+Execute ``zypper install`` for each dependency that isn't installed on your
+host. ::
+
+ zypper install boost-devel gcc-c++ libedit-devel libopenssl-devel fuse-devel
+
--- /dev/null
+===============
+ Building Ceph
+===============
+
+Ceph provides ``automake`` and ``configure`` scripts to streamline the build
+process. To build Ceph, navigate to your cloned Ceph repository and execute the
+following::
+
+ cd ceph
+ ./autogen.sh
+ ./configure
+ make
+
+You can use ``make -j`` to execute multiple jobs depending upon your system. For
+example::
+
+ make -j4
+
+To install Ceph locally, you may also use::
+
+ sudo make install
+
+If you install Ceph locally, ``make`` will place the executables in
+``usr/local/bin``. You may add the ``ceph.conf`` file to the ``usr/local/bin``
+directory to run an evaluation environment of Ceph from a single directory.
+
--- /dev/null
+=========================================
+ Cloning the Ceph Source Code Repository
+=========================================
+
+To clone the source, you must install Git. See `Set Up Git`_ for details.
+
+.. _Set Up Git: ../git
+
+
+Clone the Source
+================
+
+To clone the Ceph source code repository, execute::
+
+ git clone --recursive https://github.com/ceph/ceph.git
+
+Once ``git clone`` executes, you should have a full copy of the Ceph
+repository.
+
+.. tip:: Make sure you maintain the latest copies of the submodules
+ included in the repository. Running ``git status`` will tell you if
+ the submodules are out of date.
+
+::
+
+ cd ceph
+ git status
+
+If your submodules are out of date, run::
+
+ git submodule update
+
+Choose a Branch
+===============
+
+Once you clone the source code and submodules, your Ceph repository
+will be on the ``master`` branch by default, which is the unstable
+development branch. You may choose other branches too.
+
+- ``master``: The unstable development branch.
+- ``stable``: The bugfix branch.
+- ``next``: The release candidate branch.
+
+::
+
+
+ git checkout master
--- /dev/null
+==========================
+ Contributing Source Code
+==========================
+
+If you are making source contributions to the Ceph project,
+you must be added to the `Ceph project`_ on github.
+
+.. _Ceph project: https://github.com/ceph
\ No newline at end of file
--- /dev/null
+====================================
+ Downloading a Ceph Release Tarball
+====================================
+
+As Ceph development progresses, the Ceph team releases new versions of the
+source code. You may download source code tarballs for Ceph releases here:
+
+`Ceph Release Tarballs`_
+
+`Ceph Release Tarballs (EU mirror)`_
+
+
+.. _Ceph Release Tarballs: http://ceph.com/download/
+.. _Ceph Release Tarballs (EU mirror): http://eu.ceph.com/download/
--- /dev/null
+============
+ Set Up Git
+============
+
+To clone the Ceph git repository, you must have ``git`` installed
+on your local host.
+
+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
+
+Generate SSH Keys
+=================
+
+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.
+
+Add the 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.
\ No newline at end of file
+++ /dev/null
-=====================
- Build Ceph Packages
-=====================
-
-To build packages, you must clone the `Ceph`_ repository. You can create
-installation packages from the latest code using ``dpkg-buildpackage`` for
-Debian/Ubuntu or ``rpmbuild`` for the RPM Package Manager.
-
-.. tip:: When building on a multi-core CPU, use the ``-j`` and the number of
- cores * 2. For example, use ``-j4`` for a dual-core processor to accelerate
- the build.
-
-Advanced Package Tool (APT)
-===========================
-
-To create ``.deb`` packages for Debian/Ubuntu, ensure that you have cloned the
-`Ceph`_ repository, installed the `build prerequisites`_ and installed
-``debhelper``::
-
- sudo apt-get install debhelper
-
-Once you have installed debhelper, you can build the packages:
-
- sudo dpkg-buildpackage
-
-For multi-processor CPUs use the ``-j`` option to accelerate the build.
-
-RPM Package Manager
-===================
-
-To create ``.rpm`` packages, ensure that you have cloned the `Ceph`_ repository,
-installed the `build prerequisites`_ and installed ``rpm-build`` and
-``rpmdevtools``::
-
- yum install rpm-build rpmdevtools
-
-Once you have installed the tools, setup an RPM compilation environment::
-
- rpmdev-setuptree
-
-Fetch the source tarball for the RPM compilation environment::
-
- wget -P ~/rpmbuild/SOURCES/ http://ceph.com/download/ceph-<version>.tar.gz
-
-Or from the EU mirror::
-
- wget -P ~/rpmbuild/SOURCES/ http://eu.ceph.com/download/ceph-<version>.tar.gz
-
-Build the RPM packages::
-
- rpmbuild -tb ~/rpmbuild/SOURCES/ceph-<version>.tar.gz
-
-For multi-processor CPUs use the ``-j`` option to accelerate the build.
-
-.. _build prerequisites: ../build-prerequisites
-.. _Ceph: ../cloning-the-ceph-source-code-repository
+++ /dev/null
-=====================
- Build Prerequisites
-=====================
-
-.. tip:: Check this section to see if there are specific prerequisites for your
- Linux/Unix distribution.
-
-Before you can build Ceph source code, you need to install several libraries
-and tools. Ceph provides ``autoconf`` and ``automake`` scripts to get you
-started quickly. Ceph build scripts depend on the following:
-
-- ``autotools-dev``
-- ``autoconf``
-- ``automake``
-- ``cdbs``
-- ``gcc``
-- ``g++``
-- ``git``
-- ``libboost-dev``
-- ``libedit-dev``
-- ``libssl-dev``
-- ``libtool``
-- ``libfcgi``
-- ``libfcgi-dev``
-- ``libfuse-dev``
-- ``linux-kernel-headers``
-- ``libcrypto++-dev``
-- ``libcrypto++``
-- ``libexpat1-dev``
-- ``pkg-config``
-- ``libcurl4-gnutls-dev``
-
-On Ubuntu, execute ``sudo apt-get install`` for each dependency that isn't
-installed on your host. ::
-
- sudo apt-get install autotools-dev autoconf automake cdbs gcc g++ git libboost-dev libedit-dev libssl-dev libtool libfcgi libfcgi-dev libfuse-dev linux-kernel-headers libcrypto++-dev libcrypto++ libexpat1-dev
-
-On Debian/Squeeze, execute ``aptitude install`` for each dependency that isn't
-installed on your host. ::
-
- aptitude install autotools-dev autoconf automake cdbs gcc g++ git libboost-dev libedit-dev libssl-dev libtool libfcgi libfcgi-dev libfuse-dev linux-kernel-headers libcrypto++-dev libcrypto++ libexpat1-dev
-
-
-Ubuntu
-======
-
-- ``uuid-dev``
-- ``libkeyutils-dev``
-- ``libgoogle-perftools-dev``
-- ``libatomic-ops-dev``
-- ``libaio-dev``
-- ``libgdata-common``
-- ``libgdata13``
-
-Execute ``sudo apt-get install`` for each dependency that isn't installed on
-your host. ::
-
- sudo apt-get install uuid-dev libkeyutils-dev libgoogle-perftools-dev libatomic-ops-dev libaio-dev libgdata-common libgdata13
-
-Debian
-======
-
-Alternatively, you may also install::
-
- aptitude install fakeroot dpkg-dev
- aptitude install debhelper cdbs libexpat1-dev libatomic-ops-dev
-
-openSUSE 11.2 (and later)
-=========================
-
-- ``boost-devel``
-- ``gcc-c++``
-- ``libedit-devel``
-- ``libopenssl-devel``
-- ``fuse-devel`` (optional)
-
-Execute ``zypper install`` for each dependency that isn't installed on your
-host. ::
-
- zypper install boost-devel gcc-c++ libedit-devel libopenssl-devel fuse-devel
-
+++ /dev/null
-===============
- Building Ceph
-===============
-
-Ceph provides ``automake`` and ``configure`` scripts to streamline the build
-process. To build Ceph, navigate to your cloned Ceph repository and execute the
-following::
-
- cd ceph
- ./autogen.sh
- ./configure
- make
-
-You can use ``make -j`` to execute multiple jobs depending upon your system. For
-example::
-
- make -j4
-
-To install Ceph locally, you may also use::
-
- sudo make install
-
-If you install Ceph locally, ``make`` will place the executables in
-``usr/local/bin``. You may add the ``ceph.conf`` file to the ``usr/local/bin``
-directory to run an evaluation environment of Ceph from a single directory.
-
+++ /dev/null
-=========================================
- Cloning the Ceph Source Code Repository
-=========================================
-
-To clone the source, you must install Git. See `Set Up Git`_ for details.
-
-.. _Set Up Git: ../git
-
-
-Clone the Source
-================
-
-To clone the Ceph source code repository, execute::
-
- git clone --recursive https://github.com/ceph/ceph.git
-
-Once ``git clone`` executes, you should have a full copy of the Ceph
-repository.
-
-.. tip:: Make sure you maintain the latest copies of the submodules
- included in the repository. Running ``git status`` will tell you if
- the submodules are out of date.
-
-::
-
- cd ceph
- git status
-
-If your submodules are out of date, run::
-
- git submodule update
-
-Choose a Branch
-===============
-
-Once you clone the source code and submodules, your Ceph repository
-will be on the ``master`` branch by default, which is the unstable
-development branch. You may choose other branches too.
-
-- ``master``: The unstable development branch.
-- ``stable``: The bugfix branch.
-- ``next``: The release candidate branch.
-
-::
-
-
- git checkout master
+++ /dev/null
-==========================
- Contributing Source Code
-==========================
-
-If you are making source contributions to the Ceph project,
-you must be added to the `Ceph project`_ on github.
-
-.. _Ceph project: https://github.com/ceph
\ No newline at end of file
+++ /dev/null
-====================================
- Downloading a Ceph Release Tarball
-====================================
-
-As Ceph development progresses, the Ceph team releases new versions of the
-source code. You may download source code tarballs for Ceph releases here:
-
-`Ceph Release Tarballs`_
-
-`Ceph Release Tarballs (EU mirror)`_
-
-
-.. _Ceph Release Tarballs: http://ceph.com/download/
-.. _Ceph Release Tarballs (EU mirror): http://eu.ceph.com/download/
+++ /dev/null
-============
- Set Up Git
-============
-
-To clone the Ceph git repository, you must have ``git`` installed
-on your local host.
-
-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
-
-Generate SSH Keys
-=================
-
-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.
-
-Add the 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.
\ No newline at end of file
+++ /dev/null
-==================
- Ceph Source Code
-==================
-
-You can build Ceph from source by downloading a release or cloning the ``ceph``
-repository at github. If you intend to build Ceph from source, please see the
-build pre-requisites first. Making sure you have all the pre-requisites
-will save you time.
-
-.. toctree::
-
- Prerequisites <build-prerequisites>
- Get a Tarball <get-tarballs>
- Set Up Git <git>
- Clone the Source <clone-source>
- Build the Source <building-ceph>
- Build a Package <build-packages>
- Contributing Code <contributing>
projects / ceph.git / commitdiff