From 418f99f716145932be9267d28de2311459c612b9 Mon Sep 17 00:00:00 2001 From: Callum Waters Date: Fri, 11 Feb 2022 16:03:40 +0100 Subject: [PATCH] merge rfc documents together --- docs/rfc/README.md | 6 +++ {rfc => docs/rfc}/images/abci++.png | Bin {rfc => docs/rfc}/images/abci.png | Bin {rfc => docs/rfc}/images/block-retention.png | Bin .../rfc/rfc-011-block-retention.md | 3 +- .../rfc/rfc-012-nonzero-genesis.md | 3 +- .../rfc/rfc-013-ed25519-verification.md | 5 ++- .../rfc/rfc-014-abci++.md | 5 ++- .../rfc/rfc-015-reverse-sync.md | 3 +- .../rfc/rfc-016-semantic-versioning.md | 1 + rfc/README.md | 30 -------------- rfc/rfc_template.md | 39 ------------------ 12 files changed, 19 insertions(+), 76 deletions(-) rename {rfc => docs/rfc}/images/abci++.png (100%) rename {rfc => docs/rfc}/images/abci.png (100%) rename {rfc => docs/rfc}/images/block-retention.png (100%) rename rfc/001-block-retention.md => docs/rfc/rfc-011-block-retention.md (97%) rename rfc/002-nonzero-genesis.md => docs/rfc/rfc-012-nonzero-genesis.md (96%) rename rfc/003-ed25519-verification.md => docs/rfc/rfc-013-ed25519-verification.md (94%) rename rfc/004-abci++.md => docs/rfc/rfc-014-abci++.md (99%) rename rfc/005-reverse-sync.md => docs/rfc/rfc-015-reverse-sync.md (97%) rename rfc/006-semantic-versioning.md => docs/rfc/rfc-016-semantic-versioning.md (98%) delete mode 100644 rfc/README.md delete mode 100644 rfc/rfc_template.md diff --git a/docs/rfc/README.md b/docs/rfc/README.md index 1517db2f5..4dcf86d2b 100644 --- a/docs/rfc/README.md +++ b/docs/rfc/README.md @@ -48,5 +48,11 @@ sections. - [RFC-008: Don't Panic](./rfc-008-don't-panic.md) - [RFC-009: Consensus Parameter Upgrades](./rfc-009-consensus-parameter-upgrades.md) - [RFC-010: P2P Light Client](./rfc-010-p2p-light-client.rst) +- [RFC-011: Block Retention](./rfc-011-block-retention.md) +- [RFC-012: Non-Zero Genesis](./rfc-012-nonzero-genesis.md) +- [RFC-013: ED25519 Verification](./rfc-013-ed25519-verification.md) +- [RFC-014: ABCI++](./rfc-014-abci++.md) +- [RFC-015: Reverse Sync](./rfc-015-reverse-sync.md) +- [RFC-016: Semantic Versioning](./rfc-016-semantic-versioning.md) diff --git a/rfc/images/abci++.png b/docs/rfc/images/abci++.png similarity index 100% rename from rfc/images/abci++.png rename to docs/rfc/images/abci++.png diff --git a/rfc/images/abci.png b/docs/rfc/images/abci.png similarity index 100% rename from rfc/images/abci.png rename to docs/rfc/images/abci.png diff --git a/rfc/images/block-retention.png b/docs/rfc/images/block-retention.png similarity index 100% rename from rfc/images/block-retention.png rename to docs/rfc/images/block-retention.png diff --git a/rfc/001-block-retention.md b/docs/rfc/rfc-011-block-retention.md similarity index 97% rename from rfc/001-block-retention.md rename to docs/rfc/rfc-011-block-retention.md index 80377145e..8bfc0021e 100644 --- a/rfc/001-block-retention.md +++ b/docs/rfc/rfc-011-block-retention.md @@ -1,4 +1,4 @@ -# RFC 001: Configurable Block Retention +# RFC 011: Configurable Block Retention ## Changelog @@ -6,6 +6,7 @@ - 2020-03-25: Use local config for snapshot interval (@erikgrinaker) - 2020-03-31: Use ABCI commit response for block retention hint - 2020-04-02: Resolved open questions +- 2021-02-11: Migrate RFC to tendermint repo (Originally [RFC 001](https://github.com/tendermint/spec/pull/84)) ## Author(s) diff --git a/rfc/002-nonzero-genesis.md b/docs/rfc/rfc-012-nonzero-genesis.md similarity index 96% rename from rfc/002-nonzero-genesis.md rename to docs/rfc/rfc-012-nonzero-genesis.md index 8773ae74f..fb9b0afda 100644 --- a/rfc/002-nonzero-genesis.md +++ b/docs/rfc/rfc-012-nonzero-genesis.md @@ -1,4 +1,4 @@ -# RFC 002: Non-Zero Genesis +# RFC 012: Non-Zero Genesis ## Changelog @@ -6,6 +6,7 @@ - 2020-07-28: Use weak chain linking, i.e. `predecessor` field (@erikgrinaker) - 2020-07-31: Drop chain linking (@erikgrinaker) - 2020-08-03: Add `State.InitialHeight` (@erikgrinaker) +- 2021-02-11: Migrate RFC to tendermint repo (Originally [RFC 002](https://github.com/tendermint/spec/pull/119)) ## Author(s) diff --git a/rfc/003-ed25519-verification.md b/docs/rfc/rfc-013-ed25519-verification.md similarity index 94% rename from rfc/003-ed25519-verification.md rename to docs/rfc/rfc-013-ed25519-verification.md index 140717b0a..64efd6c11 100644 --- a/rfc/003-ed25519-verification.md +++ b/docs/rfc/rfc-013-ed25519-verification.md @@ -1,8 +1,9 @@ -# RFC 003: Ed25519 Verification +# RFC 013: Ed25519 Verification ## Changelog -- August 21, 2020: initialized +- 2020-08-21: Initial RFC +- 2021-02-11: Migrate RFC to tendermint repo (Originally [RFC 003](https://github.com/tendermint/spec/pull/144)) ## Author(s) diff --git a/rfc/004-abci++.md b/docs/rfc/rfc-014-abci++.md similarity index 99% rename from rfc/004-abci++.md rename to docs/rfc/rfc-014-abci++.md index 61106ecab..de723d28e 100644 --- a/rfc/004-abci++.md +++ b/docs/rfc/rfc-014-abci++.md @@ -1,8 +1,9 @@ -# RFC 004: ABCI++ +# RFC 014: ABCI++ ## Changelog -- January 11, 2020: initialized +- 2020-01-11: initialized +- 2021-02-11: Migrate RFC to tendermint repo (Originally [RFC 004](https://github.com/tendermint/spec/pull/254)) ## Author(s) diff --git a/rfc/005-reverse-sync.md b/docs/rfc/rfc-015-reverse-sync.md similarity index 97% rename from rfc/005-reverse-sync.md rename to docs/rfc/rfc-015-reverse-sync.md index cbecf2c98..115b64813 100644 --- a/rfc/005-reverse-sync.md +++ b/docs/rfc/rfc-015-reverse-sync.md @@ -1,7 +1,8 @@ -# RFC 005: ReverseSync - fetching historical data +# RFC 015: ReverseSync - fetching historical data ## Changelog +- 2021-02-11: Migrate RFC to tendermint repo (Originally [RFC 005](https://github.com/tendermint/spec/pull/224)) - 2021-04-19: Use P2P to gossip necessary data for reverse sync. - 2021-03-03: Simplify proposal to the state sync case. - 2021-02-17: Add notes on asynchronicity of processes. diff --git a/rfc/006-semantic-versioning.md b/docs/rfc/rfc-016-semantic-versioning.md similarity index 98% rename from rfc/006-semantic-versioning.md rename to docs/rfc/rfc-016-semantic-versioning.md index e5de5e173..bc04aee2c 100644 --- a/rfc/006-semantic-versioning.md +++ b/docs/rfc/rfc-016-semantic-versioning.md @@ -3,6 +3,7 @@ ## Changelog - 2021-11-19: Initial Draft +- 2021-02-11: Migrate RFC to tendermint repo (Originally [RFC 006](https://github.com/tendermint/spec/pull/365)) ## Author(s) diff --git a/rfc/README.md b/rfc/README.md deleted file mode 100644 index 7e4dfdd33..000000000 --- a/rfc/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# Request for Comments (RFC) - -RFC stands for `Request for Comments`. It is a social device use to float and polish an idea prior to the inclusion into an existing or new spec/paper/research topic. - -An RFC should not be used for bug reports or trivial discussions - the overhead of compiling an RFC does not justify it. - -An RFC should not consist only of a problem statement (use a standard issue for that). - -A RFC should consist of: - -- Changelog -- Context on the relevant goals and the current state -- Proposed Solution -- Summary of pros and cons -- References - -If recorded decisions turned out to be lacking, convene a discussion, record the new decisions here, and then modify the code to match. - -**Note the context/background should be written in the present tense.** - -Some RFC's will be presented at a Tendermint Dev Session. If you are an outside contributor and have submitted a RFC, you may be invited to present your RFC at one of these calls. - -## Table of Contents - -- [001-block-retention](./001-block-retention.md) -- [002-nonzero-genesis](./002-nonzero-genesis.md) -- [003-ed25519-verification](./003-ed25519-verification.md) -- [004-abci++](./004-abci++.md) -- [005-reverse-sync](./005-reverse-sync.md) -- [006-semantic-versioning](./006-semantic-versioning.md) diff --git a/rfc/rfc_template.md b/rfc/rfc_template.md deleted file mode 100644 index 817066ee4..000000000 --- a/rfc/rfc_template.md +++ /dev/null @@ -1,39 +0,0 @@ -# RFC {RFC-NUMBER}: {TITLE} - -## Changelog - -- {date}: {changelog} - -## Author(s) - -- {First Name} {github handle} - -## Context - -> This section contains all the context one needs to understand the current state, and why there is a problem. It should be as succinct as possible and introduce the high level idea behind the solution. - -## Proposal - -> It should contain a detailed breakdown of how the problem should be resolved including diagrams and other supporting materials needed to present the case and implementation roadmap for the proposed changes. The reader should be able to fully understand the proposal. This section should be broken up using ## subsections as needed. - -## Status - -> A decision may be "proposed" if it hasn't been agreed upon yet, or "accepted" once it is agreed upon. If a later RFC changes or reverses a decision, it may be marked as "deprecated" or "superseded" with a reference to its replacement. - -{Deprecated|Proposed|Accepted} - -## Consequences - -> This section describes the consequences, after applying the decision. All consequences should be summarized here, not just the "positive" ones. - -### Positive - -### Negative - -### Neutral - -## References - -> Are there any relevant PR comments, issues that led up to this, or articles referenced for why we made the given design choice? If so link them here! - -- {reference link}