fedora-docs-l10n/packaging-guidelines/master/pages/Versioning

Zen

Source string Source string

English

Examples

Needs editing

The string is read only.

Skip

	English	Actions
	For example, if the last upstream release was `+0.4.1+`, a snapshot could use `+0.4.1^20200601g01234ae+` in the `+Version:+` field. Similarly, if the upstream then makes a pre-release with version `+0.5.0-rc1+`, but it is buggy, and we need to actually package two post-pre-release snapshots, those shapshots could use `+0.5.0~rc1^20200701gdeadf00f+` and `+0.5.0~rc1^20200702gdeadaeae+` in the `+Version:+` field.
	Alternatively, those three snapshots could be versioned as `+0.4.1^1.git01234ae+`, `+0.5.0~rc1^1.gitdeadf00f+` and `+0.5.0~rc1^2.gitdeadaeae+`.
	Note that `+0.4.1^<something>+` sorts higher than `+0.4.1+`, but lower than both `+0.4.2+` and `+0.4.1.<anything>+`.
	Upstream has never chosen a version
	When upstream has never chosen a version, you must use `+Version: 0+`. "`+0+`" sorts lower than any other possible value that upstream might choose. If upstream does choose to release "version 0", then just set `+Release:+` higher than the previous value. (When `%autorelease` is used, this happens automatically.)
	Upstream uses invalid characters in the version
	It's possible that upstream uses characters besides ASCII letters (upper and lower case), digits and periods in its version. They must be removed and potentially replaced with valid characters. Any such alterations must be documented in the specfile. It is not possible to cover all potential situations here, so it is left to the packager to alter the upstream versioning scheme consistently.
	After altering the version to be free of invalid characters, see <<Unsortable versions>> below if the modifications, when applied to successive releases from upstream, will not order properly.
	Unsortable versions
	When upstream uses a versioning scheme that does not sort properly, first see if simply inserting a tilde or caret is enough to make the string sortable.
	For example, if upstream uses a sequence like `+1.2pre1+`, `+1.2pre2+`, `+1.2final+`, then `+1.2~pre1+`, `+1.2~pre2+`, `+1.2_final+` could be used as `+Version+`. The underscore ('`+_+`') is a visual separator that does not influence sort order, and is used here because "final" does not form a separate version component.
	If this is not possible, use something similar to the snapshot version information field described above, with the upstream version moved to the second part of the snapshot information field: `+<date>.<version>+`.
	For example, if upstream releases versions `+I+`, `+II+`, …, `+VIII+`, `+IX+` use `+20200101.I+`, `+20200201.II+`, …, `+20200801.III+`, `+20200901.IX+` in the `+Version+` field.
	Upstream breaks version scheme
	It is possible that upstream simply adopts a different versioning scheme, fails to follow an expected pattern, or even simply resets their version to some lower value. If none of the above operations can help with giving a version which sorts properly, or give you a version which sorts lower than the packages already in Fedora, then you have little recourse but to increment the `+Epoch:+` tag, or to begin using it by adding `+Epoch: 1+`. At the same time, try to work with upstream to hopefully minimize the need to involve `+Epoch:+` in the future.
	Examples
	Comparing versions with `rpmdev-vercmp`
	When in doubt, verify the sorting with `rpmdev-vercmp` from the `rpmdevtools` package:
	```console $ rpmdev-vercmp 2~almost^post 2.0.1 2~almost^post < 2.0.1 ```
	\|Upstream version \| Version tag \| Explanation \|1.0 \|1.0 \| The first release. \|1.1 \|1.1 \| An upstream update. \|1.2.1 \|1.2.1 \| Another upstream update. Extra levels of versioning are OK… \|1.3 \|1.3 \| …they can come and go without problems.
	In this case the full N-V-R could be e.g. `pkg-1.2.1-1.fc{CURRENTVER}` (immediately after an update) or `pkg-1.2.1-5.fc{CURRENTVER}` (after downstream rebuilds with the same upstream version).
	\|Upstream version \| Version tag \| Explanation \| 5.2 \| 5.2 \| Upstream release. \| 5.2a \| 5.2a \| Upstream introduced a letter to indicate a patch release. You trust upstream to use letters in alphabetical order, so it's OK to use the version as is. \| 5.2b \| 5.2b \| Another patch release after 5.2 — this is not a beta. \| 5.2b.1 \| 5.2b.1 \| Even this is OK as long as the sequence increases. \| 5.3 \| 5.3 \| Another upstream release.
	In this case the full N-V-R could be e.g. `pkg-5.2b.1-1.fc{CURRENTVER}`.
	Complex versioning with a reasonable upstream
	\|Upstream version \| Version tag \| Notes \| 1.0.0-rc1 \| `+1.0.0~rc1+` \| first prerelease \| 1.0.0-rc2 \| `+1.0.0~rc2+` \| second prerelease \| 1.0.0 \| `+1.0.0+` \| release \| 1.0.1 \| `+1.0.1+` \| bugfix release \| 1.0.1-security1 \| `+pkg-1.0.1.security1+` \| security bufix release
	In this case the full N-V-R could be e.g. `pkg-1.0.0~rc2-42.fc{CURRENTVER}` (if many rebuilds were done).
	Complex versioning with non-sorting upstream post-release versions
	\|Upstream version \| Version tag \| Notes \| 1.1.0~BETA \| `+1.1.0~BETA+` \| this is a prerelease, first beta \| 1.1.0~BETA1 \| `+1.1.0~BETA1+` \| this is a prerelease, second beta \| 1.1.0~BETA2 \| `+1.1.0~BETA2+` \| this is a prerelease, third beta \| 1.1.0~CR1 \| `+1.1.0~CR1+` \| this is a prerelease, candidate release 1 \| 1.1.0~CR2 \| `+1.1.0~CR2+` \| this is a prerelease, candidate release 2 \| 1.1.0-1% \| `+1.1.0+` \| final release \| 1.1.0-GA1 \| `+1.1.0.20201001.GA1+` \| post release, GA1 \| 1.1.0-CP1 \| `+1.1.0.20201011.CP1+` \| post release, CP1, after GA1, does not sort properly \| 1.1.0-CP2 \| `+1.1.0.20201101.CP2+` \| post release, CP2, after CP1 \| 1.1.0-SP1 \| `+1.1.0.20210101.SP1+` \| post release, SP1, after CP2 \| 1.1.0-SP1-CP1 \| `+1.1.0.20210105.SP1_CP1+` \| post release, SP1_CP1, after SP1
	In this case the full N-V-R could be e.g. `pkg-1.1.0.20210105.SP1_CP1-1.fc{CURRENTVER}`.
	Complex versioning with a pre- and post-release snapshots
	\|Upstream version \| Version \| Notes \| 1.0.0-rc1 \| `+1.0.0~rc1+` \| First prerelease \| 1.0.0-rc2 \| `+1.0.0~rc2+` \| Second prerelease \| git commit `f00fabd` \| `+1.0.0~rc2^20210101gf00fabd+` \| Post-prerelease snapshot \| 1.0.0 \| `+1.0.0+` \| A release \| 1.0.1 \| `+1.0.1+` \| A bugfix release \| git commit `bbbccc0` \| `+1.0.1^20210203gbbbccc0+` or `+pkg-1.0.1^1.gbbbccc0+` \| A snapshot \| 1.0.1-security1 \| `+1.0.1.security1+` \| A security bufix release. From past history we know that the bugfix releases will have sortable versions. If not, we could use '`+<date>.security1+`' instead. \| git commit `abc0202` \| `+1.0.1.security1^20210301gabc0202+` or `+pkg-1.0.1.security1^1.gabc0202+` \| Another snapshot

