Skip to content
Snippets Groups Projects
Commit 07240a6f authored by totten's avatar totten
Browse files

info-xml.md - Revise phrase "to bridge this change"

The phrase originated in one context (i.e.  discussing a change in the
version-numbering pattern).  In the context of `info.xml` docs, it seemed
helpful to use more concrete wording ("Because 4.7.x and 5.x are
substantively the same series...").
parent 70bb83e4
No related branches found
No related tags found
1 merge request!532Update docs to reflect semver changes.
......@@ -42,7 +42,7 @@ Here is an example of a full `info.xml` file from [CiviVolunteer](https://github
| CiviCRM Version | Description |
| -- | -- |
| 5.0.0 | [`<ver>`](#ver) tag values now imply forward compatibility. (e.g. an extension declaring `<ver>5.1</ver>` is displayed on 5.2, 5.3 etc. but *not* on 5.0.) To bridge this change `<ver>4.7</ver>` is forward compatible with 5.x. |
| 5.0.0 | [`<ver>`](#ver) tags now imply forward compatibility. (e.g. an extension declaring `<ver>5.1</ver>` is displayed on 5.2, 5.3 etc. but *not* on 5.0.) Because 4.7.x and 5.x are substantively the same series, `<ver>4.7</ver>` implies forward compatiblity with 5.x. |
| 4.7.27 | Added [`<requires>`](#requires) and [`<ext>`](#ext) |
| 4.5 | [`<develStage>`](#develStage) is not always required; when using civicrm.org's automated release management, this value is inferred from the version; for manual or private releases, the field should still be defined.
| 4.2 | Most extensions should be packaged as generic *module* rather than type-specific extensions.
......@@ -322,7 +322,11 @@ Elements acceptable within `<urls>`
It is not currently possible to specify compatibility with point releases. If your extension is compatible with CiviCRM 4.7.21 but *not* 4.7.20, then you will need to clearly specify this in the [comments](#comments).
!!! note "Forward compatibility (4.7/5.x)"
In CiviCRM 5.x `<ver>` tags imply forward compatibility, to bridge this change `<ver>4.7</ver>` is forward compatible with CiviCRM 5.x.
For CiviCRM 3.x and 4.x, `<ver>` tags must explicitly list all compatible versions.
For CiviCRM 4.7.x and 5.x, `<ver>` tags imply forward compatibility.
Because 4.7.x and 5.x are substantively the same series, `<ver>4.7</ver>` implies forward compatiblity with 5.x.
### `<version>` {:#version}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment