Browse Source

Revise wording

pull/1/merge
Andrew Belt 7 years ago
parent
commit
f9ba1a8f57
1 changed files with 8 additions and 8 deletions
  1. +8
    -8
      Version.md

+ 8
- 8
Version.md View File

@@ -3,8 +3,8 @@
The ABI of Rack is its machine-readable list of symbols (functions, globals, and classes) that can only be accessed in specific ways.
Rack's API consists of C and C++ headers (`.h` and `.hpp` files) that define how the ABI can be used.

Rack plugins must be compiled against a particular "major version" of Rack, so that when Rack loads them, they link to Rack's symbols correctly.
The major version is the `X` in `vX.Y` (or `v0.X.Y` for beta versions).
Rack plugins must be compiled against a particular *major version* of Rack, so that when Rack loads them, they link to Rack's symbols correctly.
The major version is `X` in the version name `vX.Y` (or `v0.X.Y` for beta versions).


## Symbol additions
@@ -13,10 +13,10 @@ In rare cases, symbols might be added to the API/ABI of Rack in a minor version
Plugins may use these new symbols, but note that they cannot be loaded with older versions of Rack.
Users will need to upgrade their Rack minor version to load your plugin.

Once a symbol is added to a minor version update, its API/ABI is not changed.
The minor version is the `Y` in `vX.Y` (or `v0.X.Y` for beta versions).
Once a symbol is added to a *minor version* update, its API/ABI is not changed.
The minor version is `Y` in the version name `vX.Y` (or `v0.X.Y` for beta versions).

This is similar to how VST plugins work, where for example, VST 2.3 plugins cannot load in DAWs which only implement the VST 2.2 standard, except that Rack releases versions more frequently at this time.
This is similar to how VST plugins work, where for example, VST 2.3 plugins cannot load in DAWs that only implement the VST 2.2 standard, except that Rack releases versions more frequently at this time.


## Git branches and tags
@@ -25,9 +25,9 @@ In [Rack's git repository](https://github.com/VCVRack/Rack), each major version

There is no `master` branch.
The default branch on GitHub is the major version for the latest release of Rack listed at [vcvrack.com](https://vcvrack.com/).
To update your branch, run `git checkout v0.6` in Rack's source directory.
To update the major version of your source tree, simply check out its branch.
It is highly recommended to run `make clean` in the root and `dep/` directories after or before switching branches.

When any version of Rack is released, the build's commit is tagged with the full version label (e.g. `v0.6.0`).
When any version of Rack is released, the build's commit is tagged with its full version name (e.g. `v0.6.0`).
However, this is only for informative purposes.
Only building from the `HEAD` of each branch is supported, since dependency URLs and other issues may need to be fixed after time has passed from the release date.
Building from "detached heads" of branches is not supported, since dependency URLs and other issues may need to be fixed after time has passed from the release date.

Loading…
Cancel
Save