import 15.2.0 Octopus source

[ceph.git] / ceph / doc / dev / corpus.rst

diff --git a/ceph/doc/dev/corpus.rst b/ceph/doc/dev/corpus.rst
index 76fa43db0a771b3fb6dacdb7ea296706f6a1bf78..c538028768b16ef885a35b66a5744ebf0c611968 100644 (file)
--- a/ceph/doc/dev/corpus.rst
+++ b/ceph/doc/dev/corpus.rst
@@ -18,7 +18,8 @@ decode old objects across that $version (this is normally the case).
 How to generate an object corpus
 --------------------------------
 
-We can generate an object corpus for a particular version of ceph like so.
+We can generate an object corpus for a particular version of ceph using the
+script of ``script/gen-corpus.sh``, or by following the instructions below:
 
 #. Checkout a clean repo (best not to do this where you normally work)::
 
@@ -26,38 +27,40 @@ We can generate an object corpus for a particular version of ceph like so.
        cd ceph
        git submodule update --init --recursive
 
-#. Build with flag to dump objects to /tmp/foo::
+#. Build with flag to dump objects to ``/tmp/foo``::
 
        rm -rf /tmp/foo ; mkdir /tmp/foo
-       ./do_autogen.sh -e /tmp/foo
+       do_cmake.sh -DCMAKE_CXX_FLAGS="-DENCODE_DUMP_PATH=/tmp/foo"
+       cd build
        make
 
 #. Start via vstart::
 
-       cd src
-       MON=3 OSD=3 MDS=3 RGW=1 ./vstart.sh -n -x
+       cd build
+       MON=3 MGR=2 OSD=3 MDS=3 RGW=1 ../src/vstart.sh -n -x
 
 #. Use as much functionality of the cluster as you can, to exercise as many object encoder methods as possible::
 
-       ./rados -p rbd bench 10 write -b 123
-       ./ceph osd out 0
-       ./init-ceph stop osd.1
-       for f in ../qa/workunits/cls/*.sh ; do PATH=".:$PATH" $f ; done
-       ../qa/workunits/rados/test.sh
-       ./ceph_test_librbd
-       ./ceph_test_libcephfs
-       ./init-ceph restart mds.a
-
-Do some more stuff with rgw if you know how.
+       bin/ceph osd pool create mypool
+       bin/rados -p mypool bench 10 write -b 123
+       bin/ceph osd out 0
+       bin/ceph osd in 0
+       bin/init-ceph restart osd.1
+       for f in ../qa/workunits/cls/*.sh ; do PATH="bin:$PATH" $f ; done
+       PATH="bin:$PATH" ../qa/workunits/rados/test.sh
+       bin/ceph_test_librbd
+       bin/ceph_test_libcephfs
+       bin/init-ceph restart mds.a
+    ../qa/workunits/rgw/run-s3tests.sh
 
 #. Stop::
 
-       ./stop.sh
+       ../src/stop.sh
 
 #. Import the corpus (this will take a few minutes)::
 
-       test/encoding/import.sh /tmp/foo `./ceph-dencoder version` ../ceph-object-corpus/archive
-       test/encoding/import-generated.sh ../ceph-object-corpus/archive
+       ../src/test/encoding/import.sh /tmp/foo `bin/ceph-dencoder version` ../ceph-object-corpus/archive
+       ../src/test/encoding/import-generated.sh ../ceph-object-corpus/archive
 
 #. Prune it!  There will be a bazillion copies of various objects, and we only want a representative sample.::
 
@@ -67,15 +70,15 @@ Do some more stuff with rgw if you know how.
 
 #. Verify the tests pass::
 
-       make check-local
+       ctest -R readable.sh
 
 #. Commit it to the corpus repo and push::
 
        pushd ../ceph-object-corpus
        git checkout -b wip-new
-       git add archive/`../src/ceph-dencoder version`
-       git commit -m `../src/ceph-dencoder version`
-       git remote add cc ceph.com:/git/ceph-object-corpus.git
+       git add archive/`../build/bin/ceph-dencoder version`
+       git commit -m `../build/bin/ceph-dencoder version`
+       git remote add cc git@github.com:ceph/ceph-object-corpus.git
        git push cc wip-new
        popd
 
@@ -85,8 +88,8 @@ Do some more stuff with rgw if you know how.
        cd ceph-object-corpus
        git fetch origin
        git checkout wip-new
-       cd ../src
-       make check-local
+       cd ../build
+       ctest -R readable.sh
 
 #. If everything looks good, update the submodule master branch, and commit the submodule in ceph.git.