[tor-commits] [torspec/master] Small template and script improvements
nickm at torproject.org
nickm at torproject.org
Mon Jul 27 14:52:01 UTC 2020
commit 246a5864619e2393d447aab5826a990fdef3dfd5
Author: Nick Mathewson <nickm at torproject.org>
Date: Mon Jul 27 10:49:51 2020 -0400
Small template and script improvements
---
proposals/BY_INDEX.md | 10 ++++++++--
proposals/BY_INDEX_template.md | 10 ++++++++--
proposals/README.md | 35 ++++++++++++++++++++++++++---------
proposals/README_template.md | 35 ++++++++++++++++++++++++++---------
proposals/reindex.py | 2 ++
5 files changed, 70 insertions(+), 22 deletions(-)
diff --git a/proposals/BY_INDEX.md b/proposals/BY_INDEX.md
index d0e3b2b..5a66ae2 100644
--- a/proposals/BY_INDEX.md
+++ b/proposals/BY_INDEX.md
@@ -1,11 +1,17 @@
# Tor proposals by number
+<!-- DO NOT EDIT THIS FILE -->
+
+<!-- If you want to make changes here, make sure to edit the -->
+<!-- BY_INDEX_TEMPLATE.md file. The BY_INDEX.md file is -->
+<!-- generated by the reindex.py script. -->
+
Here we have a set of proposals for changes to the Tor protocol. Some
of these proposals are implemented; some are works in progress; and some
will never be implemented.
-Below are a list of proposals sorted by status. See
-[README.md](/proposals/README.md) for a list of proposals sorted by number.
+Below are a list of proposals sorted by their proposal number. See
+[README.md](/proposals/README.md) for a list of proposals sorted by status.
* [`000-index.txt`](/proposals/000-index.txt): Index of Tor Proposals [META]
* [`001-process.txt`](/proposals/001-process.txt): The Tor Proposal Process [META]
diff --git a/proposals/BY_INDEX_template.md b/proposals/BY_INDEX_template.md
index 48c457c..d18dc60 100644
--- a/proposals/BY_INDEX_template.md
+++ b/proposals/BY_INDEX_template.md
@@ -1,10 +1,16 @@
# Tor proposals by number
+{warning}
+
+<!-- If you want to make changes here, make sure to edit the -->
+<!-- BY_INDEX_TEMPLATE.md file. The BY_INDEX.md file is -->
+<!-- generated by the reindex.py script. -->
+
Here we have a set of proposals for changes to the Tor protocol. Some
of these proposals are implemented; some are works in progress; and some
will never be implemented.
-Below are a list of proposals sorted by status. See
-[README.md](/proposals/README.md) for a list of proposals sorted by number.
+Below are a list of proposals sorted by their proposal number. See
+[README.md](/proposals/README.md) for a list of proposals sorted by status.
{BY_INDEX}
diff --git a/proposals/README.md b/proposals/README.md
index 9574070..79abf0c 100644
--- a/proposals/README.md
+++ b/proposals/README.md
@@ -1,5 +1,11 @@
# Tor proposals by status
+<!-- DO NOT EDIT THIS FILE -->
+
+<!-- If you want to make changes here, make sure to edit the -->
+<!-- README_template.md file. The README.md file is generated by the -->
+<!-- reindex.py script. -->
+
Here we have a set of proposals for changes to the Tor protocol. Some
of these proposals are implemented; some are works in progress; and some
will never be implemented.
@@ -9,7 +15,7 @@ Below are a list of proposals sorted by status. See
# Active proposals by status
-## OPEN proposals: Under discussion
+## OPEN proposals: under discussion
These are proposals that we think are likely to be complete, and ripe
for discussion.
@@ -38,7 +44,7 @@ for discussion.
* [`324-rtt-congestion-control.txt`](/proposals/324-rtt-congestion-control.txt): RTT-based Congestion Control for Tor
-## ACCEPTED proposals: Slated for implementation
+## ACCEPTED proposals: slated for implementation
These are the proposals that we agree we'd like to implement. They
might or might not have a specific timeframe planned for their
@@ -54,7 +60,7 @@ implementation.
* [`314-allow-markdown-proposals.md`](/proposals/314-allow-markdown-proposals.md): Allow Markdown for proposal format
-## FINISHED proposals: Implemented, specs not merged
+## FINISHED proposals: implemented, specs not merged
These proposals are implemented in some version of Tor; the proposals
themselves still need to be merged into the specifications proper.
@@ -66,7 +72,7 @@ themselves still need to be merged into the specifications proper.
* [`260-rend-single-onion.txt`](/proposals/260-rend-single-onion.txt): Rendezvous Single Onion Services
-## META proposals: About the proposal process
+## META proposals: about the proposal process
These proposals describe ongoing policies and changes to the proposals
process.
@@ -92,6 +98,10 @@ proposed changes in the Tor specifications.
## DRAFT proposals: incomplete works
+These proposals have been marked as a draft by their author or the editors,
+indicating that they aren't yet in a complete form. They're still open for
+discussion.
+
* [`240-auth-cert-revocation.txt`](/proposals/240-auth-cert-revocation.txt): Early signing key revocation for directory authorities
* [`273-exit-relay-pinning.txt`](/proposals/273-exit-relay-pinning.txt): Exit relay pinning for web services
* [`294-tls-1.3.txt`](/proposals/294-tls-1.3.txt): TLS 1.3 Migration
@@ -108,7 +118,10 @@ proposed changes in the Tor specifications.
* [`325-packed-relay-cells.md`](/proposals/325-packed-relay-cells.md): Packed relay cells: saving space on small commands
-## NEEDS-REVISION proposals: good ideas that we can't implement as-is.
+## NEEDS-REVISION proposals: ideas that we can't implement as-is
+
+These proposals have some promise, but we can't implement them without
+certain changes.
* [`212-using-old-consensus.txt`](/proposals/212-using-old-consensus.txt): Increase Acceptable Consensus Age
* [`219-expanded-dns.txt`](/proposals/219-expanded-dns.txt): Support for full DNS and DNSSEC resolution in Tor
@@ -122,12 +135,16 @@ proposed changes in the Tor specifications.
## NEEDS-RESEARCH proposals: blocking on research
+These proposals are interesting ideas, but there's more research that would
+need to happen before we can know whether to implement them or not, or to
+fill in certain details.
+
(There are no proposals in this category)
# Inactive proposals by status
-## CLOSED proposals: Implemented and specified
+## CLOSED proposals: implemented and specified
These proposals have been implemented in some version of Tor, and the
changes from the proposals have been merged into the specifications as
@@ -224,7 +241,7 @@ necessary.
* [`305-establish-intro-dos-defense-extention.txt`](/proposals/305-establish-intro-dos-defense-extention.txt): ESTABLISH_INTRO Cell DoS Defense Extension
-## RESERVE proposals: Saving for later
+## RESERVE proposals: saving for later
These proposals aren't anything we plan to implement soon, but for one
reason or another we think they might be a good idea in the
@@ -243,7 +260,7 @@ confront the problems that they try to solve.
* [`281-bulk-md-download.txt`](/proposals/281-bulk-md-download.txt): Downloading microdescriptors in bulk
-## SUPERSEDED proposals: Replaced by something else
+## SUPERSEDED proposals: replaced by something else
These proposals were obsoleted by a later proposal before they were
implemented.
@@ -272,7 +289,7 @@ implemented.
* [`280-privcount-in-tor.txt`](/proposals/280-privcount-in-tor.txt): Privacy-Preserving Statistics with Privcount in Tor
-## DEAD, REJECTED, OBSOLETE proposals: Not in our plans.
+## DEAD, REJECTED, OBSOLETE proposals: not in our plans
These proposals are not on-track for discussion or
implementation. Either discussion has stalled out (the proposal is
diff --git a/proposals/README_template.md b/proposals/README_template.md
index b8fa7e2..55a913d 100644
--- a/proposals/README_template.md
+++ b/proposals/README_template.md
@@ -1,5 +1,11 @@
# Tor proposals by status
+{warning}
+
+<!-- If you want to make changes here, make sure to edit the -->
+<!-- README_template.md file. The README.md file is generated by the -->
+<!-- reindex.py script. -->
+
Here we have a set of proposals for changes to the Tor protocol. Some
of these proposals are implemented; some are works in progress; and some
will never be implemented.
@@ -9,14 +15,14 @@ Below are a list of proposals sorted by status. See
# Active proposals by status
-## OPEN proposals: Under discussion
+## OPEN proposals: under discussion
These are proposals that we think are likely to be complete, and ripe
for discussion.
{OPEN}
-## ACCEPTED proposals: Slated for implementation
+## ACCEPTED proposals: slated for implementation
These are the proposals that we agree we'd like to implement. They
might or might not have a specific timeframe planned for their
@@ -24,14 +30,14 @@ implementation.
{ACCEPTED}
-## FINISHED proposals: Implemented, specs not merged
+## FINISHED proposals: implemented, specs not merged
These proposals are implemented in some version of Tor; the proposals
themselves still need to be merged into the specifications proper.
{FINISHED}
-## META proposals: About the proposal process
+## META proposals: about the proposal process
These proposals describe ongoing policies and changes to the proposals
process.
@@ -49,19 +55,30 @@ proposed changes in the Tor specifications.
## DRAFT proposals: incomplete works
+These proposals have been marked as a draft by their author or the editors,
+indicating that they aren't yet in a complete form. They're still open for
+discussion.
+
{DRAFT}
-## NEEDS-REVISION proposals: good ideas that we can't implement as-is.
+## NEEDS-REVISION proposals: ideas that we can't implement as-is
+
+These proposals have some promise, but we can't implement them without
+certain changes.
{NEEDS-REVISION}
## NEEDS-RESEARCH proposals: blocking on research
+These proposals are interesting ideas, but there's more research that would
+need to happen before we can know whether to implement them or not, or to
+fill in certain details.
+
{NEEDS-RESEARCH}
# Inactive proposals by status
-## CLOSED proposals: Implemented and specified
+## CLOSED proposals: implemented and specified
These proposals have been implemented in some version of Tor, and the
changes from the proposals have been merged into the specifications as
@@ -69,7 +86,7 @@ necessary.
{CLOSED}
-## RESERVE proposals: Saving for later
+## RESERVE proposals: saving for later
These proposals aren't anything we plan to implement soon, but for one
reason or another we think they might be a good idea in the
@@ -78,14 +95,14 @@ confront the problems that they try to solve.
{RESERVE}
-## SUPERSEDED proposals: Replaced by something else
+## SUPERSEDED proposals: replaced by something else
These proposals were obsoleted by a later proposal before they were
implemented.
{SUPERSEDED}
-## DEAD, REJECTED, OBSOLETE proposals: Not in our plans.
+## DEAD, REJECTED, OBSOLETE proposals: not in our plans
These proposals are not on-track for discussion or
implementation. Either discussion has stalled out (the proposal is
diff --git a/proposals/reindex.py b/proposals/reindex.py
index 6ac1bbb..72b1234 100755
--- a/proposals/reindex.py
+++ b/proposals/reindex.py
@@ -164,6 +164,8 @@ def writeMarkdownIndexFiles(proposals):
markdown_files = [ "README", "BY_INDEX" ]
format_inputs = {}
+ format_inputs['warning'] = "<!-- DO NOT EDIT THIS FILE -->"
+
entries = []
for prop in proposals:
entries.append(formatMarkdownEntry(prop, withStatus=True))
More information about the tor-commits
mailing list