<!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>shelve — 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="sign-my-commits" href="sign-my-commits-help.html" />
<link rel="prev" title="serve" href="serve-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="sign-my-commits-help.html" title="sign-my-commits"
accesskey="N">next</a></li>
<li class="right" >
<a href="serve-help.html" title="serve"
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="shelve">
<h1>shelve<a class="headerlink" href="#shelve" 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">Temporarily set aside some changes from the current tree.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Usage:</th><td class="field-body"><p class="first">bzr shelve [FILE…]</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">Shelve all changes.</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">
<kbd><span class="option">--list</span></kbd></td>
<td><p class="first last">List shelved changes.</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>
<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">-d <var>ARG</var></span>, <span class="option">--directory=<var>ARG</var></span></kbd></td>
</tr>
<tr><td> </td><td><p class="first last">Branch to operate on, instead of working directory.</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">
<kbd><span class="option">--destroy</span></kbd></td>
<td><p class="first last">Destroy removed changes instead of shelving them.</p>
</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">-m <var>ARG</var></span>, <span class="option">--message=<var>ARG</var></span></kbd></td>
</tr>
<tr><td> </td><td><p class="first last">Message string.</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>
</tbody>
</table>
<dl class="docutils">
<dt>writer:</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">--plain</span></kbd></td>
<td><p class="first last">Plaintext diff output.</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">Shelve allows you to temporarily put changes you’ve made “on the shelf”,
ie. out of the way, until a later time when you can bring them back from
the shelf with the ‘unshelve’ command. The changes are stored alongside
your working tree, and so they aren’t propagated along with your branch nor
will they survive its deletion.</p>
<p>If shelve –list is specified, previously-shelved changes are listed.</p>
<p>Shelve is intended to help separate several sets of changes that have
been inappropriately mingled. If you just want to get rid of all changes
and you don’t need to restore them later, use revert. If you want to
shelve all text changes at once, use shelve –all.</p>
<p>If filenames are specified, only the changes to those files will be
shelved. Other files will be left untouched.</p>
<p>If a revision is specified, changes since that revision will be shelved.</p>
<p>You can put multiple items on the shelf, and by default, ‘unshelve’ will
restore the most recently shelved changes.</p>
<p>For complicated changes, it is possible to edit the changes in a separate
editor program to decide what the file remaining in the working copy
should look like. To do this, add the configuration option</p>
<blockquote>
<div><p>change_editor = PROGRAM @new_path @old_path</p>
</div></blockquote>
<p>where @new_path is replaced with the path of the new version of the
file and @old_path is replaced with the path of the old version of
the file. The PROGRAM should save the new file with the desired
contents of the file in the working tree.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">See also:</th><td class="field-body"><p class="first last"><a class="reference internal" href="configuration-help.html"><span class="doc">configuration</span></a>, <a class="reference internal" href="unshelve-help.html"><span class="doc">unshelve</span></a></p>
</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="serve-help.html"
title="previous chapter">serve</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="sign-my-commits-help.html"
title="next chapter">sign-my-commits</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/user-reference/shelve-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="sign-my-commits-help.html" title="sign-my-commits"
>next</a></li>
<li class="right" >
<a href="serve-help.html" title="serve"
>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>
