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