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