mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
fix(docs): fix missing backticks, remove latexpdfja, fix the missing help message of latexpdf, and remove unnecessary whitespace (#14101)
* Fix missing backticks * Remove whitespace in the header of the optimizer step * Remove whitespace in directives * Remove `make latexpdfja` * Add the help message of latexpdf in make.bat * Fix missing backticks * Update docs/internals/optimizer.rst --------- Co-authored-by: Nuno Santos <nunofilipesantos@gmail.com>
This commit is contained in:
parent
5d42bb5e38
commit
e1a9446f87
@ -173,4 +173,4 @@ How to update your code
|
|||||||
- Change ``msg.sender.transfer(x)`` to ``payable(msg.sender).transfer(x)`` or use a stored variable of ``address payable`` type.
|
- Change ``msg.sender.transfer(x)`` to ``payable(msg.sender).transfer(x)`` or use a stored variable of ``address payable`` type.
|
||||||
- Change ``x**y**z`` to ``(x**y)**z``.
|
- Change ``x**y**z`` to ``(x**y)**z``.
|
||||||
- Use inline assembly as a replacement for ``log0``, ..., ``log4``.
|
- Use inline assembly as a replacement for ``log0``, ..., ``log4``.
|
||||||
- Negate unsigned integers by subtracting them from the maximum value of the type and adding 1 (e.g. ``type(uint256).max - x + 1``, while ensuring that `x` is not zero)
|
- Negate unsigned integers by subtracting them from the maximum value of the type and adding 1 (e.g. ``type(uint256).max - x + 1``, while ensuring that ``x`` is not zero)
|
||||||
|
@ -34,7 +34,6 @@ help:
|
|||||||
@echo " epub to make an epub"
|
@echo " epub to make an epub"
|
||||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
|
||||||
@echo " text to make text files"
|
@echo " text to make text files"
|
||||||
@echo " man to make manual pages"
|
@echo " man to make manual pages"
|
||||||
@echo " texinfo to make Texinfo files"
|
@echo " texinfo to make Texinfo files"
|
||||||
@ -116,12 +115,6 @@ latexpdf:
|
|||||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||||
|
|
||||||
latexpdfja:
|
|
||||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
|
||||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
|
||||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
|
||||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
|
||||||
|
|
||||||
text:
|
text:
|
||||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||||
@echo
|
@echo
|
||||||
|
@ -651,7 +651,7 @@ in the following situations:
|
|||||||
|
|
||||||
For the following cases, the error data from the external call
|
For the following cases, the error data from the external call
|
||||||
(if provided) is forwarded. This means that it can either cause
|
(if provided) is forwarded. This means that it can either cause
|
||||||
an `Error` or a `Panic` (or whatever else was given):
|
an ``Error`` or a ``Panic`` (or whatever else was given):
|
||||||
|
|
||||||
#. If a ``.transfer()`` fails.
|
#. If a ``.transfer()`` fails.
|
||||||
#. If you call a function via a message call but it does not finish
|
#. If you call a function via a message call but it does not finish
|
||||||
|
@ -527,7 +527,7 @@ If you are interested what CMake options are available run ``cmake .. -LH``.
|
|||||||
SMT Solvers
|
SMT Solvers
|
||||||
-----------
|
-----------
|
||||||
Solidity can be built against SMT solvers and will do so by default if
|
Solidity can be built against SMT solvers and will do so by default if
|
||||||
they are found in the system. Each solver can be disabled by a `cmake` option.
|
they are found in the system. Each solver can be disabled by a ``cmake`` option.
|
||||||
|
|
||||||
*Note: In some cases, this can also be a potential workaround for build failures.*
|
*Note: In some cases, this can also be a potential workaround for build failures.*
|
||||||
|
|
||||||
|
@ -827,7 +827,7 @@ if the common subexpression eliminator was run right before it.
|
|||||||
.. _expression-simplifier:
|
.. _expression-simplifier:
|
||||||
|
|
||||||
ExpressionSimplifier
|
ExpressionSimplifier
|
||||||
^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
The ExpressionSimplifier uses the Dataflow Analyzer and makes use
|
The ExpressionSimplifier uses the Dataflow Analyzer and makes use
|
||||||
of a list of equivalence transforms on expressions like ``X + 0 -> X``
|
of a list of equivalence transforms on expressions like ``X + 0 -> X``
|
||||||
|
@ -247,7 +247,7 @@ hiding new and different behavior in existing code.
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
The function `f()` behaves as follows:
|
The function ``f()`` behaves as follows:
|
||||||
|
|
||||||
- Old code generator: runs out of gas while zeroing the array contents after the large memory allocation
|
- Old code generator: runs out of gas while zeroing the array contents after the large memory allocation
|
||||||
- New code generator: reverts due to free memory pointer overflow (does not run out of gas)
|
- New code generator: reverts due to free memory pointer overflow (does not run out of gas)
|
||||||
|
@ -28,6 +28,7 @@ if "%1" == "help" (
|
|||||||
echo. devhelp to make HTML files and a Devhelp project
|
echo. devhelp to make HTML files and a Devhelp project
|
||||||
echo. epub to make an epub
|
echo. epub to make an epub
|
||||||
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
||||||
|
echo. latexpdf to make LaTeX files and run them through pdflatex
|
||||||
echo. text to make text files
|
echo. text to make text files
|
||||||
echo. man to make manual pages
|
echo. man to make manual pages
|
||||||
echo. texinfo to make Texinfo files
|
echo. texinfo to make Texinfo files
|
||||||
@ -155,16 +156,6 @@ if "%1" == "latexpdf" (
|
|||||||
goto end
|
goto end
|
||||||
)
|
)
|
||||||
|
|
||||||
if "%1" == "latexpdfja" (
|
|
||||||
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
|
||||||
cd %BUILDDIR%/latex
|
|
||||||
make all-pdf-ja
|
|
||||||
cd %BUILDDIR%/..
|
|
||||||
echo.
|
|
||||||
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
|
||||||
goto end
|
|
||||||
)
|
|
||||||
|
|
||||||
if "%1" == "text" (
|
if "%1" == "text" (
|
||||||
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
||||||
if errorlevel 1 exit /b 1
|
if errorlevel 1 exit /b 1
|
||||||
|
@ -947,7 +947,7 @@ the ``dup`` and ``swap`` instructions as well as ``jump`` instructions, labels a
|
|||||||
The remaining bytes will retain their values as of before the call.
|
The remaining bytes will retain their values as of before the call.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
The `difficulty()` instruction is disallowed in EVM version >= Paris.
|
The ``difficulty()`` instruction is disallowed in EVM version >= Paris.
|
||||||
With the Paris network upgrade the semantics of the instruction that was previously called
|
With the Paris network upgrade the semantics of the instruction that was previously called
|
||||||
``difficulty`` have been changed and the instruction was renamed to ``prevrandao``.
|
``difficulty`` have been changed and the instruction was renamed to ``prevrandao``.
|
||||||
It can now return arbitrary values in the full 256-bit range, whereas the highest recorded
|
It can now return arbitrary values in the full 256-bit range, whereas the highest recorded
|
||||||
|
Loading…
Reference in New Issue
Block a user