Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html
eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge</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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the purge extension interface. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#Purge">Purge</a></td> | |
| 39 <td>Class implementing the purge extension interface.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="Purge" ID="Purge"></a> | |
| 50 <h2>Purge</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing the purge extension interface. | |
| 54 </p> | |
| 55 <h3>Derived from</h3> | |
| 56 HgExtension | |
| 57 <h3>Class Attributes</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Methods</h3> | |
| 68 | |
| 69 <table> | |
| 70 | |
| 71 <tr> | |
| 72 <td><a href="#Purge.__init__">Purge</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#Purge.__getEntries">__getEntries</a></td> | |
| 77 <td>Private method to get a list of files/directories being purged.</td> | |
| 78 </tr> | |
| 79 <tr> | |
| 80 <td><a href="#Purge.hgPurge">hgPurge</a></td> | |
| 81 <td>Public method to purge files and directories not tracked by Mercurial.</td> | |
| 82 </tr> | |
| 83 <tr> | |
| 84 <td><a href="#Purge.hgPurgeList">hgPurgeList</a></td> | |
| 85 <td>Public method to list files and directories not tracked by Mercurial.</td> | |
| 86 </tr> | |
| 87 <tr> | |
| 88 <td><a href="#Purge.shutdown">shutdown</a></td> | |
| 89 <td>Public method used to shutdown the purge interface.</td> | |
| 90 </tr> | |
| 91 </table> | |
| 92 <h3>Static Methods</h3> | |
| 93 | |
| 94 <table> | |
| 95 <tr><td>None</td></tr> | |
| 96 </table> | |
| 97 | |
| 98 <a NAME="Purge.__init__" ID="Purge.__init__"></a> | |
| 99 <h4>Purge (Constructor)</h4> | |
| 100 <b>Purge</b>(<i>vcs</i>) | |
| 101 | |
| 102 <p> | |
| 103 Constructor | |
| 104 </p> | |
| 105 <dl> | |
| 106 | |
| 107 <dt><i>vcs</i></dt> | |
| 108 <dd> | |
| 109 reference to the Mercurial vcs object | |
| 110 </dd> | |
| 111 </dl> | |
| 112 <a NAME="Purge.__getEntries" ID="Purge.__getEntries"></a> | |
| 113 <h4>Purge.__getEntries</h4> | |
| 114 <b>__getEntries</b>(<i>deleteAll</i>) | |
| 115 | |
| 116 <p> | |
| 117 Private method to get a list of files/directories being purged. | |
| 118 </p> | |
| 119 <dl> | |
| 120 | |
| 121 <dt><i>deleteAll</i> (bool)</dt> | |
| 122 <dd> | |
| 123 flag indicating to delete all files including ignored | |
| 124 ones | |
| 125 </dd> | |
| 126 </dl> | |
| 127 <dl> | |
| 128 <dt>Return:</dt> | |
| 129 <dd> | |
| 130 name of the current patch | |
| 131 </dd> | |
| 132 </dl> | |
| 133 <dl> | |
| 134 <dt>Return Type:</dt> | |
| 135 <dd> | |
| 136 str | |
| 137 </dd> | |
| 138 </dl> | |
| 139 <a NAME="Purge.hgPurge" ID="Purge.hgPurge"></a> | |
| 140 <h4>Purge.hgPurge</h4> | |
| 141 <b>hgPurge</b>(<i>deleteAll=False</i>) | |
| 142 | |
| 143 <p> | |
| 144 Public method to purge files and directories not tracked by Mercurial. | |
| 145 </p> | |
| 146 <dl> | |
| 147 | |
| 148 <dt><i>deleteAll</i> (bool)</dt> | |
| 149 <dd> | |
| 150 flag indicating to delete all files including ignored | |
| 151 ones | |
| 152 </dd> | |
| 153 </dl> | |
| 154 <a NAME="Purge.hgPurgeList" ID="Purge.hgPurgeList"></a> | |
| 155 <h4>Purge.hgPurgeList</h4> | |
| 156 <b>hgPurgeList</b>(<i>deleteAll=False</i>) | |
| 157 | |
| 158 <p> | |
| 159 Public method to list files and directories not tracked by Mercurial. | |
| 160 </p> | |
| 161 <dl> | |
| 162 | |
| 163 <dt><i>deleteAll</i></dt> | |
| 164 <dd> | |
| 165 flag indicating to list all files including ignored | |
| 166 ones (boolean) | |
| 167 </dd> | |
| 168 </dl> | |
| 169 <a NAME="Purge.shutdown" ID="Purge.shutdown"></a> | |
| 170 <h4>Purge.shutdown</h4> | |
| 171 <b>shutdown</b>(<i></i>) | |
| 172 | |
| 173 <p> | |
| 174 Public method used to shutdown the purge interface. | |
| 175 </p> | |
| 176 <div align="right"><a href="#top">Up</a></div> | |
| 177 <hr /> | |
| 178 </body></html> |
