[tor-commits] [torspec/main] bandwidth-file-spec: Add 'Table of contents'

[dgoulet at torproject.org]

commit 517fcea195e0ee9edb24e1582b282757bcf3e133
Author: Oleh Franchuk <0x00.gear at gmail.com>
Date:   Mon Aug 23 19:29:07 2021 +0300

    bandwidth-file-spec: Add 'Table of contents'
---
 bandwidth-file-spec.txt | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/bandwidth-file-spec.txt b/bandwidth-file-spec.txt
index 924623e..58ce83c 100644
--- a/bandwidth-file-spec.txt
+++ b/bandwidth-file-spec.txt
@@ -3,6 +3,33 @@
                             juga
                             teor
 
+Table of Contents
+
+    1. Scope and preliminaries
+        1.2. Acknowledgements
+        1.3. Outline
+        1.4. Format Versions
+    2. Format details
+        2.1. Definitions
+        2.2. Header List format
+        2.3. Relay Line format
+        2.4. Implementation details
+            2.4.1. Writing bandwidth files atomically
+            2.4.2. Additional KeyValue pair definitions
+                2.4.2.1. Simple Bandwidth Scanner
+                2.4.2.2. Torflow
+    A. Sample data
+        A.1. Generated by Torflow
+        A.2. Generated by sbws version 0.1.0
+        A.3. Generated by sbws version 1.0.3
+        A.4. Headers generated by sbws version 1.0.4
+        A.5 Generated by sbws version 1.1.0
+    B. Scaling bandwidths
+        B.1. Scaling requirements
+        B.2. A linear scaling method
+        B.3. Quota changes
+        B.4. Torflow aggregation
+
 1. Scope and preliminaries
 
   This document describes the format of Tor's Bandwidth File, version