Skip to content

Commit c1261ae

Browse files
authored
Updates to versioning page
1 parent c49eb44 commit c1261ae

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

docs/development/versioning.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# SPM version numbers
22
SPM has a **version** and a **release**. At the time of writing, the version is **SPM12** and the release is **dev**.
33

4-
Other toolboxes that depend on SPM use this information to check whether a compatible SPM version is installed. A common pattern is to split the version string, e.g. into **SPM** and **12**, and then compare the latter to the desired version number.
4+
Other toolboxes that depend on SPM use this information to check whether a compatible SPM version is installed. A common pattern is to split the version string into two parts, e.g. SPM12 becomes **SPM** and **12**, and then the latter part is compared to the desired version number.
55

66
## Transition to calendar versioning
77
SPM is moving towards [calendar versioning](https://calver.org/).
@@ -10,13 +10,21 @@ The new format is **YY.0M[.MICRO]**, where YY is the short year (e.g. 24 for the
1010

1111
For backward compatibility, the version and release will operate as follows:
1212

13-
- Version: SPMYY, e.g. SPM24
14-
- Release: either ‘dev’ for the development version on Github or the calendar version number: YY.0M[.MICRO], e.g. 24.07
13+
- **Version**: SPMYY, where YY is the year of the most recent release, e.g. SPM24
14+
- **Release**: either 00.00 for the development version on Github or for a release: YY.0M[.MICRO], e.g. 24.07 for July 2024
1515

1616
## Where the SPM version number is stored
1717
The SPM version is stored on the second line of the file Contents.m in the root directory, or Contents.txt when SPM is in deployed mode (i.e., compiled).
1818

1919
## Querying SPM’s version number
2020
To obtain the version and release call:
21+
22+
```Matlab
2123
[v, r] = spm('ver')
22-
where v is the version and r is the release. For convenience, to return the version and release as a single string, instead call spm('version') .
24+
```
25+
26+
where v is the version and r is the release. For convenience, to return the version and release as a single string, instead call:
27+
28+
```Matlab
29+
spm('version')
30+
```

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,7 @@ nav:
205205
- 'Guidelines': 'development/guidelines.md'
206206
- 'Testing': 'development/testing.md'
207207
- 'Compilation': 'development/compilation/index.md'
208+
- 'Versioning': 'development/versioning.md'
208209

209210
markdown_extensions:
210211
- abbr

0 commit comments

Comments
 (0)