Integrate test documentation from Homestead docs #284
Conversation
|
@holgerd77 I created an account under "pirapira" and connected it with this GitHub @pirapira. |
|
@pirapira Ok, added you. |
|
what about the docs in cpp-ethereum repo? |
|
@winsvega the doc in |
|
@holgerd77 ready for review? |
|
@pirapira Yes, I was thinking about directly improving the docs a bit as well, but I'll probably do this in a separate PR. Think its good to have this integrated with one plain PR just taking over the docs as is. |
docs/blockchain_tests/index.rst
Outdated
| Found in ``/BlockTests``, the blockchain tests aim is to test the basic verification of a blockchain. | ||
|
|
||
| ``/BlockTests`` - general blockchain tests. All blocks are built on network: **Frontier** | ||
| ``/BlockTests/Homestead`` - homestead blockchain tests. All blocks are built on network: **Homestead** |
There was a problem hiding this comment.
this info is outdated. blockchain folder structure is different now. network rules are read from networ field from within the test
docs/blockchain_tests/index.rst
Outdated
| "pre": { ... }, | ||
| "blocks" : [ | ||
| { | ||
| "chainname" : "A", |
There was a problem hiding this comment.
optional field. we should leave it only in the test fillers.
additional or optional fields in the final tests are confusing other teams
docs/blockchain_tests/index.rst
Outdated
| "blocks" : [ | ||
| { | ||
| "chainname" : "A", | ||
| "blocknumber" : "1", |
docs/blockchain_tests/index.rst
Outdated
| ``uncleHash``: | ||
| The Keccak 256-bit hash of the uncles list portion of this block | ||
|
|
||
| * ``pre`` section: as described in State Tests. |
There was a problem hiding this comment.
describe network field somewhere here
|
|
||
| * ``uncleHeaders`` section is a list of block headers which have the same format as descibed in `genesisBlockHeader`. | ||
|
|
||
| Optional BlockHeader Sections (Information fields) |
There was a problem hiding this comment.
should be only in fillers
| .. _contribute: | ||
|
|
||
| ================== | ||
| Contribute to Docs |
There was a problem hiding this comment.
sphinx has a bug where it might compile docs and not create some code blocks, quotes or tables. better view this scripts in github
| .. _difficulty_tests: | ||
|
|
||
| ################################################################################ | ||
| Difficulty Tests |
There was a problem hiding this comment.
this tests are valid. but we have to add that it is not maintained and not being executed on hive
docs/state_tests/index.rst
Outdated
| .. _state_tests: | ||
|
|
||
| ################################################################################ | ||
| State Tests |
There was a problem hiding this comment.
this tests has been changed drastically new schema is here
ethereum/EIPs#176 (might be slightly outdated. new field is logs hash)
| @@ -0,0 +1,68 @@ | |||
|
|
|||
| ***************************************************** | |||
| Using Testeth | |||
There was a problem hiding this comment.
this file is updated at cpp-ethereum docs
| .. _vm_tests: | ||
|
|
||
| ################################################################################ | ||
| VM Tests |
There was a problem hiding this comment.
@pirapira maintain those tests
|
speaking of details. added some comments |
|
@holgerd77 now that @winsvega has reviewed it, do you want to apply his comments in this PR? |
|
@winsvega let's delay the second-round fixes after merging this PR. |
|
ok |
|
@holgerd77 I just protected your PR from further review comments. I heard you would address the existing comments, so tell me if you've changed mind about this. |
|
@pirapira Ah, sorry, misunderstanding, thought you meant the existing comments with "second-round" ("first-round" being the doc extraction :-)). Ok, no, then I'll do additional commits for the outstanding comments. |
|
@pirapira @winsvega I've made some updates to the blockchain tests and the state tests section, but it feels a bit "wrong" to do this I have to admit, since by starting to update these docs so broadly one is automatically drawn into a half-rewrite without knowing where to start and where to stop, since there is so much outdated information. Please let's just merge this "as is", then the changes itself can be adressed by various people on separate PRs. |
|
@winsvega will you file a follow-up PR containing the edits you suggested? |
Implementation of #272
I've now integrated Homestead tests doc files in a
docsfolder in the repository and also added some doc contribution notes.I've already deployed this on ReadTheDocs, this is still pointing to my fork but can be easily switched over.