diff options
| author | Leonardo Alt <leo@ethereum.org> | 2018-08-21 22:09:53 +0800 |
|---|---|---|
| committer | Leonardo Alt <leo@ethereum.org> | 2018-09-07 00:42:21 +0800 |
| commit | 9927964d218ac234e50c1818be655d92b3b2887b (patch) | |
| tree | a20c19fa0881cc9baee22cc1f5580e8d16c8019e /docs/bugs.rst | |
| parent | c57a60833d96f9f6a568c3b85b9b6edecee8fe4a (diff) | |
| download | dexon-solidity-9927964d218ac234e50c1818be655d92b3b2887b.tar.gz dexon-solidity-9927964d218ac234e50c1818be655d92b3b2887b.tar.zst dexon-solidity-9927964d218ac234e50c1818be655d92b3b2887b.zip | |
Buglist check script supports json paths
Diffstat (limited to 'docs/bugs.rst')
| -rw-r--r-- | docs/bugs.rst | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/docs/bugs.rst b/docs/bugs.rst index 6f315a65..f7522183 100644 --- a/docs/bugs.rst +++ b/docs/bugs.rst @@ -57,13 +57,18 @@ conditions means that the optimizer has to be switched on to enable the bug. If no conditions are given, assume that the bug is present. check - This field contains JavaScript regular expressions that are to be matched - against the source code ("source-regex") to find out if the - smart contract contains the bug or not. If there is no match, - then the bug is very likely not present. If there is a match, - the bug might be present. For improved accuracy, the regular - expression should be applied to the source code after stripping + This field contains different checks that report whether the smart contract + contains the bug or not. The first type of check are Javascript regular + expressions that are to be matched against the source code ("source-regex") + if the bug is present. If there is no match, then the bug is very likely + not present. If there is a match, the bug might be present. For improved + accuracy, the checks should be applied to the source code after stripping comments. + The second type of check are patterns to be checked on the compact AST of + the Solidity program ("ast-compact-json-path"). The specified search query + is a `JsonPath <https://github.com/json-path/JsonPath>`_ expression. + If at least one path of the Solidity AST matches the query, the bug is + likely present. .. literalinclude:: bugs.json :language: js |