From: Kefu Chai Date: Thu, 16 Apr 2020 03:09:43 +0000 (+0800) Subject: doc/dev/corpus.rst: tweak formatting X-Git-Tag: v16.1.0~2583^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F34577%2Fhead;p=ceph.git doc/dev/corpus.rst: tweak formatting * use `shell` lexer, otherwise the Python one is used, and the rendered result does not look right * be consistent when indenting -- either use tab or spaces, otherwise the indent in code block would be wrong. * double quote the variables in text Signed-off-by: Kefu Chai --- diff --git a/doc/dev/corpus.rst b/doc/dev/corpus.rst index c538028768b1..4005f70c0384 100644 --- a/doc/dev/corpus.rst +++ b/doc/dev/corpus.rst @@ -12,12 +12,14 @@ You can also mark known or deliberate incompatibilities between versions with:: archive/$version/forward_incompat/$type The presence of a file indicates that new versions of code cannot -decode old objects across that $version (this is normally the case). +decode old objects across that ``$version`` (this is normally the case). How to generate an object corpus -------------------------------- +.. highlight:: shell + 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: @@ -51,7 +53,7 @@ script of ``script/gen-corpus.sh``, or by following the instructions below: bin/ceph_test_librbd bin/ceph_test_libcephfs bin/init-ceph restart mds.a - ../qa/workunits/rgw/run-s3tests.sh + ../qa/workunits/rgw/run-s3tests.sh #. Stop::