diff options
| author | teor <teor@torproject.org> | 2019-06-23 16:48:51 +1000 |
|---|---|---|
| committer | teor <teor@torproject.org> | 2019-06-23 16:50:51 +1000 |
| commit | 284c6ca0e5287f8bf67bf53d82a787d0ceafd227 (patch) | |
| tree | 9cb650a5fc91c2a132d29b44782f341950f7a51b /dir-list-spec.txt | |
| parent | e9627a9e5355b4801b1e7f0f4ae2f457c5f40325 (diff) | |
| download | torspec-284c6ca0e5287f8bf67bf53d82a787d0ceafd227.tar.gz torspec-284c6ca0e5287f8bf67bf53d82a787d0ceafd227.zip | |
dir-list: explain semantic versioning in the Format Versions section
It's better to explain before we start talking about versions.
Cleanup after 30949.
Diffstat (limited to 'dir-list-spec.txt')
| -rw-r--r-- | dir-list-spec.txt | 22 |
1 files 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 |