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
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7976
- a8a20f558176
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.PurgeExtension.purge</h1> | 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.PurgeExtension.purge</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the purge extension interface. | 26 Module implementing the purge 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="#Purge">Purge</a></td> | 38 <td><a href="#Purge">Purge</a></td> |
| 34 <td>Class implementing the purge extension interface.</td> | 39 <td>Class implementing the purge 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="Purge" ID="Purge"></a> | 49 <a NAME="Purge" ID="Purge"></a> |
| 43 <h2>Purge</h2> | 50 <h2>Purge</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the purge extension interface. | 53 Class implementing the purge 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="#Purge.__init__">Purge</a></td> | 72 <td><a href="#Purge.__init__">Purge</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#Purge.__getEntries">__getEntries</a></td> | 76 <td><a href="#Purge.__getEntries">__getEntries</a></td> |
| 64 <td>Private method to get a list of files/directories being purged.</td> | 77 <td>Private method to get a list of files/directories being purged.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#Purge.hgPurge">hgPurge</a></td> | 80 <td><a href="#Purge.hgPurge">hgPurge</a></td> |
| 67 <td>Public method to purge files and directories not tracked by Mercurial.</td> | 81 <td>Public method to purge files and directories not tracked by Mercurial.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#Purge.hgPurgeList">hgPurgeList</a></td> | 84 <td><a href="#Purge.hgPurgeList">hgPurgeList</a></td> |
| 70 <td>Public method to list files and directories not tracked by Mercurial.</td> | 85 <td>Public method to list files and directories not tracked by Mercurial.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#Purge.shutdown">shutdown</a></td> | 88 <td><a href="#Purge.shutdown">shutdown</a></td> |
| 73 <td>Public method used to shutdown the purge interface.</td> | 89 <td>Public method used to shutdown the purge interface.</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="Purge.__init__" ID="Purge.__init__"></a> | 98 <a NAME="Purge.__init__" ID="Purge.__init__"></a> |
| 81 <h4>Purge (Constructor)</h4> | 99 <h4>Purge (Constructor)</h4> |
| 82 <b>Purge</b>(<i>vcs</i>) | 100 <b>Purge</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="Purge.__getEntries" ID="Purge.__getEntries"></a> | 111 </dl> |
| 112 <a NAME="Purge.__getEntries" ID="Purge.__getEntries"></a> | |
| 91 <h4>Purge.__getEntries</h4> | 113 <h4>Purge.__getEntries</h4> |
| 92 <b>__getEntries</b>(<i>repodir, deleteAll</i>) | 114 <b>__getEntries</b>(<i>repodir, deleteAll</i>) |
| 115 | |
| 93 <p> | 116 <p> |
| 94 Private method to get a list of files/directories being purged. | 117 Private method to get a list of files/directories being purged. |
| 95 </p><dl> | 118 </p> |
| 119 <dl> | |
| 120 | |
| 96 <dt><i>repodir</i></dt> | 121 <dt><i>repodir</i></dt> |
| 97 <dd> | 122 <dd> |
| 98 directory name of the repository (string) | 123 directory name of the repository (string) |
| 99 </dd><dt><i>deleteAll</i></dt> | 124 </dd> |
| 125 <dt><i>deleteAll</i></dt> | |
| 100 <dd> | 126 <dd> |
| 101 flag indicating to delete all files including ignored | 127 flag indicating to delete all files including ignored |
| 102 ones (boolean) | 128 ones (boolean) |
| 103 </dd> | 129 </dd> |
| 104 </dl><dl> | 130 </dl> |
| 131 <dl> | |
| 105 <dt>Returns:</dt> | 132 <dt>Returns:</dt> |
| 106 <dd> | 133 <dd> |
| 107 name of the current patch (string) | 134 name of the current patch (string) |
| 108 </dd> | 135 </dd> |
| 109 </dl><a NAME="Purge.hgPurge" ID="Purge.hgPurge"></a> | 136 </dl> |
| 137 <a NAME="Purge.hgPurge" ID="Purge.hgPurge"></a> | |
| 110 <h4>Purge.hgPurge</h4> | 138 <h4>Purge.hgPurge</h4> |
| 111 <b>hgPurge</b>(<i>name, deleteAll=False</i>) | 139 <b>hgPurge</b>(<i>name, deleteAll=False</i>) |
| 140 | |
| 112 <p> | 141 <p> |
| 113 Public method to purge files and directories not tracked by Mercurial. | 142 Public method to purge files and directories not tracked by Mercurial. |
| 114 </p><dl> | 143 </p> |
| 144 <dl> | |
| 145 | |
| 115 <dt><i>name</i></dt> | 146 <dt><i>name</i></dt> |
| 116 <dd> | 147 <dd> |
| 117 file/directory name (string) | 148 file/directory name (string) |
| 118 </dd><dt><i>deleteAll</i></dt> | 149 </dd> |
| 150 <dt><i>deleteAll</i></dt> | |
| 119 <dd> | 151 <dd> |
| 120 flag indicating to delete all files including ignored | 152 flag indicating to delete all files including ignored |
| 121 ones (boolean) | 153 ones (boolean) |
| 122 </dd> | 154 </dd> |
| 123 </dl><a NAME="Purge.hgPurgeList" ID="Purge.hgPurgeList"></a> | 155 </dl> |
| 156 <a NAME="Purge.hgPurgeList" ID="Purge.hgPurgeList"></a> | |
| 124 <h4>Purge.hgPurgeList</h4> | 157 <h4>Purge.hgPurgeList</h4> |
| 125 <b>hgPurgeList</b>(<i>name, deleteAll=False</i>) | 158 <b>hgPurgeList</b>(<i>name, deleteAll=False</i>) |
| 159 | |
| 126 <p> | 160 <p> |
| 127 Public method to list files and directories not tracked by Mercurial. | 161 Public method to list files and directories not tracked by Mercurial. |
| 128 </p><dl> | 162 </p> |
| 163 <dl> | |
| 164 | |
| 129 <dt><i>name</i></dt> | 165 <dt><i>name</i></dt> |
| 130 <dd> | 166 <dd> |
| 131 file/directory name (string) | 167 file/directory name (string) |
| 132 </dd><dt><i>deleteAll</i></dt> | 168 </dd> |
| 169 <dt><i>deleteAll</i></dt> | |
| 133 <dd> | 170 <dd> |
| 134 flag indicating to list all files including ignored | 171 flag indicating to list all files including ignored |
| 135 ones (boolean) | 172 ones (boolean) |
| 136 </dd> | 173 </dd> |
| 137 </dl><a NAME="Purge.shutdown" ID="Purge.shutdown"></a> | 174 </dl> |
| 175 <a NAME="Purge.shutdown" ID="Purge.shutdown"></a> | |
| 138 <h4>Purge.shutdown</h4> | 176 <h4>Purge.shutdown</h4> |
| 139 <b>shutdown</b>(<i></i>) | 177 <b>shutdown</b>(<i></i>) |
| 178 | |
| 140 <p> | 179 <p> |
| 141 Public method used to shutdown the purge interface. | 180 Public method used to shutdown the purge interface. |
| 142 </p> | 181 </p> |
| 143 <div align="right"><a href="#top">Up</a></div> | 182 <div align="right"><a href="#top">Up</a></div> |
| 144 <hr /> | 183 <hr /> |
