<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>version-info — Bazaar 2.7.0 documentation</title>
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/bzr.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="view" href="view-help.html" />
<link rel="prev" title="version" href="version-help.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="view-help.html" title="view"
accesskey="N">next</a></li>
<li class="right" >
<a href="version-help.html" title="version"
accesskey="P">previous</a> |</li>
<li><a href="http://bazaar.canonical.com/">
<img src="../_static/bzr icon 16.png" /> Home</a> | </li>
<a href="http://doc.bazaar.canonical.com/en/">Documentation</a> | </li>
<li class="nav-item nav-item-0"><a href="../index.html">Table of Contents (2.7.0)</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Bazaar User Reference</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="version-info">
<h1>version-info<a class="headerlink" href="#version-info" title="Permalink to this headline">¶</a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Purpose:</th><td class="field-body"><p class="first">Show version information about this tree.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Usage:</th><td class="field-body"><p class="first">bzr version-info [LOCATION]</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Options:</th><td class="field-body"><table class="first docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">--all</span></kbd></td>
<td><p class="first last">Include all possible information.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></td>
<td><p class="first last">Display more information.</p>
</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--include-history</span></kbd></td>
</tr>
<tr><td> </td><td><p class="first last">Include the revision-history.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--check-clean</span></kbd></td>
<td><p class="first last">Check if tree is clean.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-q</span>, <span class="option">--quiet</span></kbd></td>
<td><p class="first last">Only display errors and warnings.</p>
</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--include-file-revisions</span></kbd></td>
</tr>
<tr><td> </td><td><p class="first last">Include the last revision for each file.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--template=<var>ARG</var></span></kbd></td>
<td><p class="first last">Template for the output.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--usage</span></kbd></td>
<td><p class="first last">Show usage message and options.</p>
</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-r <var>ARG</var></span>, <span class="option">--revision=<var>ARG</var></span></kbd></td>
</tr>
<tr><td> </td><td><p class="first last">See “help revisionspec” for details.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-h</span>, <span class="option">--help</span></kbd></td>
<td><p class="first last">Show help message.</p>
</td></tr>
</tbody>
</table>
<dl class="docutils">
<dt>format:</dt>
<dd><table class="first last docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">--format=<var>ARG</var></span></kbd></td>
<td><p class="first last">Select the output format.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--custom</span></kbd></td>
<td><p class="first last">Version info in Custom template-based format.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--python</span></kbd></td>
<td><p class="first last">Version info in Python format.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--rio</span></kbd></td>
<td><p class="first last">Version info in RIO (simple text) format (default).</p>
</td></tr>
</tbody>
</table>
</dd>
</dl>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Description:</th><td class="field-body"><p class="first">You can use this command to add information about version into
source code of an application. The output can be in one of the
supported formats or in a custom format based on a template.</p>
<p>For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bzr</span> <span class="n">version</span><span class="o">-</span><span class="n">info</span> <span class="o">--</span><span class="n">custom</span> \
<span class="o">--</span><span class="n">template</span><span class="o">=</span><span class="s2">"#define VERSION_INFO </span><span class="se">\"</span><span class="s2">Project 1.2.3 (r</span><span class="si">{revno}</span><span class="s2">)</span><span class="se">\"\n</span><span class="s2">"</span>
</pre></div>
</div>
<p>will produce a C header file with formatted string containing the
current revision number. Other supported variables in templates are:</p>
<blockquote class="last">
<div><ul class="simple">
<li>{date} - date of the last revision</li>
<li>{build_date} - current date</li>
<li>{revno} - revision number</li>
<li>{revision_id} - revision id</li>
<li>{branch_nick} - branch nickname</li>
<li><dl class="first docutils">
<dt>{clean} - 0 if the source tree contains uncommitted changes,</dt>
<dd>otherwise 1</dd>
</dl>
</li>
</ul>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="version-help.html"
title="previous chapter">version</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="view-help.html"
title="next chapter">view</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/user-reference/version-info-help.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="view-help.html" title="view"
>next</a></li>
<li class="right" >
<a href="version-help.html" title="version"
>previous</a> |</li>
<li><a href="http://bazaar.canonical.com/">
<img src="../_static/bzr icon 16.png" /> Home</a> | </li>
<a href="http://doc.bazaar.canonical.com/en/">Documentation</a> | </li>
<li class="nav-item nav-item-0"><a href="../index.html">Table of Contents (2.7.0)</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >Bazaar User Reference</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2009-2011 Canonical Ltd.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
</div>
</body>
</html>
