/usr/share/doc/monotone/html/Reserved-Files.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.0, http://www.gnu.org/software/texinfo/ -->
<head>
<title>monotone documentation: Reserved Files</title>

<meta name="description" content="monotone documentation: Reserved Files">
<meta name="keywords" content="monotone documentation: Reserved Files">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="General-Index.html#General-Index" rel="index" title="General Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Advanced-Uses.html#Advanced-Uses" rel="up" title="Advanced Uses">
<link href="Reserved-Certs.html#Reserved-Certs" rel="next" title="Reserved Certs">
<link href="Managed-Databases.html#Managed-Databases" rel="prev" title="Managed Databases">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="texinfo.css">


</head>

<body lang="en">
<a name="Reserved-Files"></a>
<div class="header">
<p>
Next: <a href="Reserved-Certs.html#Reserved-Certs" accesskey="n" rel="next">Reserved Certs</a>, Previous: <a href="Managed-Databases.html#Managed-Databases" accesskey="p" rel="prev">Managed Databases</a>, Up: <a href="Advanced-Uses.html#Advanced-Uses" accesskey="u" rel="up">Advanced Uses</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="General-Index.html#General-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Reserved-Files-1"></a>
<h3 class="section">3.11 Reserved Files</h3>

<p>A monotone workspace consists of control files and non-control
files. Each type of file can be versioned or non-versioned. These
classifications lead to four groups of files:
</p>
<ul>
<li> versioned control files
</li><li> non-versioned control files
</li><li> versioned non-control files
</li><li> non-versioned non-control files
</li></ul>

<p>Control files contain special content formatted for use by
monotone. Versioned files are recorded in a monotone database and have
their state tracked as they are modified.
</p>
<p>If a control file is versioned, it is considered <em>part of</em> the
state of the workspace, and will be recorded as a manifest
entry. If a control file is not versioned, it is used to <em>manage</em>
the state of the workspace, but it not considered an intrinsic part
of it.
</p>
<p>Most files you manage with monotone will be versioned non-control
files. For example, if you keep source code or documents in a monotone
database, they are versioned non-control files. Non-versioned,
non-control files in your workspace are generally temporary or junk
files, such as backups made by editors or object files made by
compilers. Such files are ignored by monotone.
</p>
<a name="Identifying-control-files"></a>
<h3 class="heading">Identifying control files</h3>

<p>Control files are identified by their names. Non-control files can
have any name <em>except</em> the names reserved for control files. The
names of control files follow a regular pattern:
</p>
<dl compact="compact">
<dt>Versioned control files</dt>
<dd><p>Any file name beginning with <samp>.mtn-</samp>
</p></dd>
<dt>Non-versioned control files</dt>
<dd><p>Any file in the directory <samp>_MTN/</samp>
</p></dd>
</dl>

<p>The general intention is that versioned control files are things that
you may want to edit directly.  In comparison, you should never have
to edit non-versioned control files directly; monotone should do that
for you whenever it is appropriate.  However, both are documented
here, just in case a situation arises where you need to go &ldquo;under the
hood&rdquo;.
</p>
<a name="Existing-control-files-and-directories"></a>
<h3 class="heading">Existing control files and directories</h3>

<p>The following control files are currently used. More control files may be added
in the future, but they will follow the patterns given above.
</p>
<dl compact="compact">
<dt><samp>.mtn-ignore</samp></dt>
<dd><p>Contains a list of regular expression patterns, one per line. If it exists,
any file with a name matching one of these patterns is
ignored. See <a href="Regexps.html#Regexps">Regexps</a>, for the syntax of these regular expressions.
</p></dd>
<dt><samp>_MTN/wanted-testresults</samp></dt>
<dd><p>Contains a list of testresult key names, one per line. If it exists, update
will only select revisions that do not have regressions according to the given
testresult keys.
</p></dd>
<dt><samp>_MTN/revision</samp></dt>
<dd><p>Contains the identity of the &ldquo;base&rdquo; revision of the workspace, and a
list of additions, deletions, and renames which have occurred in the
current workspace, relative to that version.
</p>
<p>Every workspace has a base revision, which is the revision that was
originally checked out to create that workspace.  When the workspace
is committed, the base revision is considered to be the ancestor of
the committed revision.
</p></dd>
<dt><samp>_MTN/options</samp></dt>
<dd><p>Contains &ldquo;sticky&rdquo; command-line options such as <samp>--db</samp> or
<samp>--branch</samp>, such that you do not need to enter them repeatedly
after checking out a particular workspace.
</p></dd>
<dt><samp>_MTN/log</samp></dt>
<dd><p>Contains log messages to append to the &ldquo;changelog&rdquo; cert upon
commit. The user may add content to this file while they work.  Upon a
successful commit monotone will empty the file making it ready for the
next edit/commit cycle.
</p></dd>
<dt><samp>_MTN/commit</samp></dt>
<dd><p>If a commit fails, f.e. because a header field could not be parsed
properly, then this file will contain a dump of the complete contents
which have been saved through the editor.  After the information has
been recovered from this file, it has to be removed explicitly, since
a new commit won&rsquo;t be possible as long as this file exists.
</p></dd>
<dt><samp>_MTN/inodeprints</samp></dt>
<dd><p>If this file exists, monotone considers the directory to be in
<a href="Inodeprints.html#Inodeprints">Inodeprints</a> mode, and uses this file to cache the inodeprints.
</p></dd>
<dt><samp>_MTN/debug</samp></dt>
<dd><p>If monotone detects a bug in itself or crashes, then before exiting it
dumps a log of its recent activity to this file, to aid in debugging.
</p></dd>
<dt><samp>_MTN/bisect</samp></dt>
<dd><p>Contains the current state of an ongoing bisection.  See <a href="Bisecting.html#Bisecting">Bisecting</a>
for more information.
</p></dd>
<dt><samp>_MTN/update</samp></dt>
<dd><p>Remembers the update / previous base revision of the workspace when
the <code>u:</code> selector is used.  See <a href="Selectors.html#Selectors">Selectors</a> for more information.
</p></dd>
<dt><samp>_MTN/conflicts</samp></dt>
<dd><p>The default file which is used by monotone to read and write merge conflicts
for conflict resolution.  See <a href="Conflicts.html#Conflicts">Conflicts</a> for more information.
</p></dd>
<dt><samp>_MTN/resolutions</samp></dt>
<dd><p>The directory in which monotone moves unversioned, conflicting files from
a workspace to, in case <code>update</code> or other commands are called with
the <samp>--move-conflicting-paths</samp> option.
</p></dd>
</dl>


<hr>
<div class="header">
<p>
Next: <a href="Reserved-Certs.html#Reserved-Certs" accesskey="n" rel="next">Reserved Certs</a>, Previous: <a href="Managed-Databases.html#Managed-Databases" accesskey="p" rel="prev">Managed Databases</a>, Up: <a href="Advanced-Uses.html#Advanced-Uses" accesskey="u" rel="up">Advanced Uses</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="General-Index.html#General-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
monotone-doc 1.1-7 / usr / share / doc / monotone / html / Reserved-Files.html
