Commit Graph

2364 Commits

Author SHA1 Message Date
chriseth
aa8107f45a Conditional strings for Whiskers. 2020-04-27 11:07:56 +02:00
Noel Maersk
a481ea719f
docs: use Yul lexer to highlight Yul code segments.
Many commits squashed; turns out that with the combination of:

* Python v2.7,
* Sphinx v1.8.5, and
* Pygments v2.3.1

versions (old!) used in the CI, the only viable approach is:

* to use `code-block` directives with explicit language specification,
* to provide no file-local default using `highlight`, and
* to set language as `none` for grammar specifications.

Underlying are the following issues (again, for the old versions
listed above):

* Generic RST `code` doesn't work when language is `none`:

    Warning, treated as error:
    /root/project/docs/yul.rst:430:Cannot analyze code. No Pygments lexer found for "none".

  Additionally, it might be trying to fall back to the default
  (Solidity) if left unspecified.

* If a file-local default is specified using `highlight`, then
  `code-block` _must_ also provide a language:

    Warning, treated as error:
    /root/project/docs/yul.rst:185:Error in "code-block" directive:
    1 argument(s) required, 0 supplied.

* Sphinx seems to try the file-local default "yul" (specified with
  `highlight`) on `code` marked having language `json`:

    Warning, treated as error:
    /root/project/docs/yul.rst:130:Could not lex literal_block as "yul". Highlighting skipped.

* The only well-lexed highlighter for two of the three grammar
  specifications is `peg`, but it was added in Pygments v2.6.
  One of the grammars - in the "Formal Specification" section,
  the one after "We will use a destructuring notation for the
  AST nodes." - _must_ be left unhighlighted, with language set
  to `none`: all lexers do really poorly.

... And one should never, ever start treating warnings as mere
warnings, without having exhausted all other options.

Otherwise, it's a slippery slope, - and look where that brought
Gandhi: to being a strawman in every lousy argument to be had!..
2020-04-26 20:48:07 +03:00
Alexander Arlt
55eda85a30 docs/cheatsheet.rst: Add `type(I).interfaceId` description. 2020-04-24 08:09:45 -05:00
chriseth
d429d20b0b Restructure documentation and improve TOC. 2020-04-23 19:05:42 +02:00
hrkrshnn
48ff9fd4d6 Tests, Changelog and updated grammar 2020-04-23 17:27:37 +05:30
chriseth
a371910674
Merge pull request #8642 from ethereum/interfaceid
Add support for interfaceId.
2020-04-23 12:24:49 +02:00
chriseth
393f922081
Merge pull request #8747 from ethereum/smt_chc_docs_internal_calls
Add internal function calls to CHC docs
2020-04-23 12:14:54 +02:00
chriseth
2ea2267179
Merge pull request #8735 from ethereum/bugs-url
Add missing blog URLs to bugs.json
2020-04-23 12:06:41 +02:00
chriseth
615668bfb4
Explain nonpayable
Fixes https://github.com/ethereum/solidity/issues/8736
2020-04-23 01:35:21 +02:00
Leonardo Alt
1cb68b1be7 Add internal function calls to CHC docs 2020-04-22 20:15:01 +02:00
Alex Beregszaszi
fe383fbd7a Add missing blog URLs to bugs.json 2020-04-22 12:03:10 +01:00
chriseth
8c60b2c847
Merge pull request #8714 from iamdefinitelyahuman/develop
Add dark mode to documentation
2020-04-20 21:36:17 +02:00
iamdefinitelyahuman
d59706e5f5 docs: fix formatting errors and style inconsistencies 2020-04-20 20:24:31 +04:00
iamdefinitelyahuman
c59854c4bb docs: add dark mode to documentation 2020-04-20 20:23:45 +04:00
chriseth
6900544f0d
Merge pull request #8651 from a3d4/modify-evmone-version
Update evmone version to v0.4 in docs and scripts
2020-04-20 16:49:10 +02:00
Alexander Arlt
3754a86ab2 Add support for interfaceID. 2020-04-16 12:17:40 -05:00
a3d4
760ae7f584 Update evmone version to v0.4 in docs and scripts 2020-04-14 14:34:47 +02:00
Evan Saulpaugh
1a67b86f24
clarify description of padding for int<M> types 2020-04-10 02:23:13 -05:00
Evan Saulpaugh
1ef24562a9
change positive to non-negative 2020-04-10 02:17:57 -05:00
Chris Chinchilla
eaff5c58a9 Update contributing doc to clarify tests
Fix line endings

Update docs/contributing.rst

Co-Authored-By: Bhargava Shastry <bhargava.shastry@ethereum.org>

Remove duplication

Add back URL to correct evmone version

