[tor-commits] [nyx/master] Describe our versioning scheme

atagar at torproject.org atagar at torproject.org
Sat Aug 5 01:18:26 UTC 2017

commit 5eda50d2b3815a61eb4ce32ab3e4196655b17580
Author: Damian Johnson <atagar at torproject.org>
Date:   Fri Aug 4 02:11:08 2017 -0700

    Describe our versioning scheme
    Largely copied from Stem. We use symantic versioning, with the additional
    caveat that the 1.x series didn't use a formal scheme.
 web/index.html | 29 ++++++++++++++++++++++++++++-
 web/styles.css |  4 ++++
 2 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/web/index.html b/web/index.html
index 281aecd..a47629a 100644
--- a/web/index.html
+++ b/web/index.html
@@ -19,6 +19,10 @@
 #faq_section {
   display: none;
+#changelog_section {
+  display: none;
@@ -198,7 +202,7 @@
-      <div class="faq-section" style="padding-top: 35px;"></div>
+      <div class="faq-section"></div>
       <a href="#usage" class="section-title">Usage</a>
       <br /><br />
@@ -397,6 +401,29 @@ sudo python setup.py install</pre><br /></li>
     <div id="changelog_section" class="page">
+      <div class="section"></div>
+      <a href="#changelog" class="section-title">Change Log</a>
+      <p>The following is a log of all user-facing changes to Nyx, both released and unreleased. For a monthly report on work being done see my <a href="http://blog.atagar.com/">development log</a>.</p>
+      <ul>
+        <li><b><a href="#versioning">Versioning</a></b></li>
+        <li><b><a href="#unreleased">Unreleased</a></b></li>
+        <li><b><a href="#version_1">Version 1.x</a></b></li>
+      </ul>
+      <div id="versioning" class="section" style="padding-top: 15px"></div>
+      <a href="#versioning" class="section-title">Versioning</a>
+      <p>As of the 2.x release Nyx uses <a href="http://semver.org/">semantic versioning</a>, which means that <b>versions consist of three numbers</b> (such as '<b>1.2.4</b>'). These are used to convey the kind of backward compatibility a release has...</p>
+      <ul>
+        <li><p>The first value is the <b>major version</b>. This changes infrequently, and indicates that backward incompatible changes have been made (such as the removal of deprecated functions).</p></li>
+        <li><p>The second value is the <b>minor version</b>. This is the most common kind of release, and denotes that the improvements are backward compatible.</p></li>
+        <li><p>The third value is the <b>patch version</b>. When a Nyx release has a major issue another release is made which fixes just that problem. These do not contain substantial improvements or new features. This value is sometimes left off to indicate all releases with a given major/minor version.</p></li>
+      </ul>
+      <p>Prior to version 2.x nyx did not follow any particular versioning scheme.</p>
diff --git a/web/styles.css b/web/styles.css
index 88aac94..26424c4 100644
--- a/web/styles.css
+++ b/web/styles.css
@@ -107,6 +107,10 @@ Common Page Attributes
   text-align: justify;
+.page ul {
+  text-align: justify;
 .section {
   border-bottom: 1px solid #856231;
   margin-bottom: -16px;

More information about the tor-commits mailing list