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