/usr/share/doc/monotone/html/Reserved-Files.html is in monotone-doc 1.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | <html lang="en">
<head>
<title>Reserved Files - monotone documentation</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="monotone documentation">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Advanced-Uses.html#Advanced-Uses" title="Advanced Uses">
<link rel="prev" href="Managed-Databases.html#Managed-Databases" title="Managed Databases">
<link rel="next" href="Reserved-Certs.html#Reserved-Certs" title="Reserved Certs">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
<link rel="stylesheet" type="text/css" href="texinfo.css">
</head>
<body>
<div class="node">
<a name="Reserved-Files"></a>
<p>
Next: <a rel="next" accesskey="n" href="Reserved-Certs.html#Reserved-Certs">Reserved Certs</a>,
Previous: <a rel="previous" accesskey="p" href="Managed-Databases.html#Managed-Databases">Managed Databases</a>,
Up: <a rel="up" accesskey="u" href="Advanced-Uses.html#Advanced-Uses">Advanced Uses</a>
<hr>
</div>
<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:
<ul>
<li>versioned control files
<li>non-versioned control files
<li>versioned non-control files
<li>non-versioned non-control files
</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>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>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.
<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:
<dl>
<dt>Versioned control files<dd>Any file name beginning with <samp><span class="file">.mtn-</span></samp>
<br><dt>Non-versioned control files<dd>Any file in the directory <samp><span class="file">_MTN/</span></samp>
</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 “under the
hood”.
<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.
<dl>
<dt><samp><span class="file">.mtn-ignore</span></samp><dd>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.
<br><dt><samp><span class="file">_MTN/wanted-testresults</span></samp><dd>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.
<br><dt><samp><span class="file">_MTN/revision</span></samp><dd>Contains the identity of the “base” revision of the workspace, and a
list of additions, deletions, and renames which have occurred in the
current workspace, relative to that version.
<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.
<br><dt><samp><span class="file">_MTN/options</span></samp><dd>Contains “sticky” command-line options such as <samp><span class="option">--db</span></samp> or
<samp><span class="option">--branch</span></samp>, such that you do not need to enter them repeatedly
after checking out a particular workspace.
<br><dt><samp><span class="file">_MTN/log</span></samp><dd>Contains log messages to append to the “changelog” 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.
<br><dt><samp><span class="file">_MTN/commit</span></samp><dd>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't be possible as long as this file exists.
<br><dt><samp><span class="file">_MTN/inodeprints</span></samp><dd>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.
<br><dt><samp><span class="file">_MTN/debug</span></samp><dd>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.
<br><dt><samp><span class="file">_MTN/bisect</span></samp><dd>Contains the current state of an ongoing bisection. See <a href="Bisecting.html#Bisecting">Bisecting</a>
for more information.
<br><dt><samp><span class="file">_MTN/update</span></samp><dd>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.
<br><dt><samp><span class="file">_MTN/conflicts</span></samp><dd>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.
<br><dt><samp><span class="file">_MTN/resolutions</span></samp><dd>The directory in which monotone moves unversioned, conflicting files from
a workspace to, in case <samp><span class="command">update</span></samp> or other commands are called with
the <samp><span class="option">--move-conflicting-paths</span></samp> option.
</dl>
</body></html>
|