Skip to content
This repository has been archived by the owner on Apr 23, 2020. It is now read-only.

Commit

Permalink
[docs] Update code block for compatibility with Sphinx 1.5.1
Browse files Browse the repository at this point in the history
It is currently not possible to build the documentation with cmake and
the same version of Sphinx (1.5.1) used to generate the public facing
documentation on llvm.org. When code blocks cannot be parsed by
Pygments, it generates a warning which is treated as an error.

In addition to being annoying and confusing for developers, this
needlessly increases the bar for newcomers that want to get involved.

This patch removes the language specifier from the affected block. The
result is the same as when parsing fails: the block are not highlighted.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@317472 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
JDevlieghere committed Nov 6, 2017
1 parent 84066df commit 2b2534c
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 70 deletions.
12 changes: 6 additions & 6 deletions docs/CommandGuide/lli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ CODE GENERATION OPTIONS

Choose the code model from:

.. code-block:: perl
.. code-block:: text
default: Target default code model
small: Small code model
Expand Down Expand Up @@ -154,7 +154,7 @@ CODE GENERATION OPTIONS

Instruction schedulers available (before register allocation):

.. code-block:: perl
.. code-block:: text
=default: Best scheduler for the target
=none: No scheduling: breadth first sequencing
Expand All @@ -168,7 +168,7 @@ CODE GENERATION OPTIONS

Register allocator to use (default=linearscan)

.. code-block:: perl
.. code-block:: text
=bigblock: Big-block register allocator
=linearscan: linear scan register allocator =local - local register allocator
Expand All @@ -178,7 +178,7 @@ CODE GENERATION OPTIONS

Choose relocation model from:

.. code-block:: perl
.. code-block:: text
=default: Target default relocation model
=static: Non-relocatable code =pic - Fully relocatable, position independent code
Expand All @@ -188,7 +188,7 @@ CODE GENERATION OPTIONS

Spiller to use (default=local)

.. code-block:: perl
.. code-block:: text
=simple: simple spiller
=local: local spiller
Expand All @@ -197,7 +197,7 @@ CODE GENERATION OPTIONS

Choose style of code to emit from X86 backend:

.. code-block:: perl
.. code-block:: text
=att: Emit AT&T-style assembly
=intel: Emit Intel-style assembly
Expand Down
8 changes: 4 additions & 4 deletions docs/CommandGuide/llvm-pdbutil.rst
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Symbol Type Options

Displays class definitions in the specified format.

.. code-block:: perl
.. code-block:: text
=all - Display all class members including data, constants, typedefs, functions, etc (default)
=layout - Only display members that contribute to class size.
Expand All @@ -152,7 +152,7 @@ Symbol Type Options

Displays classes in the specified order.

.. code-block:: perl
.. code-block:: text
=none - Undefined / no particular sort order (default)
=name - Sort classes by name
Expand Down Expand Up @@ -200,7 +200,7 @@ Symbol Type Options
Type of symbols to dump when -globals, -externals, or -module-syms is
specified. (default all)

.. code-block:: perl
.. code-block:: text
=thunks - Display thunk symbols
=data - Display data symbols
Expand All @@ -212,7 +212,7 @@ Symbol Type Options
For symbols dumped via the -module-syms, -globals, or -externals options, sort
the results in specified order.

.. code-block:: perl
.. code-block:: text
=none - Undefined / no particular sort order
=name - Sort symbols by name
Expand Down
2 changes: 1 addition & 1 deletion docs/GetElementPtr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ illegal.
In order to access the 18th integer in the array, you would need to do the
following:

.. code-block:: llvm
.. code-block:: text
%idx = getelementptr { [40 x i32]* }, { [40 x i32]* }* %, i64 0, i32 0
%arr = load [40 x i32]** %idx
Expand Down
Loading

0 comments on commit 2b2534c

Please sign in to comment.