mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
fix: typos
This commit is contained in:
parent
ef743aa8ac
commit
46ca801ab8
@ -7,7 +7,7 @@ List of Known Bugs
|
|||||||
##################
|
##################
|
||||||
|
|
||||||
Below, you can find a JSON-formatted list of some of the known security-relevant bugs in the
|
Below, you can find a JSON-formatted list of some of the known security-relevant bugs in the
|
||||||
Solidity compiler. The file itself is hosted in the `Github repository
|
Solidity compiler. The file itself is hosted in the `GitHub repository
|
||||||
<https://github.com/ethereum/solidity/blob/develop/docs/bugs.json>`_.
|
<https://github.com/ethereum/solidity/blob/develop/docs/bugs.json>`_.
|
||||||
The list stretches back as far as version 0.3.0, bugs known to be present only
|
The list stretches back as far as version 0.3.0, bugs known to be present only
|
||||||
in versions preceding that are not listed.
|
in versions preceding that are not listed.
|
||||||
|
@ -149,7 +149,7 @@ Modifiers
|
|||||||
- ``pure`` for functions: Disallows modification or access of state.
|
- ``pure`` for functions: Disallows modification or access of state.
|
||||||
- ``view`` for functions: Disallows modification of state.
|
- ``view`` for functions: Disallows modification of state.
|
||||||
- ``payable`` for functions: Allows them to receive Ether together with a call.
|
- ``payable`` for functions: Allows them to receive Ether together with a call.
|
||||||
- ``constant`` for state variables: Disallows assignment (except initialisation), does not occupy storage slot.
|
- ``constant`` for state variables: Disallows assignment (except initialization), does not occupy storage slot.
|
||||||
- ``immutable`` for state variables: Allows assignment at construction time and is constant when deployed. Is stored in code.
|
- ``immutable`` for state variables: Allows assignment at construction time and is constant when deployed. Is stored in code.
|
||||||
- ``anonymous`` for events: Does not store event signature as topic.
|
- ``anonymous`` for events: Does not store event signature as topic.
|
||||||
- ``indexed`` for event parameters: Stores the parameter as topic.
|
- ``indexed`` for event parameters: Stores the parameter as topic.
|
||||||
|
@ -398,7 +398,7 @@ Constructors
|
|||||||
|
|
||||||
A constructor is an optional function declared with the ``constructor`` keyword
|
A constructor is an optional function declared with the ``constructor`` keyword
|
||||||
which is executed upon contract creation, and where you can run contract
|
which is executed upon contract creation, and where you can run contract
|
||||||
initialisation code.
|
initialization code.
|
||||||
|
|
||||||
Before the constructor code is executed, state variables are initialised to
|
Before the constructor code is executed, state variables are initialised to
|
||||||
their specified value if you initialise them inline, or their :ref:`default value<default-value>` if you do not.
|
their specified value if you initialise them inline, or their :ref:`default value<default-value>` if you do not.
|
||||||
|
@ -128,7 +128,7 @@ for the ``evmone`` shared object can be specified via the ``ETH_EVMONE`` environ
|
|||||||
If you do not have it installed, you can skip these tests by passing the ``--no-semantic-tests``
|
If you do not have it installed, you can skip these tests by passing the ``--no-semantic-tests``
|
||||||
flag to ``scripts/soltest.sh``.
|
flag to ``scripts/soltest.sh``.
|
||||||
|
|
||||||
The ``evmone`` library should both end with the file name
|
The ``evmone`` library should end with the file name
|
||||||
extension ``.so`` on Linux, ``.dll`` on Windows systems and ``.dylib`` on macOS.
|
extension ``.so`` on Linux, ``.dll`` on Windows systems and ``.dylib`` on macOS.
|
||||||
|
|
||||||
For running SMT tests, the ``libz3`` library must be installed and locatable
|
For running SMT tests, the ``libz3`` library must be installed and locatable
|
||||||
@ -552,7 +552,7 @@ topics, issues or feature implementations are debated in detail. The invitation
|
|||||||
|
|
||||||
We are also sharing feedback surveys and other content that is relevant to language design in the forum.
|
We are also sharing feedback surveys and other content that is relevant to language design in the forum.
|
||||||
|
|
||||||
If you want to know where the team is standing in terms or implementing new features, you can follow the implementation status in the `Solidity Github project <https://github.com/ethereum/solidity/projects/43>`_.
|
If you want to know where the team is standing in terms or implementing new features, you can follow the implementation status in the `Solidity GitHub project <https://github.com/ethereum/solidity/projects/43>`_.
|
||||||
Issues in the design backlog need further specification and will either be discussed in a language design call or in a regular team call. You can
|
Issues in the design backlog need further specification and will either be discussed in a language design call or in a regular team call. You can
|
||||||
see the upcoming changes for the next breaking release by changing from the default branch (`develop`) to the `breaking branch <https://github.com/ethereum/solidity/tree/breaking>`_.
|
see the upcoming changes for the next breaking release by changing from the default branch (`develop`) to the `breaking branch <https://github.com/ethereum/solidity/tree/breaking>`_.
|
||||||
|
|
||||||
|
@ -83,14 +83,14 @@ and runs it in a new container, passing the ``--help`` argument.
|
|||||||
|
|
||||||
docker run ethereum/solc:stable --help
|
docker run ethereum/solc:stable --help
|
||||||
|
|
||||||
For example, You can specify release build versions in the tag for the 0.5.4 release.
|
You can specify release build versions in the tag. For example:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
docker run ethereum/solc:0.5.4 --help
|
docker run ethereum/solc:0.5.4 --help
|
||||||
|
|
||||||
To use the Docker image to compile Solidity files on the host machine, mount a
|
To use the Docker image to compile Solidity files on the host machine, mount a
|
||||||
local folder for input and output, and specify the contract to compile. For example.
|
local folder for input and output, and specify the contract to compile. For example:
|
||||||
|
|
||||||
.. code-block:: bash
|
.. code-block:: bash
|
||||||
|
|
||||||
@ -183,7 +183,7 @@ If you need a specific version of Solidity you can install a
|
|||||||
Homebrew formula directly from Github.
|
Homebrew formula directly from Github.
|
||||||
|
|
||||||
View
|
View
|
||||||
`solidity.rb commits on Github <https://github.com/ethereum/homebrew-ethereum/commits/master/solidity.rb>`_.
|
`solidity.rb commits on GitHub <https://github.com/ethereum/homebrew-ethereum/commits/master/solidity.rb>`_.
|
||||||
|
|
||||||
Copy the commit hash of the version you want and check it out on your machine.
|
Copy the commit hash of the version you want and check it out on your machine.
|
||||||
|
|
||||||
@ -224,8 +224,8 @@ out-of-the-box but it is also meant to be friendly to third-party tools:
|
|||||||
(via git, HTTPS, IPFS or just have it cached locally) and verify hashes of the binaries
|
(via git, HTTPS, IPFS or just have it cached locally) and verify hashes of the binaries
|
||||||
after downloading them, you do not have to use HTTPS for the binaries themselves.
|
after downloading them, you do not have to use HTTPS for the binaries themselves.
|
||||||
|
|
||||||
The same binaries are in most cases available on the `Solidity release page on Github`_. The
|
The same binaries are in most cases available on the `Solidity release page on GitHub`_. The
|
||||||
difference is that we do not generally update old releases on the Github release page. This means
|
difference is that we do not generally update old releases on the GitHub release page. This means
|
||||||
that we do not rename them if the naming convention changes and we do not add builds for platforms
|
that we do not rename them if the naming convention changes and we do not add builds for platforms
|
||||||
that were not supported at the time of release. This only happens in ``solc-bin``.
|
that were not supported at the time of release. This only happens in ``solc-bin``.
|
||||||
|
|
||||||
@ -301,7 +301,7 @@ This means that:
|
|||||||
.. _IPFS: https://ipfs.io
|
.. _IPFS: https://ipfs.io
|
||||||
.. _Swarm: https://swarm-gateways.net/bzz:/swarm.eth
|
.. _Swarm: https://swarm-gateways.net/bzz:/swarm.eth
|
||||||
.. _solc-bin: https://github.com/ethereum/solc-bin/
|
.. _solc-bin: https://github.com/ethereum/solc-bin/
|
||||||
.. _Solidity release page on github: https://github.com/ethereum/solidity/releases
|
.. _Solidity release page on GitHub: https://github.com/ethereum/solidity/releases
|
||||||
.. _sha3sum: https://github.com/maandree/sha3sum
|
.. _sha3sum: https://github.com/maandree/sha3sum
|
||||||
.. _keccak256() function from ethereumjs-util: https://github.com/ethereumjs/ethereumjs-util/blob/master/docs/modules/_hash_.md#const-keccak256
|
.. _keccak256() function from ethereumjs-util: https://github.com/ethereumjs/ethereumjs-util/blob/master/docs/modules/_hash_.md#const-keccak256
|
||||||
.. _WebAssembly builds: https://emscripten.org/docs/compiling/WebAssembly.html
|
.. _WebAssembly builds: https://emscripten.org/docs/compiling/WebAssembly.html
|
||||||
@ -461,11 +461,11 @@ you should fork Solidity and add your personal fork as a second remote:
|
|||||||
This method will result in a pre-release build leading to e.g. a flag
|
This method will result in a pre-release build leading to e.g. a flag
|
||||||
being set in each bytecode produced by such a compiler.
|
being set in each bytecode produced by such a compiler.
|
||||||
If you want to re-build a released Solidity compiler, then
|
If you want to re-build a released Solidity compiler, then
|
||||||
please use the source tarball on the github release page:
|
please use the source tarball on the GitHub release page:
|
||||||
|
|
||||||
https://github.com/ethereum/solidity/releases/download/v0.X.Y/solidity_0.X.Y.tar.gz
|
https://github.com/ethereum/solidity/releases/download/v0.X.Y/solidity_0.X.Y.tar.gz
|
||||||
|
|
||||||
(not the "Source code" provided by github).
|
(not the "Source code" provided by GitHub).
|
||||||
|
|
||||||
Command-Line Build
|
Command-Line Build
|
||||||
------------------
|
------------------
|
||||||
|
@ -461,7 +461,7 @@ is transformed to
|
|||||||
}
|
}
|
||||||
|
|
||||||
This eases the rest of the optimization process because we can ignore
|
This eases the rest of the optimization process because we can ignore
|
||||||
the complicated scoping rules of the for loop initialisation block.
|
the complicated scoping rules of the for loop initialization block.
|
||||||
|
|
||||||
.. _var-decl-initializer:
|
.. _var-decl-initializer:
|
||||||
|
|
||||||
@ -1196,7 +1196,7 @@ The FullInliner replaces certain calls of certain functions
|
|||||||
by the function's body. This is not very helpful in most cases, because
|
by the function's body. This is not very helpful in most cases, because
|
||||||
it just increases the code size but does not have a benefit. Furthermore,
|
it just increases the code size but does not have a benefit. Furthermore,
|
||||||
code is usually very expensive and we would often rather have shorter
|
code is usually very expensive and we would often rather have shorter
|
||||||
code than more efficient code. In same cases, though, inlining a function
|
code than more efficient code. In some cases, though, inlining a function
|
||||||
can have positive effects on subsequent optimizer steps. This is the case
|
can have positive effects on subsequent optimizer steps. This is the case
|
||||||
if one of the function arguments is a constant, for example.
|
if one of the function arguments is a constant, for example.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user