aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorchriseth <chris@ethereum.org>2018-12-11 20:58:02 +0800
committerchriseth <chris@ethereum.org>2018-12-11 22:48:12 +0800
commitfe87cc7eb0508a7330b90c72f4dbc260948d6b43 (patch)
tree34067114bd9f48297d3f09846076005ad1e1d89f
parent5355380f80eeb9fac49dd28a32b08ba88e662c87 (diff)
downloaddexon-solidity-fe87cc7eb0508a7330b90c72f4dbc260948d6b43.tar
dexon-solidity-fe87cc7eb0508a7330b90c72f4dbc260948d6b43.tar.gz
dexon-solidity-fe87cc7eb0508a7330b90c72f4dbc260948d6b43.tar.bz2
dexon-solidity-fe87cc7eb0508a7330b90c72f4dbc260948d6b43.tar.lz
dexon-solidity-fe87cc7eb0508a7330b90c72f4dbc260948d6b43.tar.xz
dexon-solidity-fe87cc7eb0508a7330b90c72f4dbc260948d6b43.tar.zst
dexon-solidity-fe87cc7eb0508a7330b90c72f4dbc260948d6b43.zip
Improve explanation how to get abi output.
-rw-r--r--docs/using-the-compiler.rst22
1 files changed, 17 insertions, 5 deletions
diff --git a/docs/using-the-compiler.rst b/docs/using-the-compiler.rst
index 9ba6caa5..016ea6e9 100644
--- a/docs/using-the-compiler.rst
+++ b/docs/using-the-compiler.rst
@@ -200,15 +200,27 @@ Input Description
"MyLib": "0x123123..."
}
}
- // The following can be used to select desired outputs.
- // If this field is omitted, then the compiler loads and does type checking, but will not generate any outputs apart from errors.
- // The first level key is the file name and the second is the contract name, where empty contract name refers to the file itself,
- // while the star refers to all of the contracts.
+ // The following can be used to select desired outputs based
+ // on file and contract names.
+ // If this field is omitted, then the compiler loads and does type checking,
+ // but will not generate any outputs apart from errors.
+ // The first level key is the file name and the second level key is the contract name.
+ // An empty contract name is used for outputs that are not tied to a contract
+ // but to the whole source file like the AST.
+ // A star as contract name refers to all contracts in the file.
+ // Similarly, a star as a file name matches all files.
+ // To select all outputs the compiler can possibly generate, use
+ // "outputSelection: { "*": { "*": [ "*" ], "": [ "*" ] } }"
+ // but note that this might slow down the compilation process needlessly.
//
// The available output types are as follows:
- // abi - ABI
+ //
+ // File level (needs empty string as contract name):
// ast - AST of all source files
// legacyAST - legacy AST of all source files
+ //
+ // Contract level (needs the contract name or "*"):
+ // abi - ABI
// devdoc - Developer documentation (natspec)
// userdoc - User documentation (natspec)
// metadata - Metadata