From de19fbde96a4a214e21564176b927813e117d835 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Bylica?= Date: Wed, 13 Feb 2019 11:38:31 +0100 Subject: [PATCH] docs: Document elements of evmc_revision --- include/evmc/evmc.h | 46 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-) diff --git a/include/evmc/evmc.h b/include/evmc/evmc.h index 18384b336..da0f13623 100644 --- a/include/evmc/evmc.h +++ b/include/evmc/evmc.h @@ -708,24 +708,66 @@ typedef enum evmc_set_option_result (*evmc_set_option_fn)(struct evmc_instance* /** * EVM revision. * - * The revision of the EVM specification based on the Ethereum - * upgrade / hard fork codenames. + * The revision of the EVM specification based on the Ethereum + * upgrade / hard fork codenames. */ enum evmc_revision { + /** + * The Frontier revision. + * + * The one Ethereum launched with. + */ EVMC_FRONTIER = 0, + + /** + * The Homestead revision. + * + * https://eips.ethereum.org/EIPS/eip-606 + */ EVMC_HOMESTEAD = 1, + + /** + * The Tangerine Whistle revision. + * + * https://eips.ethereum.org/EIPS/eip-608 + */ EVMC_TANGERINE_WHISTLE = 2, + + /** + * The Spurious Dragon revision. + * + * https://eips.ethereum.org/EIPS/eip-607 + */ EVMC_SPURIOUS_DRAGON = 3, + + /** + * The Byzantium revision. + * + * https://eips.ethereum.org/EIPS/eip-609 + */ EVMC_BYZANTIUM = 4, + + /** + * The Constantinople revision. + * + * https://eips.ethereum.org/EIPS/eip-1013 + */ EVMC_CONSTANTINOPLE = 5, /** * Reserved for the post-Constantinople upgrade. The name is likely to * be changed, but the assigned number should stay. + * + * The spec draft: https://github.com/ethereum/EIPs/pull/1716. */ EVMC_CONSTANTINOPLE2 = 6, + /** + * The Istanbul revision. + * + * The spec draft: https://eips.ethereum.org/EIPS/eip-1679. + */ EVMC_ISTANBUL = 7, /** The maximum EVM revision supported. */