Commits

Anthony Tuininga committed 49ff294

Added documentation for the shortcutName and shortcutDir parameters to the
Executable class.

  • Participants
  • Parent commits deb1744

Comments (0)

Files changed (2)

doc/cx_Freeze.html

 <td>list of names of packages to include, including all
 of the package's submodules</td>
 </tr>
-<tr><td>namespacePackages</td>
-<td>list of packages to be treated as namespace
-packages (path is extended using pkgutil)</td>
-</tr>
 <tr><td>replacePaths</td>
 <td>list of 2-tuples containing search values and
 replacement values for paths of modules that are
 executable itself on Windows or placed in the
 target directory for other platforms</td>
 </tr>
+<tr><td>namespacePackages</td>
+<td>list of packages to be treated as namespace
+packages (path is extended using pkgutil)</td>
+</tr>
+<tr><td>shortcutName</td>
+<td>the name to give a shortcut for the executable when
+included in an MSI package</td>
+</tr>
+<tr><td>shortcutDir</td>
+<td>the directory in which to place the shortcut when
+being installed by an MSI package; see the MSI
+Shortcut table documentation for more information
+on what values can be placed here.</td>
+</tr>
 </tbody>
 </table>
 </div>

doc/cx_Freeze.rst

 | packages              | list of names of packages to include, including all |
 |                       | of the package's submodules                         |
 +-----------------------+-----------------------------------------------------+
-| namespacePackages     | list of packages to be treated as namespace         |
-|                       | packages (path is extended using pkgutil)           |
-+-----------------------+-----------------------------------------------------+
 | replacePaths          | list of 2-tuples containing search values and       |
 |                       | replacement values for paths of modules that are    |
 |                       | included; a search value of "*" will cause all      |
 |                       | executable itself on Windows or placed in the       |
 |                       | target directory for other platforms                |
 +-----------------------+-----------------------------------------------------+
+| namespacePackages     | list of packages to be treated as namespace         |
+|                       | packages (path is extended using pkgutil)           |
++-----------------------+-----------------------------------------------------+
+| shortcutName          | the name to give a shortcut for the executable when |
+|                       | included in an MSI package                          |
++-----------------------+-----------------------------------------------------+
+| shortcutDir           | the directory in which to place the shortcut when   |
+|                       | being installed by an MSI package; see the MSI      |
+|                       | Shortcut table documentation for more information   |
+|                       | on what values can be placed here.                  |
++-----------------------+-----------------------------------------------------+