[llvm-commits] [llvm] r170011 - /llvm/trunk/docs/SphinxQuickstartTemplate.rst

Dmitri Gribenko gribozavr at gmail.com
Wed Dec 12 12:07:19 PST 2012


Author: gribozavr
Date: Wed Dec 12 14:07:18 2012
New Revision: 170011

URL: http://llvm.org/viewvc/llvm-project?rev=170011&view=rev
Log:
Documentation: SphinxQuickstartTemplate.rst: add guidelines about highlighting
console sessions and add more highlighter names.

Modified:
    llvm/trunk/docs/SphinxQuickstartTemplate.rst

Modified: llvm/trunk/docs/SphinxQuickstartTemplate.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/SphinxQuickstartTemplate.rst?rev=170011&r1=170010&r2=170011&view=diff
==============================================================================
--- llvm/trunk/docs/SphinxQuickstartTemplate.rst (original)
+++ llvm/trunk/docs/SphinxQuickstartTemplate.rst Wed Dec 12 14:07:18 2012
@@ -107,14 +107,15 @@
      return 0
    }
 
-For a shell session, use a ``bash`` code block:
+For a shell session, use a ``console`` code block:
 
-.. code-block:: bash
+.. code-block:: console
 
    $ echo "Goodbye cruel world!"
    $ rm -rf /
 
-If you need to show LLVM IR use the ``llvm`` code block.
+If you need to show LLVM IR use the ``llvm`` code block.  Code blocks of ``c``,
+``c++``, ``objc``, ``bash``, ``makefile`` kinds are supported.
 
 You can show preformatted text without any syntax highlighting like this:
 
@@ -136,6 +137,8 @@
                          .++:..
                           ...
 
+One can also use a ``none`` code block to turn off highlighting.
+
 Hopefully you won't need to be this deep
 """"""""""""""""""""""""""""""""""""""""
 





More information about the llvm-commits mailing list