]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev/corpus.rst: tweak formatting 34577/head
authorKefu Chai <kchai@redhat.com>
Thu, 16 Apr 2020 03:09:43 +0000 (11:09 +0800)
committerKefu Chai <kchai@redhat.com>
Thu, 16 Apr 2020 03:12:25 +0000 (11:12 +0800)
* 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 <kchai@redhat.com>
doc/dev/corpus.rst

index c538028768b16ef885a35b66a5744ebf0c611968..4005f70c0384ca1506c23afada54ce05c36eb4cd 100644 (file)
@@ -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::