Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge</h1> | |
| 23 <p> | |
| 24 Module implementing the purge extension interface. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#Purge">Purge</a></td> | |
| 34 <td>Class implementing the purge extension interface.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="Purge" ID="Purge"></a> | |
| 43 <h2>Purge</h2> | |
| 44 <p> | |
| 45 Class implementing the purge extension interface. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 HgExtension | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#Purge.__init__">Purge</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#Purge.__getEntries">__getEntries</a></td> | |
| 64 <td>Private method to get a list of files/directories being purged.</td> | |
| 65 </tr><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><tr> | |
| 69 <td><a href="#Purge.hgPurgeList">hgPurgeList</a></td> | |
| 70 <td>Public method to list files and directories not tracked by Mercurial.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#Purge.shutdown">shutdown</a></td> | |
| 73 <td>Public method used to shutdown the purge interface.</td> | |
| 74 </tr> | |
| 75 </table> | |
| 76 <h3>Static Methods</h3> | |
| 77 <table> | |
| 78 <tr><td>None</td></tr> | |
| 79 </table> | |
| 80 <a NAME="Purge.__init__" ID="Purge.__init__"></a> | |
| 81 <h4>Purge (Constructor)</h4> | |
| 82 <b>Purge</b>(<i>vcs</i>) | |
| 83 <p> | |
| 84 Constructor | |
| 85 </p><dl> | |
| 86 <dt><i>vcs</i></dt> | |
| 87 <dd> | |
| 88 reference to the Mercurial vcs object | |
| 89 </dd> | |
| 90 </dl><a NAME="Purge.__getEntries" ID="Purge.__getEntries"></a> | |
| 91 <h4>Purge.__getEntries</h4> | |
| 92 <b>__getEntries</b>(<i>repodir, deleteAll</i>) | |
| 93 <p> | |
| 94 Private method to get a list of files/directories being purged. | |
| 95 </p><dl> | |
| 96 <dt><i>repodir</i></dt> | |
| 97 <dd> | |
| 98 directory name of the repository (string) | |
| 99 </dd><dt><i>deleteAll</i></dt> | |
| 100 <dd> | |
| 101 flag indicating to delete all files including ignored | |
| 102 ones (boolean) | |
| 103 </dd> | |
| 104 </dl><dl> | |
| 105 <dt>Returns:</dt> | |
| 106 <dd> | |
| 107 name of the current patch (string) | |
| 108 </dd> | |
| 109 </dl><a NAME="Purge.hgPurge" ID="Purge.hgPurge"></a> | |
| 110 <h4>Purge.hgPurge</h4> | |
| 111 <b>hgPurge</b>(<i>name, deleteAll=False</i>) | |
| 112 <p> | |
| 113 Public method to purge files and directories not tracked by Mercurial. | |
| 114 </p><dl> | |
| 115 <dt><i>name</i></dt> | |
| 116 <dd> | |
| 117 file/directory name (string) | |
| 118 </dd><dt><i>deleteAll</i></dt> | |
| 119 <dd> | |
| 120 flag indicating to delete all files including ignored | |
| 121 ones (boolean) | |
| 122 </dd> | |
| 123 </dl><a NAME="Purge.hgPurgeList" ID="Purge.hgPurgeList"></a> | |
| 124 <h4>Purge.hgPurgeList</h4> | |
| 125 <b>hgPurgeList</b>(<i>name, deleteAll=False</i>) | |
| 126 <p> | |
| 127 Public method to list files and directories not tracked by Mercurial. | |
| 128 </p><dl> | |
| 129 <dt><i>name</i></dt> | |
| 130 <dd> | |
| 131 file/directory name (string) | |
| 132 </dd><dt><i>deleteAll</i></dt> | |
| 133 <dd> | |
| 134 flag indicating to list all files including ignored | |
| 135 ones (boolean) | |
| 136 </dd> | |
| 137 </dl><a NAME="Purge.shutdown" ID="Purge.shutdown"></a> | |
| 138 <h4>Purge.shutdown</h4> | |
| 139 <b>shutdown</b>(<i></i>) | |
| 140 <p> | |
| 141 Public method used to shutdown the purge interface. | |
| 142 </p> | |
| 143 <div align="right"><a href="#top">Up</a></div> | |
| 144 <hr /> | |
| 145 </body></html> |
