diff options
| author | Guido Günther <agx@sigxcpu.org> | 2016-11-16 14:12:24 +0100 |
|---|---|---|
| committer | Guido Günther <agx@sigxcpu.org> | 2016-11-16 14:12:24 +0100 |
| commit | 0b317eeb649090ab8bdd8507c189477670a91cd1 (patch) | |
| tree | 64ad6b09c3c2e8a705f9421663bb65322eb1d42d | |
| parent | 7ed5e2b5ffbaf8dec310f98162e653fc95cd45f9 (diff) | |
docs: Use version mangling with care
| -rw-r--r-- | docs/chapters/import.sgml | 9 | ||||
| -rw-r--r-- | docs/common.ent | 1 |
2 files changed, 10 insertions, 0 deletions
diff --git a/docs/chapters/import.sgml b/docs/chapters/import.sgml index c42279c9..a64e644f 100644 --- a/docs/chapters/import.sgml +++ b/docs/chapters/import.sgml @@ -297,6 +297,15 @@ upstream-tag = v%(version%.%_)s you have to escape it. E.g. <replaceable>%(version%-%\%)s</replaceable> will replace <replaceable>-</replaceable> with <replaceable>%</replaceable>, transforming <replaceable>1-A.B.C</replaceable> to <replaceable>1%A.B.C</replaceable>. Only a single replacement is supported and it can only replace a single character. + <warning> + <para> + Since some of the possible mangling characters + like <replaceable>_</replaceable> and <replaceable>%</replaceable> are also used to denote epochs and tilde revisions + these versions can't be reconstructed when mapping from &git; tags back to &debian; versions and will therefore break other tools + like &gbp-dch;. So use version mangling with care. It's better to come up with a Debian compatible tag format upstream, + see &dep14; for the currently used expansion rules for Debian versions. + </para> + </warning> </para> <para>If you're using &pristine-tar;, you can make &gbp-buildpackage; commit the generated tarball back to the diff --git a/docs/common.ent b/docs/common.ent index a7832f91..0d118074 100644 --- a/docs/common.ent +++ b/docs/common.ent @@ -58,3 +58,4 @@ <!ENTITY gpl "&gnu; <acronym>GPL</acronym>"> <!ENTITY pyformat "<ulink url='https://docs.python.org/2/library/stdtypes.html#string-formatting'><citetitle>Python format string</citetitle></ulink>"> + <!ENTITY dep14 "<ulink url='http://dep.debian.net/deps/dep14/'><citetitle>DEP-14</citetitle></ulink>">
\ No newline at end of file |