Commit Graph

29 Commits

Author SHA1 Message Date
Fabian Vogt
1a357143a2 README: Improve vstart.sh usage
Using long options where possible to make it easier to understand directly
and adding bluestore by default as it is the default storage backend.

Signed-off-by: Fabian Vogt <fvogt@suse.com>
2017-09-11 16:39:18 +02:00
Kefu Chai
472df1540a README: quote file names with "`"
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-07-27 11:57:54 +08:00
Kefu Chai
b973be63fe Merge pull request #14555 from yaozongyou/fix-readme-notconsistent
README.md: fix build instructions inconsistent.

Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-04-18 15:59:23 +08:00
Kefu Chai
472626b4ec README.md: use github heading syntax to mark the headings
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-04-17 23:49:32 +08:00
Yao Zongyou
40f18d4cda Fix build instructions inconsistent.
Signed-off-by: Yao Zongyou <yaozongyou@vip.qq.com>
2017-04-14 20:56:16 +08:00
Dan Mick
f81a47dbe3 README: hint at where to look to diagnose test failures
Signed-off-by: Dan Mick <dan.mick@redhat.com>
2016-11-10 14:43:41 -08:00
Sage Weil
428b3b8d67 README.md: replace package build instructions with tarball instructions
Signed-off-by: Sage Weil <sage@redhat.com>
2016-08-23 14:22:21 -04:00
Ali Maredia
af6e986100 cmake: Removed README.cmake.md, edited README.md
Deleted README.cmake.md and put any helpful
information it had into README.md.

Also a added note about which tests get executed
by ctest.

Signed-off-by: Ali Maredia <amaredia@redhat.com>
2016-06-30 18:07:58 -04:00
Sage Weil
09919ce683 README.md: update a few things
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-27 11:16:23 -07:00
Sage Weil
9bc6f6e614 README.md: fix whitespace
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-27 11:03:11 -07:00
Sage Weil
0d10262bfd README.md: note about builds (they are for development!)
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-23 09:28:09 -04:00
Sage Weil
08c563424d README.md: drop autotools instructions
Never look back!

Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-22 16:42:37 -04:00
Sage Weil
d30125e2b9 README.md: simplify cmake instructions around do_cmake.sh
Be prescriptive about the 'build' subdir, at least for the purposes of
this document (developer quick start).

Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-22 16:42:37 -04:00
Sage Weil
563c71d97f README.md: drop dependencies section
This is autotools-specific, and I'm not sure we need to document it here.

Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-22 16:42:37 -04:00
Ali Maredia
c270a452b0 cmake: updated CMake README instructions
Updated testing and cluster start up instructions
for CMake in README.md

Signed-off-by: Ali Maredia <amaredia@redhat.com>
2016-06-20 15:15:09 -04:00
Sage Weil
925691b36c README.md: note where make check test log output goes
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-16 14:18:12 -04:00
Sage Weil
1a877660e9 README.md: document running a test cluster
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-16 14:14:26 -04:00
Sage Weil
3b56a2e22c README.md: simplify cmake instructions
Assume build is subdir of the ceph.git checkout.

Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-16 14:14:21 -04:00
Sage Weil
ed885eaf42 README.md: drop obsolete comment about debian squeeze
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-16 14:14:18 -04:00
Sage Weil
6041a04e4c README.md: get source first (including submodules!)
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-16 14:14:15 -04:00
Sage Weil
e0203b91ba README.md: document how to run unit tests (with autotools)
Signed-off-by: Sage Weil <sage@redhat.com>
2016-06-16 14:14:11 -04:00
Kefu Chai
a9cd257513 doc: rename SubmittingPatches to SubmittingPatches.rst
for better reading experience

Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-01-20 13:28:38 +08:00
Ali Maredia
6e7fafc9d2 README.md: Add basic CMake instructions
README.md: Fixed spacing, trimmed cmake section

Signed-off-by: Ali Maredia <amaredia@redhat.com>
2015-09-03 11:37:30 -04:00
Ken Dreyer
fbb9279799 README: simplify build deps section
The install-deps.sh step is the same for Debian and RPM-based systems.
Simplify the two README sections into a single section.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2015-06-03 15:25:23 -06:00
Ken Dreyer
600f2cca7d README: rm references to old Ubuntu distros
Support for Ubuntu 11.04 officially ended on 28 October 2012.

Support for Ubuntu Oneiric Ocelot was officially ended on 9 May 2013.

Remove the references to these EOL distro versions.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2015-04-07 17:38:44 -06:00
Viktor Suprun
b80e6aecf9 README.md: fix the indent of a command line usage
Spaces replaced with tab

Signed-off-by: Viktor Suprun <popsul1993@gmail.com>
2015-02-13 21:10:51 +10:00
Loic Dachary
06593813af documentation: replace deps.{deb,rpm}.txt with scripts
install-deps.sh installs the dependencies based on the content of
debian/control (if apt-get is found) or ceph.spec.in (if yum is
found). The manually maintained list of dependencies for deb based
operating systems (deps.deb.txt) and rpm based operating
systems (deps.rpm.txt) are deprecated.

http://tracker.ceph.com/issues/10175 Fixes: #10175

Signed-off-by: Loic Dachary <ldachary@redhat.com>
2014-12-01 16:15:21 +01:00
Sage Weil
895318c0cd README.md: word wrap
Signed-off-by: Sage Weil <sage@redhat.com>
2014-08-06 08:16:21 -07:00
Luis Pabón
a923e2c9eb Renamed README to README.md to render in markdown
Signed-off-by: Luis Pabón <lpabon@redhat.com>
2014-08-05 14:51:16 -04:00