From: erikarn <adrian.chadd@gmail.com>
Date: Thu, 4 Apr 2013 18:24:33 +0000 (-0700)
Subject: Updated Version Policy (markdown)
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=bddf49b5c208b2f43bf0a24c75389c06fb43b76b;p=librecmc%2Fopen-ath9k-htc-firmware.wiki.git

Updated Version Policy (markdown)
---

diff --git a/Version-Policy.md b/Version-Policy.md
deleted file mode 100644
index d58907b..0000000
--- a/Version-Policy.md
+++ /dev/null
@@ -1,24 +0,0 @@
-## Why do we need a versioning policy?
-
-Why? Because it's firmware and it's not tightly coupled to the driver.
-
-The firmware will be used by various projects for NIC support. It's not just for ath9k_htc - hopefully OpenBSD will adopt it soon; FreeBSD/NetBSD will adopt it as soon as there's a driver available.
-
-Since some downstream projects may wish to fork the github repository and do some of their own local development, each major and minor release will be a branch.
-
-## Ok, what's the policy?
-
-The policy is thus:
-
-1. No non-backwards compatible changes will occur on a major branch;
-2. Minor version numbers may introduce new features but they must be optional and default to the previous firmware behaviour;
-3. Major branch numbers may introduce non-backwards-compatible features.
-
-So:
-
-* Everything along the 1.x branch will be backwards compatible.
-* There'll be a branch laid down for each minor revision released (eg 1.3, 1.4, 1.5).
-* There'll be a tag laid down for each release along the minor revision (eg 1.3.1, 1.3.2, 1.3.3, etc.) which will match up with the binary firmware image that is released for public consumption.
-* 1.3, 1.4, 1.5, etc can introduce new features, but they must be optional and default to the previous behaviour.
-
-Hopefully what will be pushed into linux-firmware.git will be the latest of each major release version. Ie, there will only be one "current" firmware release in linux-firmware.git for 1.x, 2.x, 3.x, etc.
\ No newline at end of file
diff --git a/VersionPolicy.md b/VersionPolicy.md
new file mode 100644
index 0000000..d58907b
--- /dev/null
+++ b/VersionPolicy.md
@@ -0,0 +1,24 @@
+## Why do we need a versioning policy?
+
+Why? Because it's firmware and it's not tightly coupled to the driver.
+
+The firmware will be used by various projects for NIC support. It's not just for ath9k_htc - hopefully OpenBSD will adopt it soon; FreeBSD/NetBSD will adopt it as soon as there's a driver available.
+
+Since some downstream projects may wish to fork the github repository and do some of their own local development, each major and minor release will be a branch.
+
+## Ok, what's the policy?
+
+The policy is thus:
+
+1. No non-backwards compatible changes will occur on a major branch;
+2. Minor version numbers may introduce new features but they must be optional and default to the previous firmware behaviour;
+3. Major branch numbers may introduce non-backwards-compatible features.
+
+So:
+
+* Everything along the 1.x branch will be backwards compatible.
+* There'll be a branch laid down for each minor revision released (eg 1.3, 1.4, 1.5).
+* There'll be a tag laid down for each release along the minor revision (eg 1.3.1, 1.3.2, 1.3.3, etc.) which will match up with the binary firmware image that is released for public consumption.
+* 1.3, 1.4, 1.5, etc can introduce new features, but they must be optional and default to the previous behaviour.
+
+Hopefully what will be pushed into linux-firmware.git will be the latest of each major release version. Ie, there will only be one "current" firmware release in linux-firmware.git for 1.x, 2.x, 3.x, etc.
\ No newline at end of file