Debian Codegraph @

doc/html/ext-remotefilelog.html

raw
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6 <meta name="generator" content="Docutils 0.21.2: https://docutils.sourceforge.io/" />
7 <title>remotefilelog</title>
8 <link rel="stylesheet" href="../style.css" type="text/css" />
9 </head>
10 <body>
11 <div class="document" id="remotefilelog">
12 <span id="ext-remotefilelog"></span>
13 <h1 class="title">remotefilelog</h1>
14
15 <div class="contents htmlonly topic" id="contents">
16 <p class="topic-title"><a class="reference internal" href="#top">Contents</a></p>
17 <ul class="simple">
18 <li><a class="reference internal" href="#description" id="toc-entry-1">Description</a></li>
19 <li><a class="reference internal" href="#commands" id="toc-entry-2">Commands</a><ul>
20 <li><a class="reference internal" href="#repository-maintenance" id="toc-entry-3">Repository maintenance</a></li>
21 <li><a class="reference internal" href="#uncategorized-commands" id="toc-entry-4">Uncategorized commands</a></li>
22 </ul>
23 </li>
24 </ul>
25 </div>
26 <p>remotefilelog causes Mercurial to lazilly fetch file contents (EXPERIMENTAL)</p>
27 <div class="section" id="description">
28 <h1><a class="toc-backref" href="#contents">Description</a></h1>
29 <p>This extension is HIGHLY EXPERIMENTAL. There are NO BACKWARDS COMPATIBILITY
30 GUARANTEES. This means that repositories created with this extension may
31 only be usable with the exact version of this extension/Mercurial that was
32 used. The extension attempts to enforce this in order to prevent repository
33 corruption.</p>
34 <p>remotefilelog works by fetching file contents lazily and storing them
35 in a cache on the client rather than in revlogs. This allows enormous
36 histories to be transferred only partially, making them easier to
37 operate on.</p>
38 <p>Configs:</p>
39 <blockquote>
40 <p><tt class="docutils literal">packs.maxchainlen</tt> specifies the maximum delta chain length in pack files</p>
41 <p><tt class="docutils literal">packs.maxpacksize</tt> specifies the maximum pack file size</p>
42 <dl class="docutils">
43 <dt><tt class="docutils literal">packs.maxpackfilecount</tt> specifies the maximum number of packs in the</dt>
44 <dd>shared cache (trees only for now)</dd>
45 </dl>
46 <p><tt class="docutils literal">remotefilelog.backgroundprefetch</tt> runs prefetch in background when True</p>
47 <dl class="docutils">
48 <dt><tt class="docutils literal">remotefilelog.bgprefetchrevs</tt> specifies revisions to fetch on commit and</dt>
49 <dd>update, and on other commands that use them. Different from pullprefetch.</dd>
50 </dl>
51 <p><tt class="docutils literal">remotefilelog.gcrepack</tt> does garbage collection during repack when True</p>
52 <dl class="docutils">
53 <dt><tt class="docutils literal">remotefilelog.nodettl</tt> specifies maximum TTL of a node in seconds before</dt>
54 <dd>it is garbage collected</dd>
55 </dl>
56 <p><tt class="docutils literal">remotefilelog.repackonhggc</tt> runs repack on hg gc when True</p>
57 <dl class="docutils">
58 <dt><tt class="docutils literal">remotefilelog.prefetchdays</tt> specifies the maximum age of a commit in</dt>
59 <dd>days after which it is no longer prefetched.</dd>
60 <dt><tt class="docutils literal">remotefilelog.prefetchdelay</tt> specifies delay between background</dt>
61 <dd>prefetches in seconds after operations that change the working copy parent</dd>
62 <dt><tt class="docutils literal">remotefilelog.data.gencountlimit</tt> constraints the minimum number of data</dt>
63 <dd>pack files required to be considered part of a generation. In particular,
64 minimum number of packs files &gt; gencountlimit.</dd>
65 <dt><tt class="docutils literal">remotefilelog.data.generations</tt> list for specifying the lower bound of</dt>
66 <dd>each generation of the data pack files. For example, list ['100MB','1MB']
67 or ['1MB', '100MB'] will lead to three generations: [0, 1MB), [
68 1MB, 100MB) and [100MB, infinity).</dd>
69 <dt><tt class="docutils literal">remotefilelog.data.maxrepackpacks</tt> the maximum number of pack files to</dt>
70 <dd>include in an incremental data repack.</dd>
71 <dt><tt class="docutils literal">remotefilelog.data.repackmaxpacksize</tt> the maximum size of a pack file for</dt>
72 <dd>it to be considered for an incremental data repack.</dd>
73 <dt><tt class="docutils literal">remotefilelog.data.repacksizelimit</tt> the maximum total size of pack files</dt>
74 <dd>to include in an incremental data repack.</dd>
75 <dt><tt class="docutils literal">remotefilelog.history.gencountlimit</tt> constraints the minimum number of</dt>
76 <dd>history pack files required to be considered part of a generation. In
77 particular, minimum number of packs files &gt; gencountlimit.</dd>
78 <dt><tt class="docutils literal">remotefilelog.history.generations</tt> list for specifying the lower bound of</dt>
79 <dd>each generation of the history pack files. For example, list [
80 '100MB', '1MB'] or ['1MB', '100MB'] will lead to three generations: [
81 0, 1MB), [1MB, 100MB) and [100MB, infinity).</dd>
82 <dt><tt class="docutils literal">remotefilelog.history.maxrepackpacks</tt> the maximum number of pack files to</dt>
83 <dd>include in an incremental history repack.</dd>
84 <dt><tt class="docutils literal">remotefilelog.history.repackmaxpacksize</tt> the maximum size of a pack file</dt>
85 <dd>for it to be considered for an incremental history repack.</dd>
86 <dt><tt class="docutils literal">remotefilelog.history.repacksizelimit</tt> the maximum total size of pack</dt>
87 <dd>files to include in an incremental history repack.</dd>
88 <dt><tt class="docutils literal">remotefilelog.backgroundrepack</tt> automatically consolidate packs in the</dt>
89 <dd>background</dd>
90 </dl>
91 <p><tt class="docutils literal">remotefilelog.cachepath</tt> path to cache</p>
92 <dl class="docutils">
93 <dt><tt class="docutils literal">remotefilelog.cachegroup</tt> if set, make cache directory sgid to this</dt>
94 <dd>group</dd>
95 </dl>
96 <p><tt class="docutils literal">remotefilelog.cacheprocess</tt> binary to invoke for fetching file data</p>
97 <p><tt class="docutils literal">remotefilelog.debug</tt> turn on remotefilelog-specific debug output</p>
98 <p><tt class="docutils literal">remotefilelog.excludepattern</tt> pattern of files to exclude from pulls</p>
99 <p><tt class="docutils literal">remotefilelog.includepattern</tt> pattern of files to include in pulls</p>
100 <dl class="docutils">
101 <dt><tt class="docutils literal">remotefilelog.fetchwarning</tt>: message to print when too many</dt>
102 <dd>single-file fetches occur</dd>
103 </dl>
104 <p><tt class="docutils literal">remotefilelog.getfilesstep</tt> number of files to request in a single RPC</p>
105 <dl class="docutils">
106 <dt><tt class="docutils literal">remotefilelog.getfilestype</tt> if set to 'threaded' use threads to fetch</dt>
107 <dd>files, otherwise use optimistic fetching</dd>
108 <dt><tt class="docutils literal">remotefilelog.pullprefetch</tt> revset for selecting files that should be</dt>
109 <dd>eagerly downloaded rather than lazily</dd>
110 <dt><tt class="docutils literal">remotefilelog.reponame</tt> name of the repo. If set, used to partition</dt>
111 <dd>data from other repos in a shared store.</dd>
112 </dl>
113 <p><tt class="docutils literal">remotefilelog.server</tt> if true, enable server-side functionality</p>
114 <p><tt class="docutils literal">remotefilelog.servercachepath</tt> path for caching blobs on the server</p>
115 <dl class="docutils">
116 <dt><tt class="docutils literal">remotefilelog.serverexpiration</tt> number of days to keep cached server</dt>
117 <dd>blobs</dd>
118 <dt><tt class="docutils literal">remotefilelog.validatecache</tt> if set, check cache entries for corruption</dt>
119 <dd>before returning blobs</dd>
120 <dt><tt class="docutils literal">remotefilelog.validatecachelog</tt> if set, check cache entries for</dt>
121 <dd>corruption before returning metadata</dd>
122 </dl>
123 </blockquote>
124 </div>
125 <div class="section" id="commands">
126 <h1><a class="toc-backref" href="#contents">Commands</a></h1>
127 <div class="section" id="repository-maintenance">
128 <h2><a class="toc-backref" href="#contents">Repository maintenance</a></h2>
129 <div class="section" id="prefetch">
130 <h3>prefetch</h3>
131 <p>prefetch file revisions from the server:</p>
132 <pre class="literal-block">
133 hg prefetch [OPTIONS] [FILE...]
134 </pre>
135 <p>Prefetchs file revisions for the specified revs and stores them in the
136 local remotefilelog cache. If no rev is specified, the default rev is
137 used which is the union of dot, draft, pullprefetch and bgprefetchrev.
138 File names or patterns can be used to limit which files are downloaded.</p>
139 <p>Return 0 on success.</p>
140 <p>Options:</p>
141 <table class="docutils option-list" frame="void" rules="none">
142 <col class="option" />
143 <col class="description" />
144 <tbody valign="top">
145 <tr><td class="option-group" colspan="2">
146 <kbd><span class="option">-r</span>, <span class="option">--rev <var>&lt;REV[+]&gt;</var></span></kbd></td>
147 </tr>
148 <tr><td>&nbsp;</td><td>prefetch the specified revisions</td></tr>
149 <tr><td class="option-group">
150 <kbd><span class="option">--repack</span></kbd></td>
151 <td>run repack after prefetch</td></tr>
152 <tr><td class="option-group" colspan="2">
153 <kbd><span class="option">-b</span>, <span class="option">--base <var>&lt;VALUE&gt;</var></span></kbd></td>
154 </tr>
155 <tr><td>&nbsp;</td><td>rev that is assumed to already be local</td></tr>
156 <tr><td class="option-group" colspan="2">
157 <kbd><span class="option">-I</span>, <span class="option">--include <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
158 </tr>
159 <tr><td>&nbsp;</td><td>include names matching the given patterns</td></tr>
160 <tr><td class="option-group" colspan="2">
161 <kbd><span class="option">-X</span>, <span class="option">--exclude <var>&lt;PATTERN[+]&gt;</var></span></kbd></td>
162 </tr>
163 <tr><td>&nbsp;</td><td>exclude names matching the given patterns</td></tr>
164 </tbody>
165 </table>
166 <p>[+] marked option can be specified multiple times</p>
167 </div>
168 </div>
169 <div class="section" id="uncategorized-commands">
170 <h2><a class="toc-backref" href="#contents">Uncategorized commands</a></h2>
171 <div class="section" id="gc">
172 <h3>gc</h3>
173 <p>garbage collect the client and server filelog caches:</p>
174 <pre class="literal-block">
175 hg gc [REPO...]
176 </pre>
177 <p>garbage collect the client and server filelog caches</p>
178 </div>
179 <div class="section" id="repack">
180 <h3>repack</h3>
181 <pre class="literal-block">
182 hg repack [OPTIONS]
183 </pre>
184 <p>Options:</p>
185 <table class="docutils option-list" frame="void" rules="none">
186 <col class="option" />
187 <col class="description" />
188 <tbody valign="top">
189 <tr><td class="option-group">
190 <kbd><span class="option">--background</span></kbd></td>
191 <td>run in a background process</td></tr>
192 <tr><td class="option-group">
193 <kbd><span class="option">--incremental</span></kbd></td>
194 <td>do an incremental repack</td></tr>
195 <tr><td class="option-group">
196 <kbd><span class="option">--packsonly</span></kbd></td>
197 <td>only repack packs (skip loose objects)</td></tr>
198 </tbody>
199 </table>
200 </div>
201 <div class="section" id="verifyremotefilelog">
202 <h3>verifyremotefilelog</h3>
203 <pre class="literal-block">
204 hg verifyremotefilelogs &lt;directory&gt;
205 </pre>
206 <p>Options:</p>
207 <table class="docutils option-list" frame="void" rules="none">
208 <col class="option" />
209 <col class="description" />
210 <tbody valign="top">
211 <tr><td class="option-group" colspan="2">
212 <kbd><span class="option">-d</span>, <span class="option">--decompress</span></kbd></td>
213 </tr>
214 <tr><td>&nbsp;</td><td>decompress the filelogs first</td></tr>
215 </tbody>
216 </table>
217 </div>
218 </div>
219 </div>
220 </div>
221 </body>
222 </html>