Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FIX #590 fixed irritating windows documentation #592

Merged
merged 1 commit into from
Jul 22, 2015
Merged

FIX #590 fixed irritating windows documentation #592

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 16 additions & 15 deletions src/sphinx/formats/windows.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,45 +40,46 @@ Build
Required Settings
~~~~~~~~~~~~~~~~~

A rpm package needs some mandatory settings to be valid. Make sure
A windows package needs some mandatory settings to be valid. Make sure
you have these settings in your build:

.. code-block:: scala

rpmRelease := "1"

rpmVendor := "typesafe"

rpmUrl := Some("https://github.com/paulp/sbt-extras")

rpmLicense := Some("BSD")
// general package information (can be scoped to Windows)
maintainer := "Josh Suereth <[email protected]>"
packageSummary := "test-windows"
packageDescription := """Test Windows MSI."""

// wix build information
wixProductId := "ce07be71-510d-414a-92d4-dff47631848a"
wixProductUpgradeId := "4552fb0e-e257-4dbd-9ecb-dba9dbacf424"


1.0 or higher
~~~~~~~~~~~~~

Enables the rpm plugin
Enables the windows plugin

.. code-block:: scala

enablePlugins(RpmPlugin)
enablePlugins(WindowsPlugin)


0.8 or lower
~~~~~~~~~~~~

For this versions rpm packaging is automatically activated.
For this versions windows packaging is automatically activated.
See the :doc:`Getting Started </gettingstarted>` page for information
on how to enable sbt native packager.

Configuration
-------------

Settings and Tasks inherited from parent plugins can be scoped with ``Rpm``.
Settings and Tasks inherited from parent plugins can be scoped with ``Universal``.

.. code-block:: scala

linuxPackageMappings in Rpm := linuxPackageMappings.value
mappings in Windows := (mappings in Universal).value

Now, let's look at the full set of windows settings.

Expand Down Expand Up @@ -155,8 +156,8 @@ Customize
Feature configuration
~~~~~~~~~~~~~~~~~~~~~

The abstraction over wix allows you to configure "features" that users may optionally install. These feature are higher level things, like a set of files or menu links.
The currently supported components of features are:
The abstraction over wix allows you to configure "features" that users may optionally install. These feature are higher level things,
like a set of files or menu links. The currently supported components of features are:

1. Files (``ComponentFile``)
2. Path Configuration (``AddDirectoryToPath``)
Expand Down