RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2024-12-26 05:25:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/dev/corpus.rst: tweak formatting

Browse Source 
* 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>
This commit is contained in:
Kefu Chai 2020-04-16 11:09:43 +08:00
parent 61ad12e6ad
commit a1f42101cf
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/dev/corpus.rst
View 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::