Skip to content
This repository was archived by the owner on Apr 8, 2026. It is now read-only.

Enhance documentation#58

Merged
chfast merged 3 commits intomasterfrom
docs
Aug 20, 2018
Merged

Enhance documentation#58
chfast merged 3 commits intomasterfrom
docs

Conversation

@chfast
Copy link
Copy Markdown
Member

@chfast chfast commented Aug 13, 2018

  • Updates the EVMC module description and moves it to a markdown file.
  • Some config tweaks for Doxygen.
  • Documentation for macros from utils.h.

@chfast chfast requested review from axic, ehildenb and gumb0 August 13, 2018 15:34
@chfast
Copy link
Copy Markdown
Member Author

chfast commented Aug 13, 2018

README.md Outdated
[@chfast]: https://github.com/chfast
[documentation]: https://ethereum.github.io/evmc
[eWASM]: https://github.com/ewasm/design#ethereum-flavored-webassembly-ewasm-design
[Ewasm]: https://github.com/ewasm/design#ethereum-flavored-webassembly-ewasm-design
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

README.md Outdated

The EVMC is the low-level ABI between Ethereum Virtual Machines (EVMs) and
Ethereum Clients. On the EVM-side it supports classic EVM1 and [eWASM].
Ethereum Clients. On the EVM-side it supports classic EVM1 and [Ewasm].
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "EVM side" should be without dash

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think there's an agreement on the name, can you just have the wasm stuff in a separate PR?

docs/EVMC.md Outdated
- [EVMC Loader](@ref loader)
– the library for loading VMs implemented as Dynamically Loaded Libraries (DLLs, shared objects).
- [EVMC Helpers](@ref helpers)
– a collection of utility function for easier integration with EVMC.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

functions?

docs/EVMC.md Outdated
– the library with collection of metrics for EVM1 instruction set.


[Ewasm]: https://github.com/ewasm/design#ethereum-flavored-webassembly-ewasm-design
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does it need to link to the heading?

docs/EVMC.md Outdated
- Provides access to State.
- Creates new accounts (with code being a result of VM execution).
- Handles refunds entirely.
- Handles calls to precompiled contracts.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does that exactly mean?


- Provides access to State.
- Creates new accounts (with code being a result of VM execution).
- Handles refunds entirely.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually it may make sense moving that to the VM at some point.

@axic
Copy link
Copy Markdown
Member

axic commented Aug 18, 2018

Okay apar from the ewasm naming question.

@chfast chfast changed the base branch from release/5.0 to master August 20, 2018 09:38
@chfast chfast merged commit 68c033d into master Aug 20, 2018
@chfast chfast deleted the docs branch August 20, 2018 09:38
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants