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

Merge pull request #7104 from ethereum/docs-capped

Browse Source 
[DOCS] Reduce line breaks in code comments to help with scrolling
This commit is contained in:
chriseth 2019-07-15 16:59:38 +02:00 committed by GitHub
commit cb13f8f1bf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/using-the-compiler.rst
View File

@ -193,15 +193,18 @@ Input Description
// disabled by default // disabled by default
"enabled": true, "enabled": true,
// Optimize for how many times you intend to run the code. // Optimize for how many times you intend to run the code.
// Lower values will optimize more for initial deployment cost, higher values will optimize more for high-frequency usage. // Lower values will optimize more for initial deployment cost, higher
// values will optimize more for high-frequency usage.
"runs": 200, "runs": 200,
// Switch optimizer components on or off in detail. // Switch optimizer components on or off in detail.
// The "enabled" switch above provides two defaults which can be // The "enabled" switch above provides two defaults which can be
// tweaked here. If "details" is given, "enabled" can be omitted. // tweaked here. If "details" is given, "enabled" can be omitted.
"details": { "details": {
// The peephole optimizer is always on if no details are given, use details to switch it off. // The peephole optimizer is always on if no details are given,
// use details to switch it off.
"peephole": true, "peephole": true,
// The unused jumpdest remover is always on if no details are given, use details to switch it off. // The unused jumpdest remover is always on if no details are given,
// use details to switch it off.
"jumpdestRemover": true, "jumpdestRemover": true,
// Sometimes re-orders literals in commutative operations. // Sometimes re-orders literals in commutative operations.
"orderLiterals": false, "orderLiterals": false,
@ -224,16 +227,21 @@ Input Description
} }
} }
}, },
"evmVersion": "byzantium", // Version of the EVM to compile for. Affects type checking and code generation. Can be homestead, tangerineWhistle, spuriousDragon, byzantium, constantinople or petersburg // Version of the EVM to compile for.
// Affects type checking and code generation. Can be homestead,
// tangerineWhistle, spuriousDragon, byzantium, constantinople or petersburg
"evmVersion": "byzantium",
// Metadata settings (optional) // Metadata settings (optional)
"metadata": { "metadata": {
// Use only literal content and not URLs (false by default) // Use only literal content and not URLs (false by default)
"useLiteralContent": true "useLiteralContent": true
}, },
// Addresses of the libraries. If not all libraries are given here, it can result in unlinked objects whose output data is different. // Addresses of the libraries. If not all libraries are given here,
// it can result in unlinked objects whose output data is different.
"libraries": { "libraries": {
// The top level key is the the name of the source file where the library is used. // The top level key is the the name of the source file where the library is used.
// If remappings are used, this source file should match the global path after remappings were applied. // If remappings are used, this source file should match the global path
// after remappings were applied.
// If this key is an empty string, that refers to a global level. // If this key is an empty string, that refers to a global level.
"myFile.sol": { "myFile.sol": {
"MyLib": "0x123123..." "MyLib": "0x123123..."
@ -336,7 +344,8 @@ Output Description
"formattedMessage": "sourceFile.sol:100: Invalid keyword" "formattedMessage": "sourceFile.sol:100: Invalid keyword"
} }
], ],
// This contains the file-level outputs. In can be limited/filtered by the outputSelection settings. // This contains the file-level outputs.
// It can be limited/filtered by the outputSelection settings.
"sources": { "sources": {
"sourceFile.sol": { "sourceFile.sol": {
// Identifier of the source (used in source maps) // Identifier of the source (used in source maps)
@ -347,7 +356,8 @@ Output Description
"legacyAST": {} "legacyAST": {}
} }
}, },
// This contains the contract-level outputs. It can be limited/filtered by the outputSelection settings. // This contains the contract-level outputs.
// It can be limited/filtered by the outputSelection settings.
"contracts": { "contracts": {
"sourceFile.sol": { "sourceFile.sol": {
// If the language used has no contract names, this field should equal to an empty string. // If the language used has no contract names, this field should equal to an empty string.
@ -380,7 +390,8 @@ Output Description
// If given, this is an unlinked object. // If given, this is an unlinked object.
"linkReferences": { "linkReferences": {
"libraryFile.sol": { "libraryFile.sol": {
// Byte offsets into the bytecode. Linking replaces the 20 bytes located there. // Byte offsets into the bytecode.
// Linking replaces the 20 bytes located there.
"Library1": [ "Library1": [
{ "start": 0, "length": 20 }, { "start": 0, "length": 20 },
{ "start": 200, "length": 20 } { "start": 200, "length": 20 }