Loading…

None

Source string added

English 0 characters edited

4 years ago

Browse all string changes

Things to check

Multiple failing checks

Following checks are failing:
Inconsistent: Finnish, Portuguese (Brazil)

Reset

Glossary

English	English
No related strings found in the glossary.

1006023 String information

Source string description

type: Title ===

Flags

no-wrap, read-only

Source string location

./pages/Versioning.adoc:254 • ./pages/Versioning.adoc:497

String age

4 years ago

Last updated

4 weeks ago

Source string age

4 years ago

Translation file

pot/master/pages/Versioning.pot, string 70

Shortcut	Action
`?`	Open available keyboard shortcuts.
`Alt` + `Home`	Navigate to the first translation in the current search.
`Alt` + `End`	Navigate to the last translation in the current search.
`Alt` + `PageUp` or `Ctrl` + `↑` or `Alt` + `↑` or `Cmd` + `↑` or	Navigate to the last translation in the current search.
`Alt` + `PageDown` or `Ctrl` + `↓` or `Alt` + `↓` or `Cmd` + `↓` or	Navigate to the next translation in the current search.
`Ctrl` + `Enter` or `Cmd` + `Enter`	Submit current form; this works the same as pressing Save and continue while editing translation.
`Ctrl` + `Shift` + `Enter` or `Cmd` + `Shift` +`Enter`	Unmark translation as Needing edit and submit it.
`Alt` + `Enter` or `Option` + `Enter`	Submit the string as a suggestion; this works the same as pressing Suggest while editing translation.
`Ctrl` + `E` or `Cmd` + `E`	Focus on translation editor.
`Ctrl` + `U` or `Cmd` + `U`	Focus on comment editor.
`Ctrl` + `M` or `Cmd` + `M`	Shows Automatic suggestions tab.
`Ctrl` + `1` to `Ctrl` + `9` or `Cmd` + `1` to `Cmd` + `9`	Copies placeable of a given number from source string.
`Ctrl` + `M` followed by `1` to `9` or `Cmd` + `M` followed by `1` to `9`	Copy the machine translation of a given number to current translation.
`Ctrl` + `I` followed by `1` to `9` or `Cmd` + `I` followed by `1` to `9`	Ignore one item in the list of failing checks.
`Ctrl` + `J` or `Cmd` + `J`	Shows the Nearby strings tab.
`Ctrl` + `S` or `Cmd` + `S`	Focus on search field.
`Ctrl` + `O` or `Cmd` + `O`	Copy the source string.
`Ctrl` + `Y` or `Cmd` + `Y`	Toggle the Needs editing checkbox.
`→`	Browse the next translation string.
`←`	Browse the previous translation string.