Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles.html

changeset 3316
aaa864fa5c1e
child 3359
6b6c224d67d6
equal deleted inserted replaced
3315:bd1a25ead18d 3316:aaa864fa5c1e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric5.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric5.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles</h1>
23 <p>
24 Module implementing the largefiles extension interface.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#Largefiles">Largefiles</a></td>
34 <td>Class implementing the largefiles extension interface.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="Largefiles" ID="Largefiles"></a>
43 <h2>Largefiles</h2>
44 <p>
45 Class implementing the largefiles extension interface.
46 </p>
47 <h3>Derived from</h3>
48 HgExtension
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#Largefiles.__init__">Largefiles</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#Largefiles.hgAdd">hgAdd</a></td>
64 <td>Public method used to add a file to the Mercurial repository.</td>
65 </tr><tr>
66 <td><a href="#Largefiles.hgLfPull">hgLfPull</a></td>
67 <td>Public method to pull missing large files into the local repository.</td>
68 </tr><tr>
69 <td><a href="#Largefiles.hgLfVerify">hgLfVerify</a></td>
70 <td>Public method to verify large files integrity.</td>
71 </tr><tr>
72 <td><a href="#Largefiles.hgLfconvert">hgLfconvert</a></td>
73 <td>Public slot to convert the repository format of the current project.</td>
74 </tr>
75 </table>
76 <h3>Static Methods</h3>
77 <table>
78 <tr><td>None</td></tr>
79 </table>
80 <a NAME="Largefiles.__init__" ID="Largefiles.__init__"></a>
81 <h4>Largefiles (Constructor)</h4>
82 <b>Largefiles</b>(<i>vcs</i>)
83 <p>
84 Constructor
85 </p><dl>
86 <dt><i>vcs</i></dt>
87 <dd>
88 reference to the Mercurial vcs object
89 </dd>
90 </dl><a NAME="Largefiles.hgAdd" ID="Largefiles.hgAdd"></a>
91 <h4>Largefiles.hgAdd</h4>
92 <b>hgAdd</b>(<i>names, mode</i>)
93 <p>
94 Public method used to add a file to the Mercurial repository.
95 </p><dl>
96 <dt><i>name</i></dt>
97 <dd>
98 file name(s) to be added (string or list of string)
99 </dd><dt><i>mode</i></dt>
100 <dd>
101 add mode (string one of 'normal' or 'large')
102 </dd>
103 </dl><a NAME="Largefiles.hgLfPull" ID="Largefiles.hgLfPull"></a>
104 <h4>Largefiles.hgLfPull</h4>
105 <b>hgLfPull</b>(<i>projectDir, revisions=None</i>)
106 <p>
107 Public method to pull missing large files into the local repository.
108 </p><dl>
109 <dt><i>projectDir</i></dt>
110 <dd>
111 directory name of the project (string)
112 </dd><dt><i>revisions</i></dt>
113 <dd>
114 list of revisions to pull (list of string)
115 </dd>
116 </dl><a NAME="Largefiles.hgLfVerify" ID="Largefiles.hgLfVerify"></a>
117 <h4>Largefiles.hgLfVerify</h4>
118 <b>hgLfVerify</b>(<i>projectDir, mode</i>)
119 <p>
120 Public method to verify large files integrity.
121 </p><dl>
122 <dt><i>projectDir</i></dt>
123 <dd>
124 directory name of the project (string)
125 </dd><dt><i>mode</i></dt>
126 <dd>
127 verify mode (string; one of 'large', 'lfa' or 'lfc')
128 </dd>
129 </dl><a NAME="Largefiles.hgLfconvert" ID="Largefiles.hgLfconvert"></a>
130 <h4>Largefiles.hgLfconvert</h4>
131 <b>hgLfconvert</b>(<i>direction, projectFile</i>)
132 <p>
133 Public slot to convert the repository format of the current project.
134 </p><dl>
135 <dt><i>direction</i></dt>
136 <dd>
137 direction of the conversion (string, one of
138 'largefiles' or 'normal')
139 </dd><dt><i>projectFile</i></dt>
140 <dd>
141 file name of the current project file (string)
142 </dd>
143 </dl>
144 <div align="right"><a href="#top">Up</a></div>
145 <hr />
146 </body></html>

eric ide

mercurial