Add Istanbul
2020-04-09 15:28:38 +02:00
chriseth
474b72e3f4 Prepare 0.6.6 2020-04-09 11:55:21 +02:00
Black3HDF
c7e0983cef
fix link 2020-04-08 22:46:59 +08:00
a3d4
aba0b2957c Fix tuple assignments with multi-slot components. 2020-04-07 18:39:25 +02:00
chriseth
3f52ee43a8
Merge pull request #8581 from ethereum/immutableDebug
Debug information for immutable references.
2020-04-06 14:22:31 +02:00
chriseth
30c9705c14 Update buglist. 2020-04-06 13:17:01 +02:00
Daniel Kirchner
4a23ce087c Document immutable references output. 2020-04-06 11:22:07 +02:00
Kamil Śliwak
303345b12c reference-types.rst: Fix incorrectly wrapped line in the array slice section 2020-04-06 10:15:42 +02:00
Kamil Śliwak
1847536d6d reference-types.rst: Minor text correction, itself -> themselves 2020-04-06 10:15:13 +02:00
Daniel Kirchner
06d184712c Add buglist entry. 2020-04-01 19:01:32 +02:00
chriseth
9c4a02db0f Documentation for immutables. 2020-04-01 11:37:11 +02:00
chriseth
3f26f7fb7e
Merge pull request #8548 from mijovic/testDocsPragma
Enabling pragma with > in minimum version check
2020-04-01 00:31:15 +02:00
Djordje Mijovic
64ae889dd7 Enabling pragma with > in minimum version check 2020-03-31 23:50:24 +02:00
Christian Parpart
9cc967eb3a Removing grammar.txt in favor of Solidity.g4 (ANTLR based grammar) 2020-03-30 11:35:34 +02:00
Christian Parpart
0e66e07e5c Add antlr-based grammar and test it. 2020-03-24 11:07:51 +01:00
Erik Kundt
50c22f0800 Adds script which compiles docs example with minimum compiler version. 2020-03-18 19:27:38 +01:00
chriseth
1587486334 Merge tag 'v0.5.17' into develop 2020-03-17 19:50:09 +01:00
Mathias Baumann
e2db9d7ef3 Disallow private functions from being overridden 2020-03-17 16:15:59 +01:00
chriseth
435c9dae71
Merge pull request #8290 from gitpusha/docs-update-staticcall-gascounting
added note about gas counting and its effect on staticall.gas(gasLimi…
2020-03-17 10:47:30 +01:00
gitpusha
1b63b8822e Added note recommending to avoid relying on hardcoded gas values 2020-03-16 18:22:32 +01:00
Mathias Baumann
4d99a54d05 Fix broken yul-object link in docs 2020-03-16 17:34:18 +01:00
Mathias Baumann
151bc71f49 Add private-can-be-overridden bug to buglist 2020-03-16 12:23:57 +01:00
Leonardo Alt
1b17815808 SMTChecker docs test may issue a warning 2020-03-10 15:41:49 +01:00
chriseth
d541e222a2 Prepare changelog for 0.6.4. 2020-03-10 10:46:13 +01:00
chriseth
e12fb5e962
Merge pull request #8446 from ethereum/fixSaltPrecomputation
[DOCS] Fix pre-computation of salted address.
2020-03-09 16:36:11 +01:00
chriseth
2b804017fe Fix yul links. 2020-03-09 09:42:03 +01:00
chriseth
cdfb872389 [DOCS] Fix pre-computation of salted address. 2020-03-08 19:15:21 +01:00
Djordje Mijovic
58c6b90705 Deprecated warning for .value() and .gas() on function and constructror calls 2020-03-04 12:51:49 +01:00
chriseth
45041e5d3a Allow access to `_slot` for local storage pointer variables. 2020-02-25 14:28:04 +01:00
Chris Chinchilla
9641d93167 Clarify array copying semantics 2020-02-18 16:50:34 +02:00
chriseth
4115553344 Prepare changelog for 0.6.3 release. 2020-02-18 12:52:58 +01:00
Leonardo Alt
36928c7a35 Add reason string for internal reverts 2020-02-10 11:57:20 -03:00
Brian L. McMichael
b39814a4f8
Conform constants to style guide
Constants should conform to style guide at https://solidity.readthedocs.io/en/latest/style-guide.html#constants
2020-02-06 16:39:09 -05:00
Mathias L. Baumann
bd54176c1a
Merge pull request #8248 from ethereum/functionCallOptionFollowUp
Fix function call option parsing and add to grammar.
2020-02-05 18:01:54 +01:00
chriseth
5247a6600e Fix function call option parsing and add to grammar. 2020-02-05 16:59:02 +01:00
Erik Kundt
f2701db0aa Adds documentation for Solidity source upgrader. 2020-02-05 16:52:54 +01:00
chriseth
8a7e1d651a
Merge pull request #8234 from ethereum/contractsAsMappingKeys
Contract types as mapping keys.
2020-02-04 17:58:48 +01:00
Daniel Kirchner
d3cbfb0c5c Allow user-defined types as mapping keys in parser and restrict to contracts during type checking. 2020-02-04 17:22:03 +01:00
chriseth
33f990a96a Fix style of documentation config. 2020-02-04 17:01:13 +01:00
chriseth
a3b7c73e3f Some clarification about try-catch. 2020-02-03 14:21:37 +01:00
Chris Chinchilla
1b1a0a6953 Add return area clarification 2020-01-31 10:37:12 +01:00
Nicolas
49514bc577
fix a logical contradiction in new version of § Example
"if (x > 100) throw;" --> "require(x <= 100);"
2020-01-29 08:21:48 +01:00
Nicolas
dc29888601
fix parenthesis error in § "Semantic and Syntactic Changes" of v0.5.0 Breaking Changes 2020-01-29 08:13:53 +01:00
Erik Kundt
a2f28f0a9d Fixes copyright in readthedocs config. 2020-01-28 16:38:20 +01:00
chriseth
99202e85ce Polish changelog for 0.6.2. 2020-01-27 09:41:15 +01:00
Rafael Lorandi
6f0506637e Fix Gentoo overlay link text 2020-01-27 09:32:55 +01:00
chriseth
bc77132161 Make yul example compilable. 2020-01-24 01:11:12 +01:00
chriseth
981ed5f773 Documentation for function call options. 2020-01-23 21:20:01 +01:00
Jason Cobb
86145adac8
Update documentation for interface inheritance 2020-01-22 09:40:40 -05:00
Victor Baranov
e7c109898e Fix the latest byte of metadata hash encoding in the docs 2020-01-20 17:13:40 +03:00
chriseth
1d6b42eaa4 Combine Yul documentation sections. 2020-01-16 18:57:04 +01:00
Alex Beregszaszi
8d7fd90593 Remove LLL from docs 2020-01-15 13:18:24 +00:00
Gonçalo Sá
b6ddb32497 Update grammar to include special functions (constructor, fallback, receive ether) 2020-01-13 19:41:36 +00:00
Gonçalo Sá
57fcab80fc Update grammar to represent optionality in catch clauses parameter list 2020-01-09 23:12:24 +00:00
chriseth
b68ea243fc Fix comment. 2020-01-08 18:37:46 +01:00
Chris Chinchilla
bd7ac57f32 Add new resources and change sort order 2020-01-08 10:11:08 +01:00
chriseth
7772ee145c Change naming to "destructible". 2020-01-08 09:17:59 +01:00
William Entriken
6d068b6331 Reduce usage of the word "kill" 2020-01-07 11:18:10 +01:00
chriseth
943af71d3d
Merge pull request #8092 from ethereum/chriseth-patch-1
Update the standard-json yul switch to the 0.6.0 behaviour.
2020-01-03 13:39:59 +01:00
chriseth
30a2d712c0 Bug list entry. 2020-01-03 00:04:01 +01:00
chriseth
42712a78ce Merge branch 'release-0.5' into develop. 2020-01-02 23:49:43 +01:00
chriseth
bdd9f215cb
Update the yul switch to the 0.6.0 behaviour. 2020-01-02 23:01:50 +01:00
Leonardo Alt
026f7c37af Review 1 2020-01-02 18:51:21 +01:00
chriseth
8328f826a1 Bug list entry. 2020-01-02 18:51:21 +01:00
chriseth
c70bdf2b2c
Merge pull request #8082 from ethereum/fixRedundantContinue
Fix redundant assignment removal in combination with break / continue.
2020-01-02 18:46:26 +01:00
Leonardo Alt
d972a10b4f Review 1 2020-01-02 12:43:56 +01:00
elenadimitrova
27727a7af3 Rename solium to ethlint 2020-01-02 12:39:10 +02:00
chriseth
29c0b73dff Bug list entry. 2019-12-29 16:08:15 +01:00
chriseth
93804f8be3 Update bug list. 2019-12-17 21:38:30 +01:00
chriseth
b6fc703a27 Merge remote-tracking branch 'origin/release' into HEAD 2019-12-17 19:47:59 +01:00
chriseth
588f3aedb3
Merge pull request #8035 from ethereum/updateRef2
[DOC] Update reference types.
2019-12-17 17:27:15 +01:00
chriseth
9a39a16c47
Merge pull request #8030 from ethereum/docs-non-language-breaking
[docs] Non-language related breaking changes
2019-12-17 17:14:41 +01:00
chriseth
f913406c65 Bug list entry about yul loop mload bug. 2019-12-17 17:08:27 +01:00
chriseth
35c24befb4 Increment version number. 2019-12-17 17:08:27 +01:00
Erik Kundt
477b062a64 Adds non-language related breaking changes to docs. 2019-12-17 17:02:04 +01:00
chriseth
d6d953f829
Merge pull request #8027 from ethereum/v06-pragma
[DOCS] Update pragma versions for 0.6.0
2019-12-17 16:57:19 +01:00
chriseth
11b90301b0 Update reference types. 2019-12-17 14:24:18 +01:00
chriseth
cf6f6a51b0
Merge pull request #8029 from ethereum/referenceTypes1
Update reference types (1).
2019-12-17 13:53:01 +01:00
chriseth
d13438eed8
Merge pull request #8023 from ethereum/updateConversionFor060
Update type conversions for 0.6.0.
2019-12-17 12:33:21 +01:00
chriseth
16c2e0ad3e Update type conversions for 0.6.0. 2019-12-16 20:34:48 +01:00
chriseth
a8598a774a Update reference types (1). 2019-12-16 18:30:35 +01:00