Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html
src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.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.PurgeExtension.purge</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.PurgeExtension.purge</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the purge 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="#Purge">Purge</a></td> | |
| 25 <td>Class implementing the purge 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="Purge" ID="Purge"></a> | |
| 36 <h2>Purge</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the purge 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="#Purge.__init__">Purge</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#Purge.__getEntries">__getEntries</a></td> | |
| 63 <td>Private method to get a list of files/directories being purged.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#Purge.hgPurge">hgPurge</a></td> | |
| 67 <td>Public method to purge files and directories not tracked by Mercurial.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#Purge.hgPurgeList">hgPurgeList</a></td> | |
| 71 <td>Public method to list files and directories not tracked by Mercurial.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#Purge.shutdown">shutdown</a></td> | |
| 75 <td>Public method used to shutdown the purge interface.</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="Purge.__init__" ID="Purge.__init__"></a> | |
| 85 <h4>Purge (Constructor)</h4> | |
| 86 <b>Purge</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="Purge.__getEntries" ID="Purge.__getEntries"></a> | |
| 99 <h4>Purge.__getEntries</h4> | |
| 100 <b>__getEntries</b>(<i>deleteAll</i>) | |
| 101 | |
| 102 <p> | |
| 103 Private method to get a list of files/directories being purged. | |
| 104 </p> | |
| 105 <dl> | |
| 106 | |
| 107 <dt><i>deleteAll</i> (bool)</dt> | |
| 108 <dd> | |
| 109 flag indicating to delete all files including ignored | |
| 110 ones | |
| 111 </dd> | |
| 112 </dl> | |
| 113 <dl> | |
| 114 <dt>Return:</dt> | |
| 115 <dd> | |
| 116 name of the current patch | |
| 117 </dd> | |
| 118 </dl> | |
| 119 <dl> | |
| 120 <dt>Return Type:</dt> | |
| 121 <dd> | |
| 122 str | |
| 123 </dd> | |
| 124 </dl> | |
| 125 <a NAME="Purge.hgPurge" ID="Purge.hgPurge"></a> | |
| 126 <h4>Purge.hgPurge</h4> | |
| 127 <b>hgPurge</b>(<i>deleteAll=False</i>) | |
| 128 | |
| 129 <p> | |
| 130 Public method to purge files and directories not tracked by Mercurial. | |
| 131 </p> | |
| 132 <dl> | |
| 133 | |
| 134 <dt><i>deleteAll</i> (bool)</dt> | |
| 135 <dd> | |
| 136 flag indicating to delete all files including ignored | |
| 137 ones | |
| 138 </dd> | |
| 139 </dl> | |
| 140 <a NAME="Purge.hgPurgeList" ID="Purge.hgPurgeList"></a> | |
| 141 <h4>Purge.hgPurgeList</h4> | |
| 142 <b>hgPurgeList</b>(<i>deleteAll=False</i>) | |
| 143 | |
| 144 <p> | |
| 145 Public method to list files and directories not tracked by Mercurial. | |
| 146 </p> | |
| 147 <dl> | |
| 148 | |
| 149 <dt><i>deleteAll</i></dt> | |
| 150 <dd> | |
| 151 flag indicating to list all files including ignored | |
| 152 ones (boolean) | |
| 153 </dd> | |
| 154 </dl> | |
| 155 <a NAME="Purge.shutdown" ID="Purge.shutdown"></a> | |
| 156 <h4>Purge.shutdown</h4> | |
| 157 <b>shutdown</b>(<i></i>) | |
| 158 | |
| 159 <p> | |
| 160 Public method used to shutdown the purge interface. | |
| 161 </p> | |
| 162 <div align="right"><a href="#top">Up</a></div> | |
| 163 <hr /> | |
| 164 </body></html> |
