diff --git a/docs/yul.rst b/docs/yul.rst index 3c7e0ba4d..f2e09d22e 100644 --- a/docs/yul.rst +++ b/docs/yul.rst @@ -1041,13 +1041,13 @@ Optimization step sequence -------------------------- 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 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. 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 ============ =============================== -f `BlockFlattener` -l `CircularReferencesPruner` -c `CommonSubexpressionEliminator` -C `ConditionalSimplifier` -U `ConditionalUnsimplifier` -n `ControlFlowSimplifier` -D `DeadCodeEliminator` -v `EquivalentFunctionCombiner` -e `ExpressionInliner` -j `ExpressionJoiner` -s `ExpressionSimplifier` -x `ExpressionSplitter` -I `ForLoopConditionIntoBody` -O `ForLoopConditionOutOfBody` -o `ForLoopInitRewriter` -i `FullInliner` -g `FunctionGrouper` -h `FunctionHoister` -T `LiteralRematerialiser` -L `LoadResolver` -M `LoopInvariantCodeMotion` -r `RedundantAssignEliminator` -m `Rematerialiser` -V `SSAReverser` -a `SSATransform` -t `StructuralSimplifier` -u `UnusedPruner` -d `VarDeclInitializer` +``f`` ``BlockFlattener`` +``l`` ``CircularReferencesPruner`` +``c`` ``CommonSubexpressionEliminator`` +``C`` ``ConditionalSimplifier`` +``U`` ``ConditionalUnsimplifier`` +``n`` ``ControlFlowSimplifier`` +``D`` ``DeadCodeEliminator`` +``v`` ``EquivalentFunctionCombiner`` +``e`` ``ExpressionInliner`` +``j`` ``ExpressionJoiner`` +``s`` ``ExpressionSimplifier`` +``x`` ``ExpressionSplitter`` +``I`` ``ForLoopConditionIntoBody`` +``O`` ``ForLoopConditionOutOfBody`` +``o`` ``ForLoopInitRewriter`` +``i`` ``FullInliner`` +``g`` ``FunctionGrouper`` +``h`` ``FunctionHoister`` +``T`` ``LiteralRematerialiser`` +``L`` ``LoadResolver`` +``M`` ``LoopInvariantCodeMotion`` +``r`` ``RedundantAssignEliminator`` +``m`` ``Rematerialiser`` +``V`` ``SSAReverser`` +``a`` ``SSATransform`` +``t`` ``StructuralSimplifier`` +``u`` ``UnusedPruner`` +``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.