]> git.apps.os.sepia.ceph.com Git - ceph.git/commit
doc/dev: use prompt directive when appropriate
authorKefu Chai <kchai@redhat.com>
Fri, 4 Sep 2020 11:41:30 +0000 (19:41 +0800)
committerKefu Chai <kchai@redhat.com>
Fri, 4 Sep 2020 16:03:52 +0000 (00:03 +0800)
commit0f2489406a8d4194c159c8777517d20b54e216b5
tree9612595fbacad6a4d61ad1881ed85d72fec88120
parentb5e47e7bfaa4717cee5b808546260b9484c585ae
doc/dev: use prompt directive when appropriate

for 2 reasons:

* sphinx renders codeblock using python syntax highlighting by default,
  so it's not surprising that it highlight keywords like "export" in
  command line samples. so to render command line code blocks, we'd
  better specify the syntax explicitly for better rendering result.
* with the help of "prompt" directive, user is able to copy and paste
  the command without the prompt. for instance, with the default
  "::" directive, user will copy "$ ceph df", which is not very
  convenient, but with "prompt" directive, user only copies
  "ceph df".

Signed-off-by: Kefu Chai <kchai@redhat.com>
doc/dev/developer_guide/basic-workflow.rst
doc/dev/developer_guide/essentials.rst
doc/dev/developer_guide/running-tests-in-cloud.rst
doc/dev/quick_guide.rst
doc/rados/configuration/auth-config-ref.rst
doc/rados/configuration/common.rst