src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
child 11006
a671918232f3
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles</h1>
10
11 <p> 10 <p>
12 Module implementing the largefiles extension interface. 11 Module implementing the largefiles extension interface.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#Largefiles">Largefiles</a></td> 22 <td><a href="#Largefiles">Largefiles</a></td>
25 <td>Class implementing the largefiles extension interface.</td> 23 <td>Class implementing the largefiles extension interface.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="Largefiles" ID="Largefiles"></a> 34 <a NAME="Largefiles" ID="Largefiles"></a>
36 <h2>Largefiles</h2> 35 <h2>Largefiles</h2>
37
38 <p> 36 <p>
39 Class implementing the largefiles extension interface. 37 Class implementing the largefiles extension interface.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 HgExtension 41 HgExtension
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44
45 <table> 43 <table>
46 <tr><td>None</td></tr> 44 <tr><td>None</td></tr>
47 </table> 45 </table>
46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49
50 <table> 48 <table>
51 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
52 </table> 50 </table>
51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54
55 <table> 53 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#Largefiles.__init__">Largefiles</a></td> 55 <td><a href="#Largefiles.__init__">Largefiles</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
73 <tr> 70 <tr>
74 <td><a href="#Largefiles.hgLfconvert">hgLfconvert</a></td> 71 <td><a href="#Largefiles.hgLfconvert">hgLfconvert</a></td>
75 <td>Public slot to convert the repository format of the current project.</td> 72 <td>Public slot to convert the repository format of the current project.</td>
76 </tr> 73 </tr>
77 </table> 74 </table>
75
78 <h3>Static Methods</h3> 76 <h3>Static Methods</h3>
79
80 <table> 77 <table>
81 <tr><td>None</td></tr> 78 <tr><td>None</td></tr>
82 </table> 79 </table>
83 80
81
84 <a NAME="Largefiles.__init__" ID="Largefiles.__init__"></a> 82 <a NAME="Largefiles.__init__" ID="Largefiles.__init__"></a>
85 <h4>Largefiles (Constructor)</h4> 83 <h4>Largefiles (Constructor)</h4>
86 <b>Largefiles</b>(<i>vcs</i>) 84 <b>Largefiles</b>(<i>vcs</i>)
87
88 <p> 85 <p>
89 Constructor 86 Constructor
90 </p> 87 </p>
88
91 <dl> 89 <dl>
92 90
93 <dt><i>vcs</i> (Hg)</dt> 91 <dt><i>vcs</i> (Hg)</dt>
94 <dd> 92 <dd>
95 reference to the Mercurial vcs object 93 reference to the Mercurial vcs object
96 </dd> 94 </dd>
97 </dl> 95 </dl>
98 <a NAME="Largefiles.hgAdd" ID="Largefiles.hgAdd"></a> 96 <a NAME="Largefiles.hgAdd" ID="Largefiles.hgAdd"></a>
99 <h4>Largefiles.hgAdd</h4> 97 <h4>Largefiles.hgAdd</h4>
100 <b>hgAdd</b>(<i>names, mode</i>) 98 <b>hgAdd</b>(<i>names, mode</i>)
101
102 <p> 99 <p>
103 Public method used to add a file to the Mercurial repository. 100 Public method used to add a file to the Mercurial repository.
104 </p> 101 </p>
102
105 <dl> 103 <dl>
106 104
107 <dt><i>names</i> (str or list of str)</dt> 105 <dt><i>names</i> (str or list of str)</dt>
108 <dd> 106 <dd>
109 file name(s) to be added 107 file name(s) to be added
114 </dd> 112 </dd>
115 </dl> 113 </dl>
116 <a NAME="Largefiles.hgLfPull" ID="Largefiles.hgLfPull"></a> 114 <a NAME="Largefiles.hgLfPull" ID="Largefiles.hgLfPull"></a>
117 <h4>Largefiles.hgLfPull</h4> 115 <h4>Largefiles.hgLfPull</h4>
118 <b>hgLfPull</b>(<i>revisions=None</i>) 116 <b>hgLfPull</b>(<i>revisions=None</i>)
119
120 <p> 117 <p>
121 Public method to pull missing large files into the local repository. 118 Public method to pull missing large files into the local repository.
122 </p> 119 </p>
120
123 <dl> 121 <dl>
124 122
125 <dt><i>revisions</i> (list of str)</dt> 123 <dt><i>revisions</i> (list of str)</dt>
126 <dd> 124 <dd>
127 list of revisions to pull 125 list of revisions to pull
128 </dd> 126 </dd>
129 </dl> 127 </dl>
130 <a NAME="Largefiles.hgLfVerify" ID="Largefiles.hgLfVerify"></a> 128 <a NAME="Largefiles.hgLfVerify" ID="Largefiles.hgLfVerify"></a>
131 <h4>Largefiles.hgLfVerify</h4> 129 <h4>Largefiles.hgLfVerify</h4>
132 <b>hgLfVerify</b>(<i>mode</i>) 130 <b>hgLfVerify</b>(<i>mode</i>)
133
134 <p> 131 <p>
135 Public method to verify large files integrity. 132 Public method to verify large files integrity.
136 </p> 133 </p>
134
137 <dl> 135 <dl>
138 136
139 <dt><i>mode</i> (str)</dt> 137 <dt><i>mode</i> (str)</dt>
140 <dd> 138 <dd>
141 verify mode (one of 'large', 'lfa' or 'lfc') 139 verify mode (one of 'large', 'lfa' or 'lfc')
142 </dd> 140 </dd>
143 </dl> 141 </dl>
144 <a NAME="Largefiles.hgLfconvert" ID="Largefiles.hgLfconvert"></a> 142 <a NAME="Largefiles.hgLfconvert" ID="Largefiles.hgLfconvert"></a>
145 <h4>Largefiles.hgLfconvert</h4> 143 <h4>Largefiles.hgLfconvert</h4>
146 <b>hgLfconvert</b>(<i>direction, projectFile</i>) 144 <b>hgLfconvert</b>(<i>direction, projectFile</i>)
147
148 <p> 145 <p>
149 Public slot to convert the repository format of the current project. 146 Public slot to convert the repository format of the current project.
150 </p> 147 </p>
148
151 <dl> 149 <dl>
152 150
153 <dt><i>direction</i> (str)</dt> 151 <dt><i>direction</i> (str)</dt>
154 <dd> 152 <dd>
155 direction of the conversion (one of 'largefiles' or 'normal') 153 direction of the conversion (one of 'largefiles' or 'normal')

eric ide

mercurial