Merge lp:~jelmer/bzr-builder/doc-subst-vars into lp:bzr-builder

[Jelmer Vernooij]

Document the new substitution variables introduced in recipe format 0.4, and clarify the help for {debupstream}.

[Martin Packman (gz)]

+ * {debupstream}/{debupstream:<branch name} will be replaced by the upstream

Missing a '>'.

+ * {latest-tag}/{latest-tag:<branch name} will be replaced with the
+ name of the tag found on the most recent tag on a revision in the
+ branch mainline.

Also missing a '>'. I can't parse this, "tag found on the most recent tag" seems like an error.

Otherwise reads fine.

review: Approve

=== modified file '__init__.py'
--- __init__.py	2011-11-10 17:32:04 +0000
+++ __init__.py	2011-11-30 18:32:23 +0000
@@ -123,10 +123,31 @@
   * {revno} will be the revno of the base branch (the first specified).
   * {revno:<branch name>} will be substituted with the revno for the
     branch named <branch name> in the recipe.
-  * {debupstream} will be replaced by the upstream portion of the version
-    number taken from debian/changelog in the final tree. If when the
-    tree is built the top of debian/changelog has a version number of
-    "1.0-1" then this would evaluate to "1.0".
+  * {debupstream}/{debupstream:<branch name} will be replaced by the upstream
+    portion of the version number taken from debian/changelog in the branch.
+    For example, if debian/changelog has a version number of "1.0-1" then this
+    would evaluate to "1.0".
+  * {debupstream-base}/{debupstream-base:<branch name>} will be replaced by the
+    upstream portion of the version number taken from debian/changelog in the
+    branch, with any VCS markers stripped.  For example, if debian/changelog
+    has a version number of "1.0~bzr43-1" then this would evaluate to "1.0~".
+    For any upstream versions without a VCS marker, a "+" is added to the
+    version ("1.0-1" becomes "1.0+").
+  * {debversion}/{debversion:<branch name>} will be substituted with
+    the exact version string from debian/changelog in the branch.
+  * {revtime}/{revtime:<branch name>} will be substituted with the date and
+    time of the revision that was built, such as 201108191512.
+  * {revdate}/{revdate:<branch name>} will be substituted with the date
+    of the revision that was built, such as 20111222.
+  * {latest-tag}/{latest-tag:<branch name} will be replaced with the
+    name of the tag found on the most recent tag on a revision in the
+    branch mainline.
+  * {git-commit}/{git-commit:<branch name>} will be substituted with the last 7
+    characters of the SHA1 checksum of the revision that was built, if the
+    revision was imported from a Git repository.
+  * {svn-revno}/{svn-revno:<branch name>} will be substituted with the
+    Subversion revision number of the revision that was built, if the
+    revision was imported from a Subversion repository.
 
 Instruction syntax summary: