Reserve the "jvm" local version identifier
Marco Ricci commited on 2025-06-01 23:11:11
Zeige 1 geänderte Dateien mit 7 Einfügungen und 3 Löschungen.
Reserve the "jvm" local version identifier for `derivepassphrase-jvm`, an early-stage port of `derivepassphrase` to the Java Virtual Machine. (We reserve the identifier "jvm" instead of "java" because it is not yet final whether the port will continue to be written in Java, or rather in a different language targeting the JVM.)
- docs/explanation/faq-altered-versions.md 7748a07..d3ae757
| ... | ... |
@@ -1,13 +1,17 @@ |
| 1 | 1 |
# How to comply with the "altered versions" clause of the license |
| 2 | 2 |
|
| 3 |
+!!! abstract inline end "Local version identifiers reserved by upstream `derivepassphrase`" |
|
| 4 |
+ |
|
| 5 |
+ * `jvm` -- Indicates a build of `derivepassphrase` running on the Java Virtual Machine. |
|
| 6 |
+ |
|
| 3 | 7 |
**Short answer:** change the package name and/or include a [PEP 440][] "local version identifier" in the version number. |
| 4 | 8 |
If `derivepassphrase` ever rebrands, this applies to rebranded names too. |
| 5 | 9 |
We try not to clash with anyone else, and will yank our offending releases if we do. |
| 6 | 10 |
|
| 7 | 11 |
**Long answer:** We, upstream `derivepassphrase`, reserve the name `derivepassphrase` and certain version numbers for ourselves. |
| 8 |
-Specifically, our version numbers adhere to [PEP 440][] (or newer revisions) and generally do not include a "local version identifier". |
|
| 9 |
-To mark an altered version, we thus recommend that you change the software package name `derivepassphrase`, or use a version number with a local version identifier. |
|
| 10 |
-If we (upstream) decide to use a local version identifier, we will avoid all clashing local version identifiers we are aware of, and if informed of a clashing local version identifier after our release, will yank our offending version(s). |
|
| 12 |
+Specifically, our version numbers adhere to [PEP 440][] (or newer revisions) and generally do not include a "local version identifier" (except for the reserved ones mentioned in the info box). |
|
| 13 |
+To mark an altered version, we thus recommend that you change the software package name `derivepassphrase`, or use a version number with a different local version identifier. |
|
| 14 |
+If we (upstream) decide to use a new local version identifier, we will avoid all clashing local version identifiers we are aware of, and if informed of a clashing local version identifier after our release, will yank our offending version(s). |
|
| 11 | 15 |
|
| 12 | 16 |
Should we (upstream) change the package name, we shall apply the same guidelines and checks concerning local version identifiers to the new package name. |
| 13 | 17 |
A change of package name does *not* by itself imply permission to use the old package name for future releases of altered versions without marking them. |
| 14 | 18 |