<!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="Content-Type" content="text/html; charset=utf-8" />
<title>End of Line Conversion — Bazaar v2.2.4 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.2.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="shortcut icon" href="../_static/bzr.ico"/>
<link rel="top" title="Bazaar v2.2.4 documentation" href="../index.html" />
<link rel="up" title="Bazaar User Reference" href="index.html" />
<link rel="next" title="Storage Formats" href="formats-help.html" />
<link rel="prev" title="Diverged Branches" href="diverged-branches-help.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="formats-help.html" title="Storage Formats"
accesskey="N">next</a></li>
<li class="right" >
<a href="diverged-branches-help.html" title="Diverged Branches"
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><a href="../index.html">Table of Contents (2.2.4)</a> »</li>
<li><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">
<div class="section" id="end-of-line-conversion">
<h1>End of Line Conversion<a class="headerlink" href="#end-of-line-conversion" title="Permalink to this headline">ΒΆ</a></h1>
<p>EOL conversion is provided as a content filter where Bazaar internally
stores a canonical format but outputs a convenience format. See
<tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">help</span> <span class="pre">content-filters</span></tt> for general information about using these.</p>
<p>Note: Content filtering is only supported in recently added formats,
e.g. 1.14. Be sure that both the repository <em>and</em> the branch are
in a recent format. (Just setting the format on the repository
is not enough.) If content filtering does not appear to be working, use
‘bzr info -v’ to confirm that the branch is using “Working tree format 5”
or later.</p>
<p>EOL conversion needs to be enabled for selected file patterns using
rules. See <tt class="docutils literal"><span class="pre">bzr</span> <span class="pre">help</span> <span class="pre">rules</span></tt> for general information on defining rules.
Currently, rules are only supported in $BZR_HOME/.bazaar/rules (or
%BZR_HOME%/bazaar/2.0/rules on Windows). Branch specific rules will be
supported in a future verison of Bazaar.</p>
<p>To configure which files to filter, set <tt class="docutils literal"><span class="pre">eol</span></tt> to one of the values below.
(If a value is not set, <tt class="docutils literal"><span class="pre">exact</span></tt> is the default.)</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="14%" />
<col width="54%" />
<col width="32%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Value</th>
<th class="head">Checkout end-of-lines as</th>
<th class="head">Commit end-of-lines as</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><tt class="docutils literal"><span class="pre">native</span></tt></td>
<td><tt class="docutils literal"><span class="pre">crlf</span></tt> on Windows, <tt class="docutils literal"><span class="pre">lf</span></tt> otherwise</td>
<td><tt class="docutils literal"><span class="pre">lf</span></tt></td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">lf</span></tt></td>
<td><tt class="docutils literal"><span class="pre">lf</span></tt></td>
<td><tt class="docutils literal"><span class="pre">lf</span></tt></td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">crlf</span></tt></td>
<td><tt class="docutils literal"><span class="pre">crlf</span></tt></td>
<td><tt class="docutils literal"><span class="pre">lf</span></tt></td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">exact</span></tt></td>
<td>No conversion</td>
<td>Exactly as in file</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>Note: For safety reasons, no conversion is applied to any file where a null
byte is detected in the file.</p>
<p>For users working on a cross-platform project, here is a suggested rule
to use as a starting point:</p>
<div class="highlight-python"><pre>[name *]
eol = native</pre>
</div>
<p>If you have binary files that do not contain a null byte though, be
sure to add <tt class="docutils literal"><span class="pre">eol</span> <span class="pre">=</span> <span class="pre">exact</span></tt> rules for those as well. You can do this
by giving more explicit patterns earlier in the rules file. For example:</p>
<div class="highlight-python"><pre>[name *.png]
eol = exact
[name *]
eol = native</pre>
</div>
<p>If your working tree is on a network drive shared by users on different
operating systems, you typically want to force certain conventions for
certain files. In that way, if a file is created with the wrong line
endings or line endings get mixed during editing, it gets committed
correctly and gets checked out correctly. For example:</p>
<div class="highlight-python"><pre>[name *.bat]
eol = crlf
[name *.sh]
eol = lf
[name *]
eol = native</pre>
</div>
<p>If you take the care to create files with their required endings, you can
achieve <em>almost</em> the same thing by using <tt class="docutils literal"><span class="pre">eol</span> <span class="pre">=</span> <span class="pre">exact</span></tt>. It is slightly
safer to use <tt class="docutils literal"><span class="pre">lf</span></tt> and <tt class="docutils literal"><span class="pre">crlf</span></tt> though because edits accidentally
introducing mixed line endings will be corrected during commit for files
with those settings.</p>
<p>If you have sample test data that deliberately has text files with mixed
newline conventions, you can ask for those to be left alone like this:</p>
<div class="highlight-python"><pre>[name test_data/]
eol = exact
[name *]
eol = native</pre>
</div>
<p>Note that <tt class="docutils literal"><span class="pre">exact</span></tt> does not imply the file is binary but it does mean
that no conversion of end-of-lines will be done. (Bazaar currently relies
of content analysis to detect binary files for commands like <tt class="docutils literal"><span class="pre">diff</span></tt>.
In the future, a <tt class="docutils literal"><span class="pre">binary</span> <span class="pre">=</span> <span class="pre">true</span></tt> rule may be added but it is not
supported yet.)</p>
<p>If you have an existing repository with text files already stored using
Windows newline conventions (<tt class="docutils literal"><span class="pre">crlf</span></tt>), then you may want to keep using that
convention in the repository. Forcing certain files to this convention
may also help users who do not have rules configured. To do this, set
<tt class="docutils literal"><span class="pre">eol</span></tt> to one of the values below.</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="38%" />
<col width="32%" />
<col width="30%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Value</th>
<th class="head">Checkout end-of-lines as</th>
<th class="head">Commit end-of-lines as</th>
</tr>
</thead>
<tbody valign="top">
<tr><td><tt class="docutils literal"><span class="pre">native-with-crlf-in-repo</span></tt></td>
<td><tt class="docutils literal"><span class="pre">crlf</span></tt> on Windows,
<tt class="docutils literal"><span class="pre">lf</span></tt> otherwise</td>
<td><tt class="docutils literal"><span class="pre">crlf</span></tt></td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">lf-with-crlf-in-repo</span></tt></td>
<td><tt class="docutils literal"><span class="pre">lf</span></tt></td>
<td><tt class="docutils literal"><span class="pre">crlf</span></tt></td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">crlf-with-crlf-in-repo</span></tt></td>
<td><tt class="docutils literal"><span class="pre">crlf</span></tt></td>
<td><tt class="docutils literal"><span class="pre">crlf</span></tt></td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>For users working on an existing project that uses Windows newline
conventions in their Bazaar repository, this rule is suggested as a
starting point:</p>
<div class="highlight-python"><pre>[name *]
eol = native-with-crlf-in-repo</pre>
</div>
<p>For new projects, it is recommended that end-of-lines be stored as <tt class="docutils literal"><span class="pre">lf</span></tt>
and that users stick to the basic settings, i.e. <tt class="docutils literal"><span class="pre">native</span></tt>, <tt class="docutils literal"><span class="pre">lf</span></tt>,
<tt class="docutils literal"><span class="pre">crlf</span></tt> and <tt class="docutils literal"><span class="pre">exact</span></tt>.</p>
<p>Note: Bazaar’s EOL conversion will convert the content of files but
never reject files because a given line ending or mixed line endings
are found. A precommit hook should be used if you wish to validate
(and not just convert) content before committing.</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="diverged-branches-help.html"
title="previous chapter">Diverged Branches</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="formats-help.html"
title="next chapter">Storage Formats</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/user-reference/eol-help.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="formats-help.html" title="Storage Formats"
>next</a></li>
<li class="right" >
<a href="diverged-branches-help.html" title="Diverged Branches"
>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><a href="../index.html">Table of Contents (2.2.4)</a> »</li>
<li><a href="index.html" >Bazaar User Reference</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009, Canonical Ltd.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
