[llvm-commits] [llvm] r169981 - in /llvm/trunk/docs: Bugpoint.rst CMake.rst

Dmitri Gribenko gribozavr at gmail.com
Wed Dec 12 06:23:14 PST 2012


Author: gribozavr
Date: Wed Dec 12 08:23:14 2012
New Revision: 169981

URL: http://llvm.org/viewvc/llvm-project?rev=169981&view=rev
Log:
Documentation: use a 'console' highlighter for terminal output examples.  This
gives a nicer output than 'bash'.

Modified:
    llvm/trunk/docs/Bugpoint.rst
    llvm/trunk/docs/CMake.rst

Modified: llvm/trunk/docs/Bugpoint.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/Bugpoint.rst?rev=169981&r1=169980&r2=169981&view=diff
==============================================================================
--- llvm/trunk/docs/Bugpoint.rst (original)
+++ llvm/trunk/docs/Bugpoint.rst Wed Dec 12 08:23:14 2012
@@ -136,9 +136,9 @@
   It is often useful to capture the output of the program to file.  For example,
   in the C shell, you can run:
 
-  .. code-block:: bash
+  .. code-block:: console
 
-    bugpoint  ... |& tee bugpoint.log
+    $ bugpoint  ... |& tee bugpoint.log
 
   to get a copy of ``bugpoint``'s output in the file ``bugpoint.log``, as well
   as on your terminal.

Modified: llvm/trunk/docs/CMake.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CMake.rst?rev=169981&r1=169980&r2=169981&view=diff
==============================================================================
--- llvm/trunk/docs/CMake.rst (original)
+++ llvm/trunk/docs/CMake.rst Wed Dec 12 08:23:14 2012
@@ -36,7 +36,7 @@
 #. Create a directory for containing the build. It is not supported to build
    LLVM on the source directory. cd to this directory:
 
-   .. code-block:: bash
+   .. code-block:: console
 
      $ mkdir mybuilddir
      $ cd mybuilddir
@@ -44,7 +44,7 @@
 #. Execute this command on the shell replacing `path/to/llvm/source/root` with
    the path to the root of your LLVM source tree:
 
-   .. code-block:: bash
+   .. code-block:: console
 
      $ cmake path/to/llvm/source/root
 
@@ -80,14 +80,14 @@
 explicitly specify the generator with the command line option ``-G "Name of the
 generator"``. For knowing the available generators on your platform, execute
 
-.. code-block:: bash
+.. code-block:: console
 
   $ cmake --help
 
 This will list the generator's names at the end of the help text. Generator's
 names are case-sensitive. Example:
 
-.. code-block:: bash
+.. code-block:: console
 
   $ cmake -G "Visual Studio 9 2008" path/to/llvm/source/root
 
@@ -110,14 +110,14 @@
 variables, with possible values ON/OFF. Options and variables are defined on the
 CMake command line like this:
 
-.. code-block:: bash
+.. code-block:: console
 
   $ cmake -DVARIABLE=value path/to/llvm/source
 
 You can set a variable after the initial CMake invocation for changing its
 value. You can also undefine a variable:
 
-.. code-block:: bash
+.. code-block:: console
 
   $ cmake -UVARIABLE path/to/llvm/source
 
@@ -127,7 +127,7 @@
 Variables are listed here appending its type after a colon. It is correct to
 write the variable and the type on the CMake command line:
 
-.. code-block:: bash
+.. code-block:: console
 
   $ cmake -DVARIABLE:TYPE=value path/to/llvm/source
 
@@ -280,7 +280,7 @@
 using makefiles, execute this command while on the top level of your build
 directory:
 
-.. code-block:: bash
+.. code-block:: console
 
   $ make check
 
@@ -361,7 +361,7 @@
 It is possible to develop LLVM passes against installed LLVM.  An example of
 project layout provided below:
 
-.. code-block:: bash
+.. code-block:: none
 
   <project dir>/
       |





More information about the llvm-commits mailing list