Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/install-debugclients.html
eric7/Documentation/Source/install-debugclients.html
- branch
- eric7
- changeset 8312
- 800c432b34c8
- parent 7989
- a21d673a8f99
- child 8372
- e0227a7c850e
equal
deleted
inserted
replaced
| 8311:4e8b98454baa | 8312:800c432b34c8 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>install-debugclients</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>install-debugclients</h1> | |
| 24 | |
| 25 <p> | |
| 26 Installation script for the eric debug clients. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>currDir</td></tr><tr><td>distDir</td></tr><tr><td>doCleanup</td></tr><tr><td>doCompile</td></tr><tr><td>eric6SourceDir</td></tr><tr><td>installPackage</td></tr><tr><td>modDir</td></tr><tr><td>progName</td></tr><tr><td>pyModDir</td></tr><tr><td>sourceDir</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 <tr><td>None</td></tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 | |
| 40 <table> | |
| 41 | |
| 42 <tr> | |
| 43 <td><a href="#cleanUp">cleanUp</a></td> | |
| 44 <td>Uninstall the old eric debug client files.</td> | |
| 45 </tr> | |
| 46 <tr> | |
| 47 <td><a href="#cleanupSource">cleanupSource</a></td> | |
| 48 <td>Cleanup the sources directory to get rid of leftover files and directories.</td> | |
| 49 </tr> | |
| 50 <tr> | |
| 51 <td><a href="#copyTree">copyTree</a></td> | |
| 52 <td>Copy files of a directory tree.</td> | |
| 53 </tr> | |
| 54 <tr> | |
| 55 <td><a href="#exit">exit</a></td> | |
| 56 <td>Exit the install script.</td> | |
| 57 </tr> | |
| 58 <tr> | |
| 59 <td><a href="#initGlobals">initGlobals</a></td> | |
| 60 <td>Module function to set the values of globals that need more than a simple assignment.</td> | |
| 61 </tr> | |
| 62 <tr> | |
| 63 <td><a href="#installEricDebugClients">installEricDebugClients</a></td> | |
| 64 <td>Actually perform the installation steps.</td> | |
| 65 </tr> | |
| 66 <tr> | |
| 67 <td><a href="#main">main</a></td> | |
| 68 <td>The main function of the script.</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#shutilCopy">shutilCopy</a></td> | |
| 72 <td>Wrapper function around shutil.copy() to ensure the permissions.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#usage">usage</a></td> | |
| 76 <td>Display a usage message and exit.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <hr /> | |
| 80 <hr /> | |
| 81 <a NAME="cleanUp" ID="cleanUp"></a> | |
| 82 <h2>cleanUp</h2> | |
| 83 <b>cleanUp</b>(<i></i>) | |
| 84 | |
| 85 <p> | |
| 86 Uninstall the old eric debug client files. | |
| 87 </p> | |
| 88 <div align="right"><a href="#top">Up</a></div> | |
| 89 <hr /> | |
| 90 <hr /> | |
| 91 <a NAME="cleanupSource" ID="cleanupSource"></a> | |
| 92 <h2>cleanupSource</h2> | |
| 93 <b>cleanupSource</b>(<i>dirName</i>) | |
| 94 | |
| 95 <p> | |
| 96 Cleanup the sources directory to get rid of leftover files | |
| 97 and directories. | |
| 98 </p> | |
| 99 <dl> | |
| 100 | |
| 101 <dt><i>dirName</i></dt> | |
| 102 <dd> | |
| 103 name of the directory to prune (string) | |
| 104 </dd> | |
| 105 </dl> | |
| 106 <div align="right"><a href="#top">Up</a></div> | |
| 107 <hr /> | |
| 108 <hr /> | |
| 109 <a NAME="copyTree" ID="copyTree"></a> | |
| 110 <h2>copyTree</h2> | |
| 111 <b>copyTree</b>(<i>src, dst, filters, excludeDirs=None, excludePatterns=None</i>) | |
| 112 | |
| 113 <p> | |
| 114 Copy files of a directory tree. | |
| 115 </p> | |
| 116 <dl> | |
| 117 | |
| 118 <dt><i>src</i></dt> | |
| 119 <dd> | |
| 120 name of the source directory | |
| 121 </dd> | |
| 122 <dt><i>dst</i></dt> | |
| 123 <dd> | |
| 124 name of the destination directory | |
| 125 </dd> | |
| 126 <dt><i>filters</i></dt> | |
| 127 <dd> | |
| 128 list of filter pattern determining the files to be copied | |
| 129 </dd> | |
| 130 <dt><i>excludeDirs</i></dt> | |
| 131 <dd> | |
| 132 list of (sub)directories to exclude from copying | |
| 133 </dd> | |
| 134 <dt><i>excludePatterns</i></dt> | |
| 135 <dd> | |
| 136 list of filter pattern determining the files to | |
| 137 be skipped | |
| 138 </dd> | |
| 139 </dl> | |
| 140 <div align="right"><a href="#top">Up</a></div> | |
| 141 <hr /> | |
| 142 <hr /> | |
| 143 <a NAME="exit" ID="exit"></a> | |
| 144 <h2>exit</h2> | |
| 145 <b>exit</b>(<i>rcode=0</i>) | |
| 146 | |
| 147 <p> | |
| 148 Exit the install script. | |
| 149 </p> | |
| 150 <dl> | |
| 151 | |
| 152 <dt><i>rcode</i></dt> | |
| 153 <dd> | |
| 154 result code to report back (integer) | |
| 155 </dd> | |
| 156 </dl> | |
| 157 <div align="right"><a href="#top">Up</a></div> | |
| 158 <hr /> | |
| 159 <hr /> | |
| 160 <a NAME="initGlobals" ID="initGlobals"></a> | |
| 161 <h2>initGlobals</h2> | |
| 162 <b>initGlobals</b>(<i></i>) | |
| 163 | |
| 164 <p> | |
| 165 Module function to set the values of globals that need more than a | |
| 166 simple assignment. | |
| 167 </p> | |
| 168 <div align="right"><a href="#top">Up</a></div> | |
| 169 <hr /> | |
| 170 <hr /> | |
| 171 <a NAME="installEricDebugClients" ID="installEricDebugClients"></a> | |
| 172 <h2>installEricDebugClients</h2> | |
| 173 <b>installEricDebugClients</b>(<i></i>) | |
| 174 | |
| 175 <p> | |
| 176 Actually perform the installation steps. | |
| 177 </p> | |
| 178 <dl> | |
| 179 <dt>Return:</dt> | |
| 180 <dd> | |
| 181 result code (integer) | |
| 182 </dd> | |
| 183 </dl> | |
| 184 <div align="right"><a href="#top">Up</a></div> | |
| 185 <hr /> | |
| 186 <hr /> | |
| 187 <a NAME="main" ID="main"></a> | |
| 188 <h2>main</h2> | |
| 189 <b>main</b>(<i>argv</i>) | |
| 190 | |
| 191 <p> | |
| 192 The main function of the script. | |
| 193 </p> | |
| 194 <dl> | |
| 195 | |
| 196 <dt><i>argv</i></dt> | |
| 197 <dd> | |
| 198 the list of command line arguments. | |
| 199 </dd> | |
| 200 </dl> | |
| 201 <div align="right"><a href="#top">Up</a></div> | |
| 202 <hr /> | |
| 203 <hr /> | |
| 204 <a NAME="shutilCopy" ID="shutilCopy"></a> | |
| 205 <h2>shutilCopy</h2> | |
| 206 <b>shutilCopy</b>(<i>src, dst, perm=0o644</i>) | |
| 207 | |
| 208 <p> | |
| 209 Wrapper function around shutil.copy() to ensure the permissions. | |
| 210 </p> | |
| 211 <dl> | |
| 212 | |
| 213 <dt><i>src</i></dt> | |
| 214 <dd> | |
| 215 source file name (string) | |
| 216 </dd> | |
| 217 <dt><i>dst</i></dt> | |
| 218 <dd> | |
| 219 destination file name or directory name (string) | |
| 220 </dd> | |
| 221 <dt><i>perm</i></dt> | |
| 222 <dd> | |
| 223 permissions to be set (integer) | |
| 224 </dd> | |
| 225 </dl> | |
| 226 <div align="right"><a href="#top">Up</a></div> | |
| 227 <hr /> | |
| 228 <hr /> | |
| 229 <a NAME="usage" ID="usage"></a> | |
| 230 <h2>usage</h2> | |
| 231 <b>usage</b>(<i>rcode=2</i>) | |
| 232 | |
| 233 <p> | |
| 234 Display a usage message and exit. | |
| 235 </p> | |
| 236 <dl> | |
| 237 | |
| 238 <dt><i>rcode</i></dt> | |
| 239 <dd> | |
| 240 the return code passed back to the calling process. | |
| 241 </dd> | |
| 242 </dl> | |
| 243 <div align="right"><a href="#top">Up</a></div> | |
| 244 <hr /> | |
| 245 </body></html> |
