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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7631
2c7ccb4484bf
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles</h1>
24
23 <p> 25 <p>
24 Module implementing the largefiles extension interface. 26 Module implementing the largefiles extension interface.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#Largefiles">Largefiles</a></td> 38 <td><a href="#Largefiles">Largefiles</a></td>
34 <td>Class implementing the largefiles extension interface.</td> 39 <td>Class implementing the largefiles extension interface.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="Largefiles" ID="Largefiles"></a> 49 <a NAME="Largefiles" ID="Largefiles"></a>
43 <h2>Largefiles</h2> 50 <h2>Largefiles</h2>
51
44 <p> 52 <p>
45 Class implementing the largefiles extension interface. 53 Class implementing the largefiles extension interface.
46 </p> 54 </p>
47 <h3>Derived from</h3> 55 <h3>Derived from</h3>
48 HgExtension 56 HgExtension
49 <h3>Class Attributes</h3> 57 <h3>Class Attributes</h3>
58
50 <table> 59 <table>
51 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
52 </table> 61 </table>
53 <h3>Class Methods</h3> 62 <h3>Class Methods</h3>
63
54 <table> 64 <table>
55 <tr><td>None</td></tr> 65 <tr><td>None</td></tr>
56 </table> 66 </table>
57 <h3>Methods</h3> 67 <h3>Methods</h3>
68
58 <table> 69 <table>
70
59 <tr> 71 <tr>
60 <td><a href="#Largefiles.__init__">Largefiles</a></td> 72 <td><a href="#Largefiles.__init__">Largefiles</a></td>
61 <td>Constructor</td> 73 <td>Constructor</td>
62 </tr><tr> 74 </tr>
75 <tr>
63 <td><a href="#Largefiles.hgAdd">hgAdd</a></td> 76 <td><a href="#Largefiles.hgAdd">hgAdd</a></td>
64 <td>Public method used to add a file to the Mercurial repository.</td> 77 <td>Public method used to add a file to the Mercurial repository.</td>
65 </tr><tr> 78 </tr>
79 <tr>
66 <td><a href="#Largefiles.hgLfPull">hgLfPull</a></td> 80 <td><a href="#Largefiles.hgLfPull">hgLfPull</a></td>
67 <td>Public method to pull missing large files into the local repository.</td> 81 <td>Public method to pull missing large files into the local repository.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#Largefiles.hgLfVerify">hgLfVerify</a></td> 84 <td><a href="#Largefiles.hgLfVerify">hgLfVerify</a></td>
70 <td>Public method to verify large files integrity.</td> 85 <td>Public method to verify large files integrity.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#Largefiles.hgLfconvert">hgLfconvert</a></td> 88 <td><a href="#Largefiles.hgLfconvert">hgLfconvert</a></td>
73 <td>Public slot to convert the repository format of the current project.</td> 89 <td>Public slot to convert the repository format of the current project.</td>
74 </tr> 90 </tr>
75 </table> 91 </table>
76 <h3>Static Methods</h3> 92 <h3>Static Methods</h3>
93
77 <table> 94 <table>
78 <tr><td>None</td></tr> 95 <tr><td>None</td></tr>
79 </table> 96 </table>
97
80 <a NAME="Largefiles.__init__" ID="Largefiles.__init__"></a> 98 <a NAME="Largefiles.__init__" ID="Largefiles.__init__"></a>
81 <h4>Largefiles (Constructor)</h4> 99 <h4>Largefiles (Constructor)</h4>
82 <b>Largefiles</b>(<i>vcs</i>) 100 <b>Largefiles</b>(<i>vcs</i>)
101
83 <p> 102 <p>
84 Constructor 103 Constructor
85 </p><dl> 104 </p>
105 <dl>
106
86 <dt><i>vcs</i></dt> 107 <dt><i>vcs</i></dt>
87 <dd> 108 <dd>
88 reference to the Mercurial vcs object 109 reference to the Mercurial vcs object
89 </dd> 110 </dd>
90 </dl><a NAME="Largefiles.hgAdd" ID="Largefiles.hgAdd"></a> 111 </dl>
112 <a NAME="Largefiles.hgAdd" ID="Largefiles.hgAdd"></a>
91 <h4>Largefiles.hgAdd</h4> 113 <h4>Largefiles.hgAdd</h4>
92 <b>hgAdd</b>(<i>names, mode</i>) 114 <b>hgAdd</b>(<i>names, mode</i>)
115
93 <p> 116 <p>
94 Public method used to add a file to the Mercurial repository. 117 Public method used to add a file to the Mercurial repository.
95 </p><dl> 118 </p>
119 <dl>
120
96 <dt><i>names</i></dt> 121 <dt><i>names</i></dt>
97 <dd> 122 <dd>
98 file name(s) to be added (string or list of string) 123 file name(s) to be added (string or list of string)
99 </dd><dt><i>mode</i></dt> 124 </dd>
125 <dt><i>mode</i></dt>
100 <dd> 126 <dd>
101 add mode (string one of 'normal' or 'large') 127 add mode (string one of 'normal' or 'large')
102 </dd> 128 </dd>
103 </dl><a NAME="Largefiles.hgLfPull" ID="Largefiles.hgLfPull"></a> 129 </dl>
130 <a NAME="Largefiles.hgLfPull" ID="Largefiles.hgLfPull"></a>
104 <h4>Largefiles.hgLfPull</h4> 131 <h4>Largefiles.hgLfPull</h4>
105 <b>hgLfPull</b>(<i>projectDir, revisions=None</i>) 132 <b>hgLfPull</b>(<i>projectDir, revisions=None</i>)
133
106 <p> 134 <p>
107 Public method to pull missing large files into the local repository. 135 Public method to pull missing large files into the local repository.
108 </p><dl> 136 </p>
137 <dl>
138
109 <dt><i>projectDir</i></dt> 139 <dt><i>projectDir</i></dt>
110 <dd> 140 <dd>
111 directory name of the project (string) 141 directory name of the project (string)
112 </dd><dt><i>revisions</i></dt> 142 </dd>
143 <dt><i>revisions</i></dt>
113 <dd> 144 <dd>
114 list of revisions to pull (list of string) 145 list of revisions to pull (list of string)
115 </dd> 146 </dd>
116 </dl><a NAME="Largefiles.hgLfVerify" ID="Largefiles.hgLfVerify"></a> 147 </dl>
148 <a NAME="Largefiles.hgLfVerify" ID="Largefiles.hgLfVerify"></a>
117 <h4>Largefiles.hgLfVerify</h4> 149 <h4>Largefiles.hgLfVerify</h4>
118 <b>hgLfVerify</b>(<i>projectDir, mode</i>) 150 <b>hgLfVerify</b>(<i>projectDir, mode</i>)
151
119 <p> 152 <p>
120 Public method to verify large files integrity. 153 Public method to verify large files integrity.
121 </p><dl> 154 </p>
155 <dl>
156
122 <dt><i>projectDir</i></dt> 157 <dt><i>projectDir</i></dt>
123 <dd> 158 <dd>
124 directory name of the project (string) 159 directory name of the project (string)
125 </dd><dt><i>mode</i></dt> 160 </dd>
161 <dt><i>mode</i></dt>
126 <dd> 162 <dd>
127 verify mode (string; one of 'large', 'lfa' or 'lfc') 163 verify mode (string; one of 'large', 'lfa' or 'lfc')
128 </dd> 164 </dd>
129 </dl><a NAME="Largefiles.hgLfconvert" ID="Largefiles.hgLfconvert"></a> 165 </dl>
166 <a NAME="Largefiles.hgLfconvert" ID="Largefiles.hgLfconvert"></a>
130 <h4>Largefiles.hgLfconvert</h4> 167 <h4>Largefiles.hgLfconvert</h4>
131 <b>hgLfconvert</b>(<i>direction, projectFile</i>) 168 <b>hgLfconvert</b>(<i>direction, projectFile</i>)
169
132 <p> 170 <p>
133 Public slot to convert the repository format of the current project. 171 Public slot to convert the repository format of the current project.
134 </p><dl> 172 </p>
173 <dl>
174
135 <dt><i>direction</i></dt> 175 <dt><i>direction</i></dt>
136 <dd> 176 <dd>
137 direction of the conversion (string, one of 177 direction of the conversion (string, one of
138 'largefiles' or 'normal') 178 'largefiles' or 'normal')
139 </dd><dt><i>projectFile</i></dt> 179 </dd>
180 <dt><i>projectFile</i></dt>
140 <dd> 181 <dd>
141 file name of the current project file (string) 182 file name of the current project file (string)
142 </dd> 183 </dd>
143 </dl> 184 </dl>
144 <div align="right"><a href="#top">Up</a></div> 185 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial