cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Some more clarifications about remappings.

Browse Source
This commit is contained in:
chriseth 2016-01-13 17:34:59 +01:00
parent 154dd8cb02
commit 9ed15c40c6
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/layout-of-source-files.rst
View File

@ -45,7 +45,6 @@ filesystem, it can also map to resources discovered via e.g. ipfs, http or git.
Use in actual Compilers Use in actual Compilers
----------------------- -----------------------
When the compiler is invoked, it is not only possible to specify how to When the compiler is invoked, it is not only possible to specify how to
discover the first element of a path, but it is possible to specify path prefix discover the first element of a path, but it is possible to specify path prefix
remappings so that e.g. `github.com/ethereum/dapp-bin/library` is remapped to remappings so that e.g. `github.com/ethereum/dapp-bin/library` is remapped to
@ -54,16 +53,33 @@ remapping keys are prefixes of each other, the longest is tried first. This
allows for a "fallback-remapping" with e.g. `""` maps to allows for a "fallback-remapping" with e.g. `""` maps to
`"/usr/local/include/solidity"`. `"/usr/local/include/solidity"`.
**solc**:
For solc (the commandline compiler), these remappings are provided as `key=value` For solc (the commandline compiler), these remappings are provided as `key=value`
arguments, where the `=value` part is optional (and defaults to key in that arguments, where the `=value` part is optional (and defaults to key in that
case). All remapping values that are regular files are compiled (including case). All remapping values that are regular files are compiled (including
their dependencies). This mechanism is completely backwards-compatible (as long their dependencies). This mechanism is completely backwards-compatible (as long
as no filename contains a =) and thus not a breaking change. as no filename contains a =) and thus not a breaking change.
So as an example, if you clone
`github.com/ethereum/dapp-bin/` locally to `/usr/local/dapp-bin`, you can use
the following in your source file:
`import "github.com/ethereum/dapp-bin/library/iterable_mapping.sol" as it_mapping;`
and then run the compiler as
`solc github.com/ethereum/dapp-bin/=/usr/local/dapp-bin/ source.sol`
**browser-solidity**:
The `browser-based compiler <https://chriseth.github.io/browser-solidity>`_ The `browser-based compiler <https://chriseth.github.io/browser-solidity>`_
provides an automatic remapping for github and will also automatically retrieve the file: provides an automatic remapping for github and will also automatically retrieve
the file over the network:
You can import the iterable mapping by e.g. You can import the iterable mapping by e.g.
`import "github.com/ethereum/dapp-bin/library/iterable_mapping.sol"; as it_mapping;`. `import "github.com/ethereum/dapp-bin/library/iterable_mapping.sol" as it_mapping;`.
Other source code providers may be added in the future.
.. index:: ! comment, natspec .. index:: ! comment, natspec