From 090eb0a8d4e33a9f962b4bac4997079f9e463f3e Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Sat, 7 Apr 2018 14:14:07 +0100 Subject: [PATCH] Improve wording of the masterlist versioning example Fixes #64 --- docs/contributing/Masterlist-Versioning.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing/Masterlist-Versioning.html b/docs/contributing/Masterlist-Versioning.html index 16005b0..3cc69bd 100644 --- a/docs/contributing/Masterlist-Versioning.html +++ b/docs/contributing/Masterlist-Versioning.html @@ -7,7 +7,7 @@ title: Masterlist Versioning

To allow the use of new features without breaking older versions of LOOT, the masterlists are also versioned. This is done by storing the versions as branches in the masterlists' Git repositories. Whenever a new version of LOOT that includes metadata syntax changes is released, a new branch for that version is created in each masterlist repository, and that branch is made the default for that version of LOOT.

-

For example, LOOT v0.7.1 uses the v0.7 masterlist branches by default. The next release to include metadata syntax changes will be LOOT v0.8, which will use v0.8 masterlist branches. If LOOT v0.9 includes no metadata syntax changes, then it will also use the v0.8 masterlist branches.

+

For example, LOOT v0.8.1 uses the v0.8 masterlist branches by default. LOOT v0.9.0 introduced metadata syntax changes, so it uses the v0.9 masterlist branches. LOOT v0.10.0 uses the same metadata syntax as v0.9.0, so it also uses the v0.9 masterlist branches.

In addition to the obvious version branches, each masterlist repository also has a master branch. This is the version branch for LOOT v0.5 and v0.6.x, and it is also the default branch for LOOT v0.7.0, as the masterlist versioning system was introduced in conjunction with the release of LOOT v0.7.1. Users of LOOT v0.7.0 can safely switch to using the v0.7 branch, but the master branch cannot be renamed without breaking masterlist updates for LOOT v0.5 and v0.6.x users, which is why it keeps its ambiguous name.