docs/yul: Use backtick syntax correct for RST in the docs for --yul-optimizations

This commit is contained in:
Kamil Śliwak 2020-05-04 21:25:57 +02:00
parent 6a58227830
commit dc5612467f

View File

@ -1041,13 +1041,13 @@ Optimization step sequence
-------------------------- --------------------------
By default the Yul optimizer applies its predefined sequence of optimization steps to the generated assembly. By default the Yul optimizer applies its predefined sequence of optimization steps to the generated assembly.
You can override this sequence and supply your own using the `--yul-optimizations` option: You can override this sequence and supply your own using the ``--yul-optimizations`` option:
.. code-block:: sh .. code-block:: sh
solc --optimize --ir-optimized --yul-optimizations 'dhfoD[xarrscLMcCTU]uljmul' solc --optimize --ir-optimized --yul-optimizations 'dhfoD[xarrscLMcCTU]uljmul'
By enclosing part of the sequence in square brackets (`[]`) you tell the optimizer to repeatedly By enclosing part of the sequence in square brackets (``[]``) you tell the optimizer to repeatedly
apply that part until it no longer improves the size of the resulting assembly. apply that part until it no longer improves the size of the resulting assembly.
You can use brackets multiple times in a single sequence but they cannot be nested. You can use brackets multiple times in a single sequence but they cannot be nested.
@ -1056,37 +1056,37 @@ The following optimization steps are available:
============ =============================== ============ ===============================
Abbreviation Full name Abbreviation Full name
============ =============================== ============ ===============================
f `BlockFlattener` ``f`` ``BlockFlattener``
l `CircularReferencesPruner` ``l`` ``CircularReferencesPruner``
c `CommonSubexpressionEliminator` ``c`` ``CommonSubexpressionEliminator``
C `ConditionalSimplifier` ``C`` ``ConditionalSimplifier``
U `ConditionalUnsimplifier` ``U`` ``ConditionalUnsimplifier``
n `ControlFlowSimplifier` ``n`` ``ControlFlowSimplifier``
D `DeadCodeEliminator` ``D`` ``DeadCodeEliminator``
v `EquivalentFunctionCombiner` ``v`` ``EquivalentFunctionCombiner``
e `ExpressionInliner` ``e`` ``ExpressionInliner``
j `ExpressionJoiner` ``j`` ``ExpressionJoiner``
s `ExpressionSimplifier` ``s`` ``ExpressionSimplifier``
x `ExpressionSplitter` ``x`` ``ExpressionSplitter``
I `ForLoopConditionIntoBody` ``I`` ``ForLoopConditionIntoBody``
O `ForLoopConditionOutOfBody` ``O`` ``ForLoopConditionOutOfBody``
o `ForLoopInitRewriter` ``o`` ``ForLoopInitRewriter``
i `FullInliner` ``i`` ``FullInliner``
g `FunctionGrouper` ``g`` ``FunctionGrouper``
h `FunctionHoister` ``h`` ``FunctionHoister``
T `LiteralRematerialiser` ``T`` ``LiteralRematerialiser``
L `LoadResolver` ``L`` ``LoadResolver``
M `LoopInvariantCodeMotion` ``M`` ``LoopInvariantCodeMotion``
r `RedundantAssignEliminator` ``r`` ``RedundantAssignEliminator``
m `Rematerialiser` ``m`` ``Rematerialiser``
V `SSAReverser` ``V`` ``SSAReverser``
a `SSATransform` ``a`` ``SSATransform``
t `StructuralSimplifier` ``t`` ``StructuralSimplifier``
u `UnusedPruner` ``u`` ``UnusedPruner``
d `VarDeclInitializer` ``d`` ``VarDeclInitializer``
============ =============================== ============ ===============================
Some steps depend on properties ensured by `BlockFlattener`, `FunctionGrouper`, `ForLoopInitRewriter`. Some steps depend on properties ensured by ``BlockFlattener``, ``FunctionGrouper``, ``ForLoopInitRewriter``.
For this reason the Yul optimizer always applies them before applying any steps supplied by the user. For this reason the Yul optimizer always applies them before applying any steps supplied by the user.