[tor-commits] [torspec/master] dir-list: explain semantic versioning in the Format Versions section

[nickm@xxxxxxxxxxxxxx]

commit 284c6ca0e5287f8bf67bf53d82a787d0ceafd227
Author: teor <teor@xxxxxxxxxxxxxx>
Date:   Sun Jun 23 16:48:51 2019 +1000

    dir-list: explain semantic versioning in the Format Versions section
    
    It's better to explain before we start talking about versions.
    
    Cleanup after 30949.
---
 dir-list-spec.txt | 22 +++++++++++++---------
 1 file changed, 13 insertions(+), 9 deletions(-)

diff --git a/dir-list-spec.txt b/dir-list-spec.txt
index 1072904..9afef93 100644
--- a/dir-list-spec.txt
+++ b/dir-list-spec.txt
@@ -63,6 +63,16 @@
 
 1.3. Format Versions
 
+   The directory list format uses semantic versioning: https://semver.org
+
+   In particular:
+     * major versions are used for incompatible changes, like
+       removing non-optional fields
+     * minor versions are used for compatible changes, like adding
+       fields
+     * patch versions are for bug fixes, like fixing an
+       incorrectly-formatted Summary item
+
    1.0.0 - The legacy fallback directory list format
 
    2.0.0 - Adds name and extrainfo structured comments, and section separator
@@ -151,16 +161,10 @@
 
        [In second position, exactly once.]
 
-       The version of the directory list format. version_number uses
-       semantic versioning: https://semver.org
+       The version of the directory list format.
 
-       In particular:
-         * major versions are used for incompatible changes, like
-           removing non-optional fields
-         * minor versions are used for compatible changes, like adding
-           fields
-         * patch versions are for bug fixes, like fixing an
-           incorrectly-formatted Summary item
+       version_number is a semantic version, see the "Format Versions"
+       section for details.
 
        Version 1.0.0 represents the undocumented, legacy fallback list
        format(s). Version 2.0.0 and later are documented by this



_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits