Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10438
- 4cd7e5a8b3cf
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.LargefilesExtension.largefiles</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the largefiles extension interface. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#Largefiles">Largefiles</a></td> | |
| 25 <td>Class implementing the largefiles extension interface.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="Largefiles" ID="Largefiles"></a> | |
| 36 <h2>Largefiles</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the largefiles extension interface. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 HgExtension | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#Largefiles.__init__">Largefiles</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#Largefiles.hgAdd">hgAdd</a></td> | |
| 63 <td>Public method used to add a file to the Mercurial repository.</td> | |
| 64 </tr> | |
| 65 <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> | |
| 69 <tr> | |
| 70 <td><a href="#Largefiles.hgLfVerify">hgLfVerify</a></td> | |
| 71 <td>Public method to verify large files integrity.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#Largefiles.hgLfconvert">hgLfconvert</a></td> | |
| 75 <td>Public slot to convert the repository format of the current project.</td> | |
| 76 </tr> | |
| 77 </table> | |
| 78 <h3>Static Methods</h3> | |
| 79 | |
| 80 <table> | |
| 81 <tr><td>None</td></tr> | |
| 82 </table> | |
| 83 | |
| 84 <a NAME="Largefiles.__init__" ID="Largefiles.__init__"></a> | |
| 85 <h4>Largefiles (Constructor)</h4> | |
| 86 <b>Largefiles</b>(<i>vcs</i>) | |
| 87 | |
| 88 <p> | |
| 89 Constructor | |
| 90 </p> | |
| 91 <dl> | |
| 92 | |
| 93 <dt><i>vcs</i></dt> | |
| 94 <dd> | |
| 95 reference to the Mercurial vcs object | |
| 96 </dd> | |
| 97 </dl> | |
| 98 <a NAME="Largefiles.hgAdd" ID="Largefiles.hgAdd"></a> | |
| 99 <h4>Largefiles.hgAdd</h4> | |
| 100 <b>hgAdd</b>(<i>names, mode</i>) | |
| 101 | |
| 102 <p> | |
| 103 Public method used to add a file to the Mercurial repository. | |
| 104 </p> | |
| 105 <dl> | |
| 106 | |
| 107 <dt><i>names</i></dt> | |
| 108 <dd> | |
| 109 file name(s) to be added (string or list of string) | |
| 110 </dd> | |
| 111 <dt><i>mode</i></dt> | |
| 112 <dd> | |
| 113 add mode (string one of 'normal' or 'large') | |
| 114 </dd> | |
| 115 </dl> | |
| 116 <a NAME="Largefiles.hgLfPull" ID="Largefiles.hgLfPull"></a> | |
| 117 <h4>Largefiles.hgLfPull</h4> | |
| 118 <b>hgLfPull</b>(<i>revisions=None</i>) | |
| 119 | |
| 120 <p> | |
| 121 Public method to pull missing large files into the local repository. | |
| 122 </p> | |
| 123 <dl> | |
| 124 | |
| 125 <dt><i>revisions</i></dt> | |
| 126 <dd> | |
| 127 list of revisions to pull (list of string) | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <a NAME="Largefiles.hgLfVerify" ID="Largefiles.hgLfVerify"></a> | |
| 131 <h4>Largefiles.hgLfVerify</h4> | |
| 132 <b>hgLfVerify</b>(<i>mode</i>) | |
| 133 | |
| 134 <p> | |
| 135 Public method to verify large files integrity. | |
| 136 </p> | |
| 137 <dl> | |
| 138 | |
| 139 <dt><i>mode</i></dt> | |
| 140 <dd> | |
| 141 verify mode (string; one of 'large', 'lfa' or 'lfc') | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <a NAME="Largefiles.hgLfconvert" ID="Largefiles.hgLfconvert"></a> | |
| 145 <h4>Largefiles.hgLfconvert</h4> | |
| 146 <b>hgLfconvert</b>(<i>direction, projectFile</i>) | |
| 147 | |
| 148 <p> | |
| 149 Public slot to convert the repository format of the current project. | |
| 150 </p> | |
| 151 <dl> | |
| 152 | |
| 153 <dt><i>direction</i></dt> | |
| 154 <dd> | |
| 155 direction of the conversion (string, one of | |
| 156 'largefiles' or 'normal') | |
| 157 </dd> | |
| 158 <dt><i>projectFile</i></dt> | |
| 159 <dd> | |
| 160 file name of the current project file (string) | |
| 161 </dd> | |
| 162 </dl> | |
| 163 <dl> | |
| 164 | |
| 165 <dt>Raises <b>ValueError</b>:</dt> | |
| 166 <dd> | |
| 167 raised to indicate a bad value for the | |
| 168 'direction' parameter. | |
| 169 </dd> | |
| 170 </dl> | |
| 171 <div align="right"><a href="#top">Up</a></div> | |
| 172 <hr /> | |
| 173 </body></html> |
