Commit Graph

46 Commits

Author SHA1 Message Date
Casey Bodley 42f3833dbd README: document cmake options for system packages
Signed-off-by: Casey Bodley <cbodley@redhat.com>
2022-03-31 14:56:06 -04:00
John Bent cbe029bb3a README.md: Update README.md to add link to tracker.ceph.com
I searched the existing documentation for a link to the tracker and had a hard time finding it. Other folks like myself might like it so prominently displayed.
Added a link to https://tracker.ceph.com/projects/ceph as https://tracker.ceph.com/ is basically blank and not totally intuitive how to get to issues.

Signed-off-by: John Bent <john.bent@seagate.com>
2022-01-05 14:48:12 -07:00
Kefu Chai a5d38f0b14 README.md: recommend -Og instead of -O0
per https://gcc.gnu.org/onlinedocs/gcc/Optimize-Options.html

> -Og
>  Optimize debugging experience. -Og should be the optimization level of
>  choice for the standard edit-compile-debug cycle, offering a reasonable
>  level of optimization while maintaining fast compilation and a good
>  debugging experience. It is a better choice than -O0 for producing
>  debuggable code because some compiler passes that collect debug
>  information are disabled at -O0.

so instead of using -O0, for better developer experience, -Og is
recommended.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-07-20 14:23:59 +08:00
Srishti Guleria faccb57b3f README.md: fix couple minor syntax issues
Signed-off-by: Srishti Guleria <guleriasrishti01@gmail.com>
2021-07-08 23:27:33 +08:00
Varsha Rao 0c1c3d594d README.md: remove extra 'the' and format para related to ninja
Signed-off-by: Varsha Rao <varao@redhat.com>
2021-03-26 12:20:00 +05:30
Kefu Chai 1fab195e91 README.md: correct notes on `-j` option
Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-12 22:18:10 +08:00
Rishabh Dave 65ba380251 README.md: replace "make" by "ninja"
Update README.md since ninja is the default generator now.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2021-03-12 09:55:52 +05:30
Kefu Chai 8a7c8015c8 cmake: do not check OFED_PREFIX anymore
OFED_PREFIX was added to compile with xio messenger for supporting RDMA
using the Accelio and/or MLNX_OFED package. but xio messenger was removed in
in cc9a9142fd

let remove the leftover in CMakeLists

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-08-01 13:23:18 +08:00
Kefu Chai 9d32ca8c36 README.md: remove stale cmake prerequisite
it's stale. as we now require 3.10 after dropping the support of xenial.

and it's incomplete, we have a ton of build dependencies apart from
cmake.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-01-22 00:00:01 +08:00
Matthew Oliver eb33b30d3d do_cmake.sh: Add CEPH_GIT_DIR
This patch adds a new env variables that users can set to define the
location of the checked out ceph git repo.

The documentation mentions having to go edit the script directly to
point to the ceph git directory if the build dir isn't in the
top directory of the checked out git repo. This patch changes the '..'
into an env variable, CEPH_GIT_DIR, that defaults to '..'. To make it
easy to script and change.

This allows someone to do things like:

 export CEPH_GIT_DIR=~/git/ceph
 ./do_cmake.sh

or

 CEPH_GIT_DIR=~/git/ceph ./do_cmake.sh

Which is much better then editing the script directly.
The README.md has been modified to mention this variable and also
includes a drive by to mention `make -j` for new contributors to
build ceph quicker.

Signed-off-by: Matthew Oliver <moliver@suse.com>
2019-11-04 00:30:09 +00:00
Sage Weil 2f361a6eee relicense LGPL-2.1 code as LGPL-2.1 or LGPL-3.0
The primary motivation to relicense is a desire to integrate with projects
that are licensed under the Apache License version 2.0.  Although opinions
vary, there are some who argue the the LGPL-2.1 and Apache-2.0 licenses
are not fully compatible.  We would like to avoid the ambiguity and
potential for controversy.

Projects we would like to consume that are Apache-2.0 licensed include
Seastar, OpenSSL (which is in the process of relicensing to Apache-2.0),
and Swagger (swagger.io).  Note that some of these are dynamically linked
or consumed via a high-level language and may or may not require a change
to LGPL-3.0, but providing the option for LGPL-3.0 certainly avoids any
uncertainty.

A few other source files are already incorporated into Ceph that claim an
Apache-2.0 license:

    src/common/deleter.h
    src/common/sstring.h
    src/include/cpp-btree

The Ceph developers would further like to provide a license option that is
more modern than the current LGPL-2.1.  LGPL-3.0 includes updated,
clarified language around several issues and is widely considered
more modern, superior license.

Signed-off-by: Sage Weil <sage@redhat.com>
2019-04-22 11:22:55 -05:00
Mark Nelson 3214b71558 README.md: Add note about default do_cmake.sh debug builds.
Signed-off-by: Mark Nelson <mnelson@redhat.com>
2018-12-12 12:09:57 -06:00
Kefu Chai 5e0dd8c19e README.md: bump up required cmake to 3.5.1
we started to use cmake 3.5.1 back in 34f1ee78

Signed-off-by: Kefu Chai <kchai@redhat.com>
2018-10-09 13:52:11 +08:00
Nathan Cutler e294dd5910 legal: remove doc license ambiguity
The license applicable to the files under doc/ was originally declared (in the
top-level file COPYING) to be "Creative Commons Attribution-ShareAlike (CC
BY-SA)" by ed0653b493

This license declaration omitted a version number.

Some time later ef7418421b was merged, mentioning
CC-BY-SA-1.0 as one of the Ceph source code licenses. Although the purpose of that
commit was only to summarize the canonical license information from COPYING, it
unintentionally became the only place in the source code where the doc license
version was specified.

In March 2018, the Debian project warned that CC-BY-SA-1.0 does not meet its
criteria for inclusion in the "free" section of the Debian distribution. (For
that, at least version 3.0 must be used.)

This new commit removes the doc license ambiguity by setting it to CC-BY-SA-3.0
in all places where the license is mentioned.

The exact spelling of the license name is taken from https://spdx.org/licenses/

Fixes: http://tracker.ceph.com/issues/23336
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-03-13 18:59:02 +01:00
Abhishek Lekshmanan d6175381b4 doc/README: mention about ARGS in do_cmake
Add an example on how to use ARGS to override cmake builds

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2018-01-10 18:11:20 +01:00
Yao Zongyou 18d17706bf doc: make the commands in README.md properly aligned
The commands in README.md are aligned using one tab or eight spaces,
the github markdown engine not handle this properly, so using one tab
universely.

Signed-off-by: Yao Zongyou <yaozongyou@vip.qq.com>
2017-10-31 13:44:23 +08:00
Yan Jun bf7227b62a README.md: bump up cmake to 2.8.12
Signed-off-by: Yan Jun <yan.jun8@zte.com.cn>
2017-10-17 19:27:26 +08:00
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