Commit Graph

2914 Commits

Author SHA1 Message Date
Kamil Śliwak
8c5ae508f9 Use html_extra_template_renderer to replace the current robots.txt rendering script 2021-07-15 13:29:27 +02:00
Kamil Śliwak
2bebc2f822 Create a local html_extra_template_renderer Sphinx extension 2021-07-15 13:29:27 +02:00
Kamil Śliwak
d4a86b2b10 docs/conf.py: Remove unused /utils directory from python path 2021-07-15 13:14:39 +02:00
Kamil Śliwak
693b88e5f8 docs: Force highlighter to work despite errors on snippets that it cannot parse 2021-07-15 10:14:00 +02:00
Kamil Śliwak
d8260a1e93 docs: Replace > with >= in pragmas to work around the highligher being unable to process the former 2021-07-15 10:14:00 +02:00
Kamil Śliwak
310a35185a docs: Fix some mislabeled bash and text blocks 2021-07-15 10:14:00 +02:00
Kamil Śliwak
235a39eaef docs: Fix syntax errors in JSON snippets and enable JavaScript highlighting for them 2021-07-15 10:14:00 +02:00
Kamil Śliwak
f3a5c27852 docs: Replace a few remaining :: blocks with .. code-block:: 2021-07-15 10:14:00 +02:00
Kamil Śliwak
b513ca1f7e ir-breaking-changes.rst: Fix too short header frame 2021-07-15 10:13:32 +02:00
Kamil Śliwak
42f982c063 docs: Fix indentation in some of the code snippets 2021-07-15 10:13:32 +02:00
Kamil Śliwak
ce79e2515b docs: Fix badly indented lists 2021-07-15 10:13:30 +02:00
Kamil Śliwak
312ac4a255 docs: Remove deprecated escape characters from the list of available escapes 2021-07-14 21:28:20 +02:00
Kamil Śliwak
0aeb1ef47e Require sphinx-rtd-theme>= 0.5.2; older 2021-07-14 13:50:03 +02:00
CrimsonGlory
ab5898f11c
RHS->right hand side 2021-07-12 21:18:46 -03:00
chriseth
c3fa520c75
Merge pull request #11636 from ethereum/docs-clarify-struct-members-omitted-by-getters
[Docs] Clarify that non-byte array struct members are omitted by getters
2021-07-08 15:39:31 +02:00
chriseth
fec01c112a
Merge pull request #11616 from ethereum/issue-8191-yul
Test yul code blocks in documentation.
2021-07-08 15:37:01 +02:00
Marenz
d844d84b51 Test yul code blocks in documentation. 2021-07-08 14:59:05 +02:00
Kamil Śliwak
a1ca12a0a8 Clarify that non-byte array struct members are omitted by getters 2021-07-08 14:31:30 +02:00
chriseth
62934b60ca
Merge pull request #11605 from ethereum/issue-8191
isolate_tests: Extract code blocks from documentation using code block header
2021-07-08 14:28:47 +02:00
Kamil Śliwak
ddccd73a4b Fix outdated references to byte[] type (it's now bytes1[]) 2021-07-08 13:16:23 +02:00
Tony
510d74c1cd
Fix a Typo describing Layout in Storage 2021-07-07 19:29:44 -04:00
Simon Tian
f0ec3dd6a2
Update smtchecker.rst 2021-07-06 23:24:37 +08:00
Marenz
5291ca2dd4 isolate_tests: Extract code blocks from documentation using code block header 2021-07-06 16:57:05 +02:00
Bhargava Shastry
3e275335c7 Document difference in evaluation order of arguments of addmod/mulmod by old and new code gens. 2021-07-05 13:39:14 +02:00
Marenz
7f65f1cc02 Fix code-start headers in documentation 2021-07-01 15:17:42 +02:00
Alex Beregszaszi
37db29e9f1 Set preferred host in robots.txt 2021-06-28 21:26:00 +01:00
hrkrshnn
4c216395c6 [DOCS] Change code block into proper JSON
Reran `solc --storage-layout`, so the AST ids changed.
2021-06-28 17:27:33 +02:00
Amid Moeinzadeh
16fdfdc4eb Replace reference to `require by if`. 2021-06-28 15:45:07 +02:00
chriseth
2567eb46ba
Merge pull request #11477 from iskanderandrews/feature/docs-highlight-solc
[Docs]: Highlighting code snippets in .rst docs
2021-06-28 14:40:43 +02:00
iskanderandrews
a8e9d7a80d docs/
Enhancing all the .rst doc files by adding highlighting for the code snippets, including the following langs:
1. Solidity

2. bash

3. javascript

4. assembly
2021-06-25 12:33:55 +02:00
Kamil Śliwak
cd0ccd099b installing-solidity.rst: Clarify that when using urls in Standard JSON with a dockerized compiler it might still be necessary to mount a volume 2021-06-24 19:14:38 +02:00
chriseth
11564f7ec2
Merge pull request #11566 from ethereum/prepare086
Prepare release of 0.8.6.
2021-06-22 13:30:55 +02:00
chriseth
c502158c69 Prepare release of 0.8.6. 2021-06-22 11:39:15 +02:00
Kamil Śliwak
98c4830f2a docs/requirements.txt: Add minimum version for Sphinx 2021-06-21 20:54:35 +02:00
Kamil Śliwak
056e0d3751 docs: Suppress highlighting errors for snippets that cause errors in pygments-lexer-solidity 2021-06-21 20:54:35 +02:00
Kamil Śliwak
570ecf1cf1 Replace deprecated Sphinx mehods with newer equivalents 2021-06-21 20:54:31 +02:00
Kamil Śliwak
b7bbf6bd07 docs/contributing.rst: Don't use the default Solidity highlighting for shell and text snippets 2021-06-21 20:54:31 +02:00
chriseth
0df8a38e55 Support metadata via IR. 2021-06-21 18:20:31 +02:00
patekuru
5787bc921d
Update micropayment.rst 2021-06-19 08:50:51 -04:00
TaldenV
1d48b68637
Edit for clarity 2021-06-17 09:33:08 -05:00
jgoodall628
a344fd43bf
Grammar update for security-considerations.rst 2021-06-15 19:51:07 -05:00
Kamil Śliwak
59957b18dc Make missing settings.optimizer.enabled key in Standard JSON equivalent to setting it to false 2021-06-15 16:06:22 +02:00
chriseth
1bb65f80ef
Merge pull request #11495 from gqqnbig/patch-1
can not prefix with ``this.``
2021-06-14 13:21:58 +02:00
QQ喵
38af5180ac
Update docs/introduction-to-smart-contracts.rst
good for me

Co-authored-by: chriseth <chris@ethereum.org>
2021-06-14 17:24:23 +08:00
axeldelamarre
a5d3df532a
Update reference-types.rst 2021-06-10 19:58:11 +02:00
chriseth
a10d932991 Update bug list. 2021-06-10 11:08:03 +02:00
QQ喵
9a847deaee adopt cameel's version 2021-06-10 09:13:27 +08:00
Kamil Śliwak
5e3788874b Detailed documentation for path resolution in imports, including remappings, base path and standard input 2021-06-08 21:41:49 +02:00
QQ喵
aa37cc526a
can not prefix with `this.` 2021-06-08 15:09:18 +08:00
Mathias Baumann
d8ffdf11c8 Fix revert pruner modifying function flows wrong 2021-06-03 17:37:50 +02:00
Christian Parpart
d102c6c0d5 docs: Fixes link to genindex.html when clicked from within a page behind internals/ directory structure. 2021-05-31 14:17:58 +02:00
Harikrishnan Mulackal
9cffaddadc
Merge pull request #11448 from ethereum/docs-staticcall-value
[DOCS] Clarification about value option for staticcall.
2021-05-27 17:52:21 +02:00
William Entriken
74d5c51303 Fix comparison of bit shifts (unchecked overflow) to arithmetic (checked overflow)
Co-authored-by: Daniel Kirchner <daniel@ekpyron.org>

Co-authored-by: Harikrishnan Mulackal <webmail.hari@gmail.com>
2021-05-27 17:20:27 +02:00
hrkrshnn
b8d5d5744e Clarification about value option for staticcall. 2021-05-27 11:21:15 +02:00
chriseth
5672646bd7
Merge pull request #11439 from ethereum/docs-indexed-event-parameter-clarification
[docs] Clarification about indexed event parameters
2021-05-27 11:12:29 +02:00
Alex Beregszaszi
a3634934d1
Merge pull request #11431 from ethereum/lib-panic
Document the panic function of library deployment
2021-05-26 16:37:30 +01:00
Kamil Śliwak
11731f6091 docs: Mention reference types and 4 indexed slots for anonymous events 2021-05-26 16:52:33 +02:00
Alex Beregszaszi
bf2c82adca Document the panic function of library deployment 2021-05-26 15:51:46 +01:00
hrkrshnn
d5564a0304 Set default EVM version to Berlin 2021-05-26 12:23:06 +02:00
Keqi Huang
7b228a5b9a Renamed variable for clarity.
Co-authored-by: Kamil Śliwak <cameel2@gmail.com>
2021-05-25 11:41:41 +02:00
Maurelian
8b66a99be2 Some improvements to optimizer documentation
Co-authored-by: Harikrishnan Mulackal <webmail.hari@gmail.com>
2021-05-19 12:40:51 +02:00
William Entriken
b2ef1a46a4
Allow NatSpec to apply to Libraries just as Contracts 2021-05-14 00:08:18 -04:00
Alex Beregszaszi
99354a3b59 Upgrade evmone to 0.7.0 2021-05-12 16:56:23 +02:00
Alex Beregszaszi
7da62f0a1c Add missing blogpost to the buglist
And also change the old blog.ethereum.org links to blog.soliditylang.org
2021-05-12 13:57:53 +01:00
Alex Beregszaszi
94f7d281d0 Introduce unique numbering for bugs 2021-05-12 13:49:14 +01:00
Leo Alt
75afaf14f6 Docs 2021-05-11 15:30:19 +02:00
William Entriken
c70bc0c246
Specify how blockhash will act for invalid inputs, fixes #11364 2021-05-10 16:26:08 -04:00
William Entriken
88e33c9ea3
Match @return word styling to match @param (i.e. sentence case) 2021-05-08 01:14:22 -04:00
chriseth
9d156b52c4
Merge pull request #8868 from ethereum/functionEntryPoints
Note function entry points.
2021-05-05 11:08:44 +02:00
franzihei
13eec106f4 DOCS: update optimizer docs, harmonize spelling and add Yul-based optimizer module 2021-05-04 17:37:02 +02:00
chriseth
6413e36a9a Rename file. 2021-05-04 17:34:42 +02:00
chriseth
f9c94d7c42 Note function entry points. 2021-05-04 17:15:13 +02:00
franzihei
01d45ccc79 [Docs] Update information on contributing to translations 2021-05-04 15:04:43 +01:00
Christian Parpart
c794463788
Merge pull request #11317 from cxxboy/robots_update_script
script to automate updates to robots.txt (v2)
2021-04-28 00:55:32 +02:00
cxxboy
bd1fc0e88d script to automate updates to robots.txt #11199
Rewritten the script to work with a 'robots.txt' template file and we
generate the 'robots.txt' from the template when we execute the script.
It's found to be a better alternative to editing the 'robots.txt' file
in-place.
2021-04-27 17:54:55 -04:00
newbateni
fccdb59cef
change variable declaration place
in Test and TestPayable contract (in Fallback Function section) 
variables declared after  their use and I fix that
2021-04-27 15:36:16 +04:30
chriseth
e2d8005737 Add verbatim builtin. 2021-04-26 19:56:44 +02:00
chriseth
dce3006723
Merge pull request #11314 from ethereum/patch-1
[DOCS] Removed an overflow check and rely on checked arithmetic
2021-04-26 14:39:17 +02:00
chriseth
659da4bdc7
Merge pull request #11047 from ethereum/bytesToBytesNNConversion
Bytes to bytesNN conversion
2021-04-26 11:51:41 +02:00
Wade Dorrell
9e0c52f621 Removed an overflow check and rely on checked arithmetic
The check `require(amount < 1e60);` was removed because it's rather confusing to reason why it
prevents overflow.

Co-authored-by: Wade Dorrell <wade@dorrells.org>
2021-04-26 09:43:16 +02:00
Raphael Roullet
dda4b5d9d7 clarify init value by replacing zero with default value 2021-04-23 13:45:22 +02:00
Djordje Mijovic
337adee395 Documenting bytes to fixed bytes conversion.
Co-authored-by: chriseth <chris@ethereum.org>

Co-authored-by: Alex Beregszaszi <alex@rtfs.hu>
2021-04-23 13:30:19 +02:00
Kamil Śliwak
f479aceb4c 0.7.0 breaking changes: There were no external constructors 2021-04-22 21:57:20 +02:00
Harikrishnan Mulackal
ecf9a44dac
Merge pull request #11212 from ethereum/docs-asm
[DOCS] Added documentation about --asm flag
2021-04-22 18:11:24 +02:00
chriseth
cd13fcd758
Merge pull request #11155 from ethereum/missing-ir-semantic-changes
Docs: Update breaking IR changes documentation wrt expression evaluation order and dirty bits clean up
2021-04-22 16:32:18 +02:00
hrkrshnn
7882a2a89d Added documentation about --asm flag 2021-04-22 11:05:44 +02:00
franzihei
391343564b adding language influences page 2021-04-22 10:46:11 +02:00
Bhargava Shastry
6e74df8ab6 Update text on function argument evaluation order.
Co-authored-by: Kamil Śliwak <kamil.sliwak@codepoets.it>
2021-04-22 10:38:51 +02:00
Bhargava Shastry
abbe460813 Docs: Update breaking IR changes documentation wrt expression evaluation order and dirty bits clean up.
Co-authored-by: Kamil Śliwak <kamil.sliwak@codepoets.it>
Co-authored-by: chriseth <chris@ethereum.org>
2021-04-22 10:38:51 +02:00
chriseth
3aad6b239c Prepare changelog for 0.8.4. 2021-04-21 14:21:00 +02:00
Leonardo Alt
dd1865873e Choose contracts to be analyzed by the SMTChecker 2021-04-21 10:34:14 +02:00
Leonardo Alt
e3abde43f5 Change settings.modelChecker.targets to take an array instead of string 2021-04-19 17:53:03 +02:00
franzihei
8f17034eee Docs Contributing: Replace Google Meet with Jitsi Link 2021-04-13 16:01:36 +02:00
chriseth
0289994da5
Merge pull request #11221 from ethereum/fixCalldataDecodingOverflowBug
Fix calldata decoding overflow bug
2021-04-12 18:11:29 +02:00
chriseth
4912bfe639
Merge pull request #11229 from ethereum/antlrPath
Fix import paths in grammar and grammar testing details.
2021-04-12 16:30:41 +02:00
Daniel Kirchner
6fdfd8b62b Fix import path grammar and grammar testing details. 2021-04-12 14:54:36 +02:00
chriseth
680ea78f14
Merge pull request #11228 from aybehrouz/typo-fix-1
Fix a typo
2021-04-12 14:03:48 +02:00
chriseth
2ed17e4b43 Update tests. 2021-04-12 13:43:56 +02:00
Leonardo Alt
d89be74e4a Update docs 2021-04-08 21:03:39 +02:00
Behrouz
05e1b72709
Fix a typo 2021-04-08 22:50:40 +04:30
hrkrshnn
d9c57dd1fb Added index for safemath in docs 2021-04-08 17:39:04 +02:00
chriseth
7eb5e27e54
Merge pull request #11173 from ethereum/allowHexStringLiterals
Allow hex string literals in Yul.
2021-04-08 15:30:23 +02:00
Feiyang Tan
e36337d74b Type: strings 2021-04-08 15:21:33 +02:00
chriseth
f04adde664 Allow hex string literals in Yul. 2021-04-08 15:03:33 +02:00
Kamil Śliwak
b85ace0c30
Merge pull request #10972 from ethereum/docs_seo
[DOCS] Create robots.txt / Avoid search results showing docs of old Solidity versions
2021-04-06 15:57:32 +02:00
Harikrishnan Mulackal
717a1c9905
Update docs/080-breaking-changes.rst 2021-04-06 11:48:04 +02:00
Paul Razvan Berg
f1f236ad3b
docs: mention the v0.8 restrictions on negative unary 2021-04-03 18:04:32 +03:00
franzihei
2962d48593 Create robots.txt
Add explanatory text
2021-04-01 16:18:46 +02:00
chriseth
99a9bd1a63
Merge pull request #11176 from ethereum/random-doc-clarifications
Random documentation clarifications
2021-04-01 14:47:54 +02:00
Harikrishnan Mulackal
b605211d53
Merge pull request #11170 from ethereum/natspec-doc
Move improvements to the NatSpec documentation
2021-03-31 13:18:55 +02:00
Alex Beregszaszi
a99e0eb5cb Move improvements to the NatSpec documentation 2021-03-30 22:09:21 +01:00
chriseth
786ae2ceec Use errors in examples. 2021-03-30 23:04:32 +02:00
chriseth
0c1be06cba Documentation for custom errors. 2021-03-30 23:04:32 +02:00
chriseth
3353107779 Grammar for revert statement. 2021-03-30 21:15:46 +02:00
chriseth
b04b189959 Syntax for custom errors. 2021-03-30 21:15:18 +02:00
Kamil Śliwak
879f1b3e26 docs: Mention that low-level calls do not have an extcodesize check 2021-03-30 18:10:00 +02:00
Kamil Śliwak
8c6bbf607f docs: Explain that public library functions cannot be called internally from the outside 2021-03-30 18:10:00 +02:00
Kamil Śliwak
e1464fa4fb docs: Clarify how modifiers can affect function arguments and return values 2021-03-30 18:10:00 +02:00
Kamil Śliwak
67dea6c4f1 docs: Clarify which functions can be assigned to function variables 2021-03-30 14:31:51 +02:00
Kamil Śliwak
36f769662b docs: Add selector to the index 2021-03-30 14:31:51 +02:00
Kamil Śliwak
4053805356 docs: Yul create() and create2() return zero address on failure 2021-03-30 14:31:51 +02:00
Kamil Śliwak
797554668c docs: Newly allocated arrays are initialized with default values 2021-03-30 14:31:51 +02:00
Kamil Śliwak
259bf3f23a docs: The default visibility level for state variables is internal 2021-03-30 14:31:51 +02:00
Kamil Śliwak
60090fb4a9 docs: Calldata arguments are no longer limited to external functions 2021-03-30 14:31:51 +02:00
Kamil Śliwak
93bfc76216 docs: Mention explicitly that bitwise operators do not perform overflow/underflow checks 2021-03-30 14:31:51 +02:00
Leonardo Alt
dbd067d6db Report out of bounds index access 2021-03-30 10:28:48 +02:00
chriseth
bb49bc5892
Merge pull request #10418 from ethereum/function-specializer
Function specializer
2021-03-29 15:48:01 +02:00
hrkrshnn
bd5e47dc55 Changelog and adding the name to the doc 2021-03-29 11:02:31 +02:00
zayneio
3643024fb0 Fix typo in documentation 2021-03-28 17:02:18 -04:00
Alex Beregszaszi
522fdc158d Update pygments-lexer-solidity to 0.7.0 2021-03-25 20:29:05 +00:00
Djordje Mijovic
8da630f67b Updating pragma for docs example for bytes concat. 2021-03-25 17:11:39 +01:00
Christian Parpart
10ec49ddb9 Adds @custom:.... natspec example to the natspec-format documentation.
Co-authored-by: Harikrishnan Mulackal <webmail.hari@gmail.com>
2021-03-25 13:00:01 +01:00
Alex Beregszaszi
78a66787d4 Improve documentation about NatSpec
Clarify the connection to Doxygen.
2021-03-24 16:14:48 +00:00
Alex Beregszaszi
7ac891600d Properly capitalise UTF-8/ASCII in the documentation 2021-03-24 16:09:00 +00:00
Djordje Mijovic
fd0762b5ef Documenting bytes.concat.
Co-authored-by: chriseth <chris@ethereum.org>
2021-03-24 11:49:21 +01:00
Hongbo Miao
cbea8241dd docs: fix semantic version link 2021-03-23 23:17:24 +08:00
chriseth
a32e2e2130 Prepare changelog for 0.8.3. 2021-03-23 12:55:13 +01:00
hrkrshnn
30e08ee3a5 Changelog and test for the KeccakCaching bug 2021-03-23 11:09:00 +01:00
chriseth
8c583784c0
Merge pull request #11133 from ghidello/develop
[DOCS] Update OpenZeppelin's ECDSA contract URL
2021-03-22 15:02:34 +01:00
ghidello
b37723dc36
[DOCS] Update OpenZeppelin's ECDSA contract URL 2021-03-21 11:38:04 +01:00
Leonardo Alt
569afe711a SMTChecker tutorial and docs cleanup 2021-03-18 11:09:26 +01:00
Alex Beregszaszi
b477a7d163 Document the version/kind fields in the natspec documentation 2021-03-17 16:04:59 +00:00
Alex Beregszaszi
830bc8f88a Clarify the syntax of Solidity is not Python inspired 2021-03-16 17:11:01 +01:00
chriseth
26d8ee2f86 Set release date and sort changelog. 2021-03-02 16:54:01 +01:00
chriseth
ecdeb417c5 Documentation. 2021-03-02 16:53:31 +01:00
Kamil Śliwak
01f8005d04 Remove the last remains of --ast-json option 2021-02-23 12:39:19 +01:00
chriseth
7ac440f35b
Merge pull request #10968 from enjiniya-sama/develop
Update blind-auction.rst
2021-02-16 13:52:16 +01:00
Sanad
110b4df1ff
Update blind-auction.rst 2021-02-16 12:09:58 +00:00
dms-yondy
79e4c6da11 Fixed the grammer of a sentence in the docs 2021-02-16 09:44:31 +00:00
Kamil Śliwak
9d762f381f
Merge pull request #10932 from ssi91/add-sha256-field-to-the-docs
add sha256 field ot the docs
2021-02-15 17:48:02 +01